chrome.audio

refresh date: 2026-09-25 robots: noindex

Descrição

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

Permissões

audio

Disponibilidade

Chrome 59 ou mais recente 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

    número

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

  • stableDeviceId

    string opcional

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

  • streamType

    StreamType

    Tipo de stream associado a este dispositivo.

DeviceFilter

Propriedades

  • isActive

    booleano opcional

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

  • streamTypes

    StreamType[] opcional

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

DeviceIdLists

Propriedades

  • entrada

    string[] opcional

    Lista de dispositivos de entrada especificados pelo ID.

    Para indicar que os dispositivos de entrada não devem ser 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 devem ser afetados, deixe essa propriedade sem definição.

DeviceProperties

Propriedades

  • level

    número optional

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

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

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

DeviceType

Tipos de dispositivos de áudio disponíveis.

Enumeração

"HEADPHONE"

"MIC"

"USB"

"BLUETOOTH"

"HDMI"

"INTERNAL_SPEAKER"

"INTERNAL_MIC"

"FRONT_MIC"

"REAR_MIC"

"KEYBOARD_MIC"

"HOTWORD"

"LINEOUT"

"POST_MIX_LOOPBACK"

"POST_DSP_LOOPBACK"

"ALSA_LOOPBACK"

"OTHER"

LevelChangedEvent

Propriedades

  • deviceId

    string

    ID do dispositivo cujo nível de som mudou.

  • level

    número

    O novo nível de som do dispositivo.

MuteChangedEvent

Propriedades

  • isMuted

    booleano

    Indica se o stream está silenciado ou não.

  • streamType

    StreamType

    O tipo de stream em que o valor de silenciamento mudou. O valor de silenciamento atualizado se aplica a todos os dispositivos com esse tipo de stream.

StreamType

Tipo de stream que um dispositivo de áudio oferece.

Enumeração

"INPUT"

"OUTPUT"

Métodos

getDevices()

Promessa 
chrome.audio.getDevices(
  filter?: DeviceFilter,
  callback?: function,
): Promise<AudioDeviceInfo[]>

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

Parâmetros

  • filtro

    DeviceFilter opcional

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

  • callback

    função optional

    O parâmetro callback é semelhante a: 

    (devices: AudioDeviceInfo[]) => void

Retorna

  • Promise<AudioDeviceInfo[]>

    Chrome 116+

    Informa a lista solicitada de dispositivos de áudio.

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getMute()

Promessa 
chrome.audio.getMute(
  streamType: StreamType,
  callback?: function,
): Promise<boolean>

Recebe o estado de silenciamento de todo o sistema para o tipo de stream especificado.

Parâmetros

  • streamType

    StreamType

    Tipo de stream para o qual o estado de silenciamento precisa ser buscado.

  • callback

    função optional

    O parâmetro callback é semelhante a: 

    (value: boolean) => void

    • valor

      booleano

Retorna

  • Promise<boolean>

    Chrome 116+

    Promessa que é resolvida com um booleano que indica se o som está desativado ou não para o tipo de stream especificado.

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

setActiveDevices()

Promessa 
chrome.audio.setActiveDevices(
  ids: DeviceIdLists,
  callback?: function,
): Promise<void>

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

Parâmetros

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

    É um erro transmitir um ID de dispositivo inexistente.

  • callback

    função optional

    O parâmetro callback é semelhante a: 

    () => void

Retorna

  • Promessa<void>

    Chrome 116+

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

setMute()

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

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

Parâmetros

  • streamType

    StreamType

    Tipo de stream para o qual o estado de silenciamento precisa ser definido.

  • isMuted

    booleano

    Novo valor de silenciamento.

  • callback

    função optional

    O parâmetro callback é semelhante a: 

    () => void

Retorna

  • Promessa<void>

    Chrome 116+

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

setProperties()

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

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

Parâmetros

  • ID

    string

  • propriedades

    DeviceProperties

  • callback

    função optional

    O parâmetro callback é semelhante a: 

    () => void

Retorna

  • Promessa<void>

    Chrome 116+

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

Eventos

onDeviceListChanged

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

Acionado quando os dispositivos de áudio mudam, seja pela adição de novos dispositivos ou pela remoção de dispositivos atuais.

Parâmetros

onLevelChanged

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

Acionado quando o nível de som muda para um dispositivo de áudio ativo.

Parâmetros

onMuteChanged

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

Acionado quando o estado de silenciamento 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