chrome.audio

Description

L'API chrome.audio permet 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

Garantie de disponibilité

Chrome 59 et versions ultérieures 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, "Micro USB").

  • id

    chaîne

    Identifiant unique de l'appareil audio.

  • isActive

    boolean

    "True" s'il s'agit de l'appareil actuellement actif.

  • level

    number

    Niveau sonore de l'appareil, volume en sortie et gain en entrée.

  • stableDeviceId

    string facultatif

    Chaîne d'ID d'appareil stable/persistant, le cas échéant.

  • streamType

    StreamType

    Type de flux associé à cet appareil.

DeviceFilter

Propriétés

  • isActive

    Booléen facultatif

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

  • streamTypes

    StreamType[] facultatif

    Si cette règle est définie, seuls les appareils audio dont le type de flux est inclus dans cette liste s'appliquent 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é.

  • sortie

    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

    numéro facultatif

    Niveau sonore souhaité par l'appareil audio. La valeur par défaut est le niveau sonore actuel de l'appareil.

    Si utilisé avec un périphérique d'entrée audio, représente le gain de l'appareil audio.

    Si utilisé avec un périphérique de sortie audio, représente le volume de l'appareil audio.

DeviceType

Types d'appareils audio disponibles.

Enum

"MIC"

"USB"

"BLUETOOTH"

"HDMI"

"INTERNAL_MIC"

"REAR_MIC"

"HOTWORD"

"LINEOUT"

"POST_MIX_LOOPBACK"

"POST_DSP_LOOPBACK"

"ALSA_LOOPBACK"

"OTHER"

LevelChangedEvent

Propriétés

  • deviceId

    chaîne

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

  • level

    number

    Nouveau niveau sonore de l'appareil.

MuteChangedEvent

Propriétés

  • isMuted

    boolean

    Indique si le son du flux est maintenant coupé.

  • streamType

    StreamType

    Type de flux pour lequel la valeur du masquage a changé. Le nouveau paramètre "Ignorer" s'applique à tous les appareils utilisant ce type de flux.

StreamType

Type de flux fourni par un appareil audio.

Enum

"INPUT"

Méthodes

getDevices()

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

Récupère la liste des appareils audio filtrée en fonction de filter.

Paramètres

  • filtre

    DeviceFilter facultatif

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

  • rappel

    fonction facultative

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

    (devices: AudioDeviceInfo[])=>void

Renvoie

  • Promise<AudioDeviceInfo[]>

    Chrome 116 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

getMute()

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

Récupère l'état de désactivation du son au niveau du système pour le type de flux spécifié.

Paramètres

  • streamType

    StreamType

    Type de flux pour lequel l'état de coupure du son doit être récupéré.

  • rappel

    fonction facultative

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

    (value: boolean)=>void

    • valeur

      boolean

Renvoie

  • Promise<boolean>

    Chrome 116 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

setActiveDevices()

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

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 aucune liste d'entrée ou de sortie n'est définie, les appareils de cette catégorie ne sont pas affectés.

    Transmettre un ID d'appareil inexistant est une erreur.

  • rappel

    fonction facultative

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

    ()=>void

Renvoie

  • Promise<void>

    Chrome 116 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

setMute()

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

Définit l'état du son coupé pour un type de flux. Le son sera désactivé sur tous les appareils audio utilisant le type de flux audio spécifié.

Paramètres

  • streamType

    StreamType

    Type de flux pour lequel le son doit être désactivé.

  • isMuted

    boolean

    Nouvelle valeur Ignorer.

  • rappel

    fonction facultative

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

    ()=>void

Renvoie

  • Promise<void>

    Chrome 116 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

setProperties()

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

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

Paramètres

  • id

    chaîne

  • du bucket

    DeviceProperties

  • rappel

    fonction facultative

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

    ()=>void

Renvoie

  • Promise<void>

    Chrome 116 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

Événements

onDeviceListChanged

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

Déclenché lorsque des appareils audio sont modifiés (ajout d'appareils ou suppression d'appareils existants).

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 le son de l'entrée ou de la sortie audio est modifié Notez que l'état de désactivation du son s'applique à l'ensemble du système et que la nouvelle valeur s'applique à tous les appareils audio dont le type de flux est spécifié.

Paramètres