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 para o ChromeOS.

Permissões

audio

Disponibilidade

Chrome 59+ Apenas 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

    boolean

    Verdadeiro se este for o dispositivo ativo no momento.

  • level

    number

    Nível de som do dispositivo, volume para saída e 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, apenas os dispositivos de áudio com estado ativo correspondente a esse valor vão satisfazer o filtro.

  • streamTypes

    StreamType[] opcional

    Se definido, apenas os dispositivos de áudio cujo tipo de stream estiver 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.

  • saída

    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

    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.

Tipo enumerado

"HEADPHONE"

"MIC"

"USB"

"BLUETOOTH"

"INTERNAL_SPEAKER"

"INTERNAL_MIC"

"FRONT_MIC"

"REAR_MIC"

"KEYBOARD_MIC"

"LINEOUT"

"POST_MIX_LOOPBACK"

"POST_DSP_LOOPBACK"

"ALSA_LOOPBACK"

LevelChangedEvent

Propriedades

  • deviceId

    string

    ID do dispositivo cujo nível de som mudou.

  • level

    number

    O novo nível de som do dispositivo.

MuteChangedEvent

Propriedades

  • isMuted

    boolean

    Se o som do stream foi desativado.

  • streamType

    StreamType

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

StreamType

É o tipo de transmissão que um dispositivo de áudio oferece.

Tipo enumerado

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

  • Função filter

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

    Promessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.

getMute()

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

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

Parâmetros

  • streamType

    StreamType

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

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    (value: boolean)=>void

    • valor

      boolean

Retorna

  • Promise<boolean>

    Chrome 116 ou mais recente

    Promessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.

setActiveDevices()

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

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

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 transmitir um ID de dispositivo inexistente.

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    ()=>void

Retorna

  • Promise<void>

    Chrome 116 ou mais recente

    Promessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.

setMute()

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

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

Parâmetros

  • streamType

    StreamType

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

  • isMuted

    boolean

    Novo valor silenciado.

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    ()=>void

Retorna

  • Promise<void>

    Chrome 116 ou mais recente

    Promessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.

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

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    ()=>void

Retorna

  • Promise<void>

    Chrome 116 ou mais recente

    Promessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.

Eventos

onDeviceListChanged

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

Disparado quando os dispositivos de áudio mudam e 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 de som muda de 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 é alterado. Observe que o estado mudo vale para todo o sistema, e o novo valor se aplica a todos os dispositivos de áudio com o tipo de stream especificado.

Parâmetros