chrome.audio

Descrizione

L'API chrome.audio viene fornita per consentire agli utenti di ottenere informazioni e controllare i dispositivi audio collegati al sistema. Questa API è attualmente disponibile solo in modalità kiosk per ChromeOS.

Autorizzazioni

audio

Disponibilità

Chrome 59 e versioni successive Solo ChromeOS

Tipi

AudioDeviceInfo

Proprietà

  • deviceName

    stringa

    Nome del dispositivo.

  • deviceType

    DeviceType

    Tipo di dispositivo.

  • displayName

    stringa

    Il nome facile da ricordare (ad es. "Microfono USB").

  • id

    stringa

    L'identificatore univoco del dispositivo audio.

  • isActive

    booleano

    True se si tratta del dispositivo attivo corrente.

  • livello

    numero

    Il livello del suono del dispositivo, il volume per l'uscita, il guadagno per l'ingresso.

  • stableDeviceId

    stringa facoltativa

    La stringa dell'ID dispositivo stabile/persistente, se disponibile.

  • streamType

    StreamType

    Tipo di stream associato a questo dispositivo.

DeviceFilter

Proprietà

  • isActive

    booleano facoltativo

    Se impostato, solo i dispositivi audio il cui stato attivo corrisponde a questo valore soddisferanno il filtro.

  • streamTypes

    StreamType[] facoltativo

    Se impostato, solo i dispositivi audio il cui tipo di stream è incluso in questo elenco soddisferanno il filtro.

DeviceIdLists

Proprietà

  • input

    stringa[] facoltativo

    Elenco di dispositivi di input specificati dal relativo ID.

    Per indicare che i dispositivi di input non devono essere interessati, lascia questa proprietà non impostata.

  • output

    stringa[] facoltativo

    Elenco di dispositivi di output specificati dal relativo ID.

    Per indicare che i dispositivi di output non devono essere interessati, lascia questa proprietà non impostata.

DeviceProperties

Proprietà

  • livello

    number facoltativo

    Il livello di suono desiderato del dispositivo audio. Per impostazione predefinita, viene utilizzato il livello audio corrente del dispositivo.

    Se utilizzato con un dispositivo di input audio, rappresenta il guadagno del dispositivo audio.

    Se utilizzato con un dispositivo di uscita audio, rappresenta il volume del dispositivo.

DeviceType

Tipi di dispositivi audio disponibili.

Enum

"HEADPHONE"

"MIC"

"USB"

"BLUETOOTH"

"HDMI"

"ALTOPARLANTE_INTERNO"

"INTERNAL_MIC"

"FRONT_MIC"

"REAR_MIC"

"KEYBOARD_MIC"

"HOTWORD"

"LINEOUT"

"POST_MIX_LOOPBACK"

"POST_DSP_LOOPBACK"

"ALSA_LOOPBACK"

"ALTRO"

LevelChangedEvent

Proprietà

  • deviceId

    stringa

    ID del dispositivo il cui livello di suono è cambiato.

  • livello

    numero

    Il nuovo livello di suono del dispositivo.

MuteChangedEvent

Proprietà

  • isMuted

    booleano

    Indica se l'audio dello stream è disattivato o meno.

  • streamType

    StreamType

    Il tipo di stream per cui è stato modificato il valore di disattivazione audio. Il valore di disattivazione dell'audio aggiornato si applica a tutti i dispositivi con questo tipo di stream.

StreamType

Tipo di stream fornito da un dispositivo audio.

Enum

"INPUT"

"OUTPUT"

Metodi

getDevices()

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

Recupera un elenco di dispositivi audio filtrati in base a filter.

Parametri

  • filtro

    DeviceFilter facoltativo

    Proprietà dei dispositivi in base alle quali filtrare l'elenco dei dispositivi audio restituiti. Se il filtro non è impostato o è impostato su {}, l'elenco dei dispositivi restituiti conterrà tutti i dispositivi audio disponibili.

  • callback

    function facoltativa

    Il parametro callback ha il seguente aspetto: 

    (devices: AudioDeviceInfo[]) => void

Resi

  • Promise<AudioDeviceInfo[]>

    Chrome 116 e versioni successive

    Le promesse sono supportate in Manifest V3 e versioni successive, ma i callback vengono forniti per la compatibilità con le versioni precedenti. Non puoi utilizzarli entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo passato al callback.

getMute()

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

Recupera lo stato di disattivazione dell'audio a livello di sistema per il tipo di stream specificato.

Parametri

  • streamType

    StreamType

    Tipo di stream per il quale deve essere recuperato lo stato di disattivazione dell'audio.

  • callback

    function facoltativa

    Il parametro callback ha il seguente aspetto: 

    (value: boolean) => void

    • valore

      booleano

Resi

  • Promise<boolean>

    Chrome 116 e versioni successive

    Le promesse sono supportate in Manifest V3 e versioni successive, ma i callback vengono forniti per la compatibilità con le versioni precedenti. Non puoi utilizzarli entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo passato al callback.

setActiveDevices()

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

Imposta elenchi di dispositivi di input e/o output attivi.

Parametri

  • Specifica gli ID dei dispositivi che devono essere attivi. Se l'elenco di input o di output non è impostato, i dispositivi di quella categoria non sono interessati.

    È un errore passare un ID dispositivo inesistente.

  • callback

    function facoltativa

    Il parametro callback ha il seguente aspetto: 

    () => void

Resi

  • Promise<void>

    Chrome 116 e versioni successive

    Le promesse sono supportate in Manifest V3 e versioni successive, ma i callback vengono forniti per la compatibilità con le versioni precedenti. Non puoi utilizzarli entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo passato al callback.

setMute()

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

Imposta lo stato di disattivazione dell'audio per un tipo di stream. Lo stato di disattivazione dell'audio verrà applicato a tutti i dispositivi audio con il tipo di stream audio specificato.

Parametri

  • streamType

    StreamType

    Tipo di stream per il quale deve essere impostato lo stato di disattivazione dell'audio.

  • isMuted

    booleano

    Nuovo valore di disattivazione audio.

  • callback

    function facoltativa

    Il parametro callback ha il seguente aspetto: 

    () => void

Resi

  • Promise<void>

    Chrome 116 e versioni successive

    Le promesse sono supportate in Manifest V3 e versioni successive, ma i callback vengono forniti per la compatibilità con le versioni precedenti. Non puoi utilizzarli entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo passato al callback.

setProperties()

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

Imposta le proprietà del dispositivo di input o di output.

Parametri

  • id

    stringa

  • proprietà

    DeviceProperties

  • callback

    function facoltativa

    Il parametro callback ha il seguente aspetto: 

    () => void

Resi

  • Promise<void>

    Chrome 116 e versioni successive

    Le promesse sono supportate in Manifest V3 e versioni successive, ma i callback vengono forniti per la compatibilità con le versioni precedenti. Non puoi utilizzarli entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo passato al callback.

Eventi

onDeviceListChanged

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

Viene attivato quando cambiano i dispositivi audio, vengono aggiunti nuovi dispositivi o vengono rimossi dispositivi esistenti.

Parametri

onLevelChanged

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

Viene attivato quando il livello di suono cambia per un dispositivo audio attivo.

Parametri

onMuteChanged

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

Viene attivato quando cambia lo stato di disattivazione dell'audio in entrata o in uscita. Tieni presente che lo stato di disattivazione dell'audio è a livello di sistema e il nuovo valore si applica a tutti i dispositivi audio con il tipo di stream specificato.

Parametri