chrome.audio

Descrição

A API chrome.audio é fornecida para permitir que os usuários recebam informações e controlem os dispositivos de áudio conectados ao sistema. No momento, essa API só está disponível no modo quiosque no ChromeOS.

Permissões

audio

Disponibilidade

Chrome 59 ou superior Somente ChromeOS

Tipos

AudioDeviceInfo

Propriedades

  • deviceName

    string

    Nome do dispositivo:

  • deviceType

    DeviceType

    Tipo de dispositivo.

  • displayName

    string

    O nome fácil de usar (por exemplo, "Microfone USB").

  • id

    string

    O identificador exclusivo do dispositivo de áudio.

  • isActive

    booleano

    Verdadeiro se este for o dispositivo ativo no momento.

  • level

    number

    O nível de som do dispositivo, volume para saída e ganho para entrada.

  • stableDeviceId

    string opcional

    A string de ID do dispositivo estável/mantida quando disponível.

  • streamType

    StreamType

    Tipo de stream associado a este dispositivo.

DeviceFilter

Propriedades

  • isActive

    booleano opcional

    Se definido, apenas os dispositivos de áudio com estado ativo correspondente a esse valor vão satisfazer o filtro.

  • streamTypes

    StreamType[] opcional

    Se definido, somente os dispositivos de áudio com um tipo de stream incluído nessa lista atenderão ao filtro.

DeviceIdLists

Propriedades

  • entrada

    string[] opcional

    Lista de dispositivos de entrada especificados pelo ID.

    Para indicar que os dispositivos de entrada não serão afetados, deixe essa propriedade sem definição.

  • output

    string[] opcional

    Lista de dispositivos de saída especificados pelo ID.

    Para indicar que os dispositivos de saída não serão afetados, deixe essa propriedade sem definição.

DeviceProperties

Propriedades

  • level

    número opcional

    Nível de som desejado pelo dispositivo de áudio. O padrão é o nível de som atual do dispositivo.

    Se usado com dispositivo de entrada de áudio, representa o ganho do dispositivo de áudio.

    Se usado com dispositivo de saída de áudio, representa o volume do dispositivo de áudio.

DeviceType

Tipos de dispositivos de áudio disponíveis.

Enumeração

"TELEFONE"

"MIC"

"USB"

"BLUETOOTH"

HDMI

"INTERNAL_SPEAKER"

INTERNAL_MIC

FRONT_MIC:

"REAR_MIC"

"KEYBOARD_MIC"

"HOTPalavra"

"LINEOUT"

"POST_MIX_LOOPBACK"

"POST_DSP_LOOPBACK"

"ALSA_LOOPBACK"

"OTHER"

LevelChangedEvent

Propriedades

  • deviceId

    string

    ID do dispositivo em que o nível do som mudou.

  • level

    number

    O novo nível de som do dispositivo.

MuteChangedEvent

Propriedades

  • isMuted

    booleano

    Se o som da transmissão está ou não desativado.

  • streamType

    StreamType

    O tipo de stream em que o valor de silenciamento mudou. O valor atualizado do silenciamento é válido para todos os dispositivos com esse tipo de transmissão.

StreamType

Tipo de streaming que um dispositivo de áudio oferece.

Enumeração

"ENTRADA"

"SAÍDA"

Métodos

getDevices()

Promessa 
chrome.audio.getDevices(
  filter?: DeviceFilter,
  callback?: function,
)

Recebe uma lista de dispositivos de áudio filtrados com base em filter.

Parâmetros

  • filtro

    DeviceFilter opcional

    Propriedades de dispositivo pelas quais filtrar a lista de dispositivos de áudio retornados. Se o filtro não for definido ou for definido como {}, a lista de dispositivos retornados vai conter todos os dispositivos de áudio disponíveis.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (devices: AudioDeviceInfo[]) => void

Retorna

  • Promise<AudioDeviceInfo[]>

    Chrome 116 ou versões mais recentes

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

getMute()

Promessa 
chrome.audio.getMute(
  streamType: StreamType,
  callback?: function,
)

Recebe o estado silenciado do sistema para o tipo de stream especificado.

Parâmetros

  • streamType

    StreamType

    Tipo de stream em que o estado mudo deve ser buscado.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (value: boolean) => void

    • valor

      booleano

Retorna

  • Promise<boolean>

    Chrome 116 ou versões mais recentes

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

setActiveDevices()

Promessa 
chrome.audio.setActiveDevices(
  ids: DeviceIdLists,
  callback?: function,
)

Define listas de dispositivos de entrada e/ou saída ativos.

Parâmetros

  • Especifica os IDs dos dispositivos que precisam estar ativos. Se a lista de entrada ou saída não for definida, os dispositivos dessa categoria não serão afetados.

    É um erro ao passar um ID de dispositivo inexistente.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promessa<void>

    Chrome 116 ou versões mais recentes

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

setMute()

Promessa 
chrome.audio.setMute(
  streamType: StreamType,
  isMuted: boolean,
  callback?: function,
)

Define o estado silenciado para um tipo de stream. O estado silenciado será aplicado a todos os dispositivos de áudio com o tipo de stream de áudio especificado.

Parâmetros

  • streamType

    StreamType

    Tipo de stream em que o estado de silenciamento precisa ser definido.

  • isMuted

    booleano

    Novo valor de silenciamento.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promessa<void>

    Chrome 116 ou versões mais recentes

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

setProperties()

Promessa 
chrome.audio.setProperties(
  id: string,
  properties: DeviceProperties,
  callback?: function,
)

Define as propriedades do dispositivo de entrada ou saída.

Parâmetros

  • id

    string

  • properties

    DeviceProperties (link em inglês)

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promessa<void>

    Chrome 116 ou versões mais recentes

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

Eventos

onDeviceListChanged

chrome.audio.onDeviceListChanged.addListener(
  callback: function,
)

Disparado quando os dispositivos de áudio mudam, novos dispositivos são adicionados ou dispositivos existentes são removidos.

Parâmetros

onLevelChanged

chrome.audio.onLevelChanged.addListener(
  callback: function,
)

Disparado quando o nível do som é alterado em um dispositivo de áudio ativo.

Parâmetros

onMuteChanged

chrome.audio.onMuteChanged.addListener(
  callback: function,
)

Disparado quando o estado mudo da entrada ou saída de áudio muda. O estado de silenciamento é válido para todo o sistema, e o novo valor se aplica a todos os dispositivos de áudio com o tipo de stream especificado.

Parâmetros