chrome.audio

Description

L'API chrome.audio est fournie pour permettre aux utilisateurs d'obtenir des informations sur les appareils audio connectés au système et de les contrôler. Cette API n'est actuellement disponible qu'en mode kiosque pour ChromeOS.

Autorisations

audio

Disponibilité

Chrome 59 ou version ultérieure ChromeOS uniquement

Types

AudioDeviceInfo

Propriétés

  • deviceName

    chaîne

    Nom de l'appareil.

  • deviceType

    DeviceType

    Type d'appareil.

  • displayName

    chaîne

    Nom convivial (par exemple, "Microphone USB").

  • id

    chaîne

    Identifiant unique du périphérique audio.

  • isActive

    booléen

    "True" si l'appareil est actuellement actif.

  • level

    Total

    Niveau sonore de l'appareil, volume pour la sortie, gain pour l'entrée.

  • stableDeviceId

    chaîne facultative

    Chaîne d'ID d'appareil stable/persistant, si disponible.

  • streamType

    StreamType

    Type de flux associé à cet appareil.

DeviceFilter

Propriétés

  • isActive

    booléen facultatif

    Si cette valeur est définie, seuls les appareils audio dont l'état actif correspond à cette valeur satisferont le filtre.

  • streamTypes

    StreamType[] facultatif

    Si cette option est définie, seuls les appareils audio dont le type de flux est inclus dans cette liste correspondront au filtre.

DeviceIdLists

Propriétés

  • entrée

    string[] facultatif

    Liste des périphériques d'entrée spécifiés par leur ID.

    Pour indiquer que les périphériques d'entrée ne doivent pas être affectés, ne définissez pas cette propriété.

  • output

    string[] facultatif

    Liste des périphériques de sortie spécifiés par leur ID.

    Pour indiquer que les périphériques de sortie ne doivent pas être affectés, ne définissez pas cette propriété.

DeviceProperties

Propriétés

  • level

    number facultatif

    Niveau sonore souhaité de l'appareil audio. Par défaut, le niveau sonore actuel de l'appareil est utilisé.

    S'il est utilisé avec un appareil d'entrée audio, il représente le gain de l'appareil audio.

    Si elle est utilisée avec un appareil de sortie audio, elle représente le volume de l'appareil audio.

DeviceType

Types d'appareils audio disponibles.

Énumération

"HEADPHONE"

"MIC"

"USB"

"BLUETOOTH"

"HDMI"

"INTERNAL_SPEAKER"

"INTERNAL_MIC"

"FRONT_MIC"

"REAR_MIC"

"KEYBOARD_MIC"

"MOT CLÉ"

"LINEOUT"

"POST_MIX_LOOPBACK"

"POST_DSP_LOOPBACK"

"ALSA_LOOPBACK"

"AUTRE"

LevelChangedEvent

Propriétés

  • deviceId

    chaîne

    ID de l'appareil dont le niveau sonore a changé.

  • level

    Total

    Le nouveau niveau sonore de l'appareil.

MuteChangedEvent

Propriétés

  • isMuted

    booléen

    Indique si le flux est désormais mis en sourdine.

  • streamType

    StreamType

    Type de flux pour lequel la valeur de mise en sourdine a changé. La nouvelle valeur de désactivation s'applique à tous les appareils utilisant ce type de flux.

StreamType

Type de flux fourni par un appareil audio.

Énumération

"INPUT"

"OUTPUT"

Méthodes

getDevices()

Promise 
chrome.audio.getDevices(
  filter?: DeviceFilter,
  callback?: function,
): Promise<AudioDeviceInfo[]>

Obtient une liste d'appareils audio filtrée en fonction de filter.

Paramètres

  • filtre

    DeviceFilter facultatif

    Propriétés de l'appareil permettant de filtrer la liste des appareils audio renvoyés. Si le filtre n'est pas défini ou est défini sur {}, la liste des appareils renvoyée contient tous les appareils audio disponibles.

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    (devices: AudioDeviceInfo[]) => void

Renvoie

  • Promise<AudioDeviceInfo[]>

    Chrome 116 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

getMute()

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

Obtient l'état de mise en sourdine à l'échelle du système pour le type de flux spécifié.

Paramètres

  • streamType

    StreamType

    Type de flux pour lequel l'état de la mise en sourdine doit être récupéré.

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    (value: boolean) => void

    • valeur

      booléen

Renvoie

  • Promise<boolean>

    Chrome 116 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

setActiveDevices()

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

Définit les listes des périphériques d'entrée et/ou de sortie actifs.

Paramètres

  • Spécifie les ID des appareils qui doivent être actifs. Si la liste d'entrée ou de sortie n'est pas définie, les appareils de cette catégorie ne sont pas concernés.

    Transmettre un ID d'appareil inexistant est une erreur.

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    () => void

Renvoie

  • Promise<void>

    Chrome 116 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

setMute()

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

Définit l'état de désactivation du son pour un type de flux. L'état de désactivation du son s'appliquera à tous les appareils audio associés au type de flux audio spécifié.

Paramètres

  • streamType

    StreamType

    Type de flux pour lequel l'état de désactivation du son doit être défini.

  • isMuted

    booléen

    Nouvelle valeur de mise en sourdine.

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    () => void

Renvoie

  • Promise<void>

    Chrome 116 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

setProperties()

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

Définit les propriétés du périphérique d'entrée ou de sortie.

Paramètres

  • id

    chaîne

  • properties

    DeviceProperties

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    () => void

Renvoie

  • Promise<void>

    Chrome 116 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

Événements

onDeviceListChanged

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

Déclenché lorsque les appareils audio changent (ajout ou suppression d'appareils).

Paramètres

onLevelChanged

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

Déclenché lorsque le niveau sonore change pour un appareil audio actif.

Paramètres

onMuteChanged

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

Déclenché lorsque l'état de mise en sourdine de l'entrée ou de la sortie audio change. Notez que l'état de mise en sourdine est défini à l'échelle du système et que la nouvelle valeur s'applique à tous les appareils audio avec le type de flux spécifié.

Paramètres