chrome.audio

refresh date: 2026-09-25 robots: noindex

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 está disponível apenas no modo quiosque para ChromeOS.

Permissões

audio

Disponibilidade

Chrome 59 ou mais recente Somente no 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 atual.

  • level

    número

    O nível de som do dispositivo, o volume para saída e o ganho para 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 dispositivos de áudio cujo estado ativo corresponda a esse valor vão satisfazer o filtro.

  • streamTypes

    StreamType[] opcional

    Se definido, somente os dispositivos de áudio cujo tipo de stream estiver incluído nesta 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 indefinida.

  • 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 indefinida.

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"

"OUTRO"

LevelChangedEvent

Propriedades

  • deviceId

    string

    ID do dispositivo cujo nível de som foi alterado.

  • 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 mudo atualizado é aplicado a todos os dispositivos com esse tipo de stream.

StreamType

Tipo de stream fornecido por um dispositivo de áudio.

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 estiver definido ou estiver definido como {}, a lista de dispositivos retornada vai conter todos os dispositivos de áudio disponíveis.

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    (devices: AudioDeviceInfo[]) => void

Retorna

  • Promise<AudioDeviceInfo[]>

    Chrome 116 ou mais recente

    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 mudo em todo o sistema para o tipo de stream especificado.

Parâmetros

  • streamType

    StreamType

    Tipo de stream para o qual o estado de mudo deve ser buscado.

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    (value: boolean) => void

    • valor

      booleano

Retorna

  • Promise<boolean>

    Chrome 116 ou mais recente

    Promessa que é resolvida com um booleano indicando se o silenciamento está definido 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 precisam 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 que não existe.

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promessa<void>

    Chrome 116 ou mais recente

    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 mudo para um tipo de stream. O estado de mudo 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 mudo deve ser definido.

  • isMuted

    booleano

    Novo valor de silenciamento.

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promessa<void>

    Chrome 116 ou mais recente

    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 tem esta aparência: 

    () => void

Retorna

  • Promessa<void>

    Chrome 116 ou mais recente

    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,
)

Disparado quando os dispositivos de áudio mudam, seja com a adição de novos dispositivos ou a remoção dos atuais.

Parâmetros

onLevelChanged

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

Acionada quando o nível de som muda em um dispositivo de áudio ativo.

Parâmetros

onMuteChanged

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

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

Parâmetros