chrome.audio

Descrizione

L'API chrome.audio viene fornita per consentire agli utenti di ottenere informazioni sui dispositivi audio collegati al sistema e controllarli. 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 usare (ad es. "Microfono USB").

  • id

    stringa

    L'identificatore univoco del dispositivo audio.

  • isActive

    boolean

    True se questo è il dispositivo attivo attualmente.

  • livello

    numero

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

  • stableDeviceId

    stringa facoltativo

    La stringa ID dispositivo stabile/permanente, 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

    string[] facoltativo

    Elenco di dispositivi di input specificati in base al relativo ID.

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

  • output

    string[] facoltativo

    Elenco di dispositivi di output specificati in base al relativo ID.

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

DeviceProperties

Proprietà

  • livello

    numero facoltativo

    Il livello audio desiderato del dispositivo audio. Il valore predefinito è il livello audio attuale del dispositivo.

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

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

DeviceType

Tipi di dispositivi audio disponibili.

Enum

"MIC"

"USB"

"BLUETOOTH"

"HDMI"

"INTERNAL_SPEAKER"

"FRONT_MIC"

"REAR_MIC"

"KEYBOARD_MIC"

"HOTWORD"

"LINEOUT"

"POST_MIX_LOOPBACK"

"POST_DSP_LOOPBACK"

"ALSA_LOOPBACK"

LevelChangedEvent

Proprietà

  • deviceId

    stringa

    ID del dispositivo il cui livello audio è cambiato.

  • livello

    numero

    Il nuovo livello sonoro del dispositivo.

MuteChangedEvent

Proprietà

  • isMuted

    boolean

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

  • streamType

    StreamType

    Il tipo di stream per cui è stato modificato il valore di disattivazione dell'audio. Il valore di disattivazione 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,
)

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

Parametri

  • filter

    DeviceFilter facoltativo

    Proprietà dispositivo in base alle quali filtrare l'elenco dei dispositivi audio restituiti. Se il filtro non viene impostato o se viene 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

Ritorni

  • Promise<AudioDeviceInfo[]>

    Chrome 116 e versioni successive

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

getMute()

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

Restituisce lo stato di disattivazione 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

      boolean

Ritorni

  • Promise<boolean>

    Chrome 116 e versioni successive

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

setActiveDevices()

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

Consente di impostare 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 subiranno modifiche.

    È un errore passare in un ID dispositivo inesistente.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    ()=>void

Ritorni

  • Promise<void>

    Chrome 116 e versioni successive

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

setMute()

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

Imposta la disattivazione dell'audio per un tipo di stream. L'audio disattivato verrà applicato a tutti i dispositivi audio con il tipo di stream audio specificato.

Parametri

  • streamType

    StreamType

    Tipo di stream per cui impostare la disattivazione dell'audio.

  • isMuted

    boolean

    Nuovo valore di disattivazione dell'audio.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    ()=>void

Ritorni

  • Promise<void>

    Chrome 116 e versioni successive

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

setProperties()

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

Consente di impostare le proprietà del dispositivo di input o di output.

Parametri

  • id

    stringa

  • proprietà

    DeviceProperties

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    ()=>void

Ritorni

  • Promise<void>

    Chrome 116 e versioni successive

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

Eventi

onDeviceListChanged

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

Si attiva quando cambiano dispositivi audio, quando vengono aggiunti nuovi dispositivi o quando vengono rimossi dispositivi esistenti.

Parametri

onLevelChanged

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

Viene attivato quando cambia il livello del suono di 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 l'audio disattivato a livello di sistema e che il nuovo valore viene applicato a tutti i dispositivi audio per i quali è stato specificato il tipo di stream.

Parametri