chrome.audio

Descrizione

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

Autorizzazioni

audio

Disponibilità

Chrome 59+ Solo ChromeOS

Tipi

AudioDeviceInfo

Proprietà

  • deviceName

    stringa

    Nome del dispositivo.

  • deviceType

    DeviceType

    Tipo di dispositivo.

  • displayName

    stringa

    Il nome descrittivo (ad es. "Microfono USB").

  • id

    stringa

    L'identificatore univoco del dispositivo audio.

  • isActive

    booleano

    True se questo è il dispositivo attivo corrente.

  • livello

    numero

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

  • stableDeviceId

    stringa facoltativa

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

  • streamType

    StreamType

    Il 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 flusso è incluso in questo elenco soddisferanno il filtro.

DeviceIdLists

Proprietà

  • input

    string[] facoltativo

    Elenco dei dispositivi di input specificati dal relativo ID.

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

  • output

    string[] facoltativo

    Elenco dei dispositivi di output specificati in base al loro ID.

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

DeviceProperties

Proprietà

  • livello

    number (facoltativo)

    Il livello audio desiderato del dispositivo audio. Per impostazione predefinita, è il livello audio attuale 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 audio.

DeviceType

Tipi di dispositivi audio disponibili.

Enum

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

"ALTRO"

LevelChangedEvent

Proprietà

  • deviceId

    stringa

    ID del dispositivo il cui livello audio è cambiato.

  • livello

    numero

    Il nuovo livello audio del dispositivo.

MuteChangedEvent

Proprietà

  • isMuted

    booleano

    Indica se lo stream è ora disattivato.

  • streamType

    StreamType

    Il tipo di stream per cui è stato modificato il valore di disattivazione dell'audio. Il valore di disattivazione audio aggiornato viene applicato 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,
): Promise<AudioDeviceInfo[]>

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

Parametri

  • filtro

    DeviceFilter facoltativo

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

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (devices: AudioDeviceInfo[]) => void

Resi

  • Promise<AudioDeviceInfo[]>

    Chrome 116+

    Le promesse sono supportate solo per Manifest V3 e versioni successive, le altre piattaforme devono utilizzare i callback.

getMute()

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

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

Parametri

  • streamType

    StreamType

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

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (value: boolean) => void

    • valore

      booleano

Resi

  • Promise<boolean>

    Chrome 116+

    Le promesse sono supportate solo per Manifest V3 e versioni successive, le altre piattaforme devono utilizzare i callback.

setActiveDevices()

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

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 output non è impostato, i dispositivi di quella categoria non vengono interessati.

    È un errore passare un ID dispositivo inesistente.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    () => void

Resi

  • Promise<void>

    Chrome 116+

    Le promesse sono supportate solo per Manifest V3 e versioni successive, le altre piattaforme devono utilizzare i callback.

setMute()

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

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 flusso audio specificato.

Parametri

  • streamType

    StreamType

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

  • isMuted

    booleano

    Nuovo valore di disattivazione audio.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    () => void

Resi

  • Promise<void>

    Chrome 116+

    Le promesse sono supportate solo per Manifest V3 e versioni successive, le altre piattaforme devono utilizzare i callback.

setProperties()

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

Imposta le proprietà per il dispositivo di input o output.

Parametri

  • id

    stringa

  • proprietà

    DeviceProperties

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    () => void

Resi

  • Promise<void>

    Chrome 116+

    Le promesse sono supportate solo per Manifest V3 e versioni successive, le altre piattaforme devono utilizzare i callback.

Eventi

onDeviceListChanged

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

Attivato quando i dispositivi audio cambiano, ovvero quando vengono aggiunti nuovi dispositivi o rimossi quelli esistenti.

Parametri

onLevelChanged

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

Attivato quando il livello audio cambia per un dispositivo audio attivo.

Parametri

onMuteChanged

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

Attivato quando cambia lo stato di disattivazione dell'audio dell'ingresso o dell'uscita audio. Tieni presente che lo stato di disattivazione dell'audio è a livello di sistema e il nuovo valore si applica a ogni dispositivo audio con il tipo di stream specificato.

Parametri