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

Disponibilité

Chrome (version 59 ou 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, "Micro USB").

  • id

    chaîne

    Identifiant unique de l'appareil audio.

  • isActive

    booléen

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

  • level

    Nombre

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

  • stableDeviceId

    chaîne facultatif

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

  • streamType

    StreamType

    Type de flux associé à cet appareil.

DeviceFilter

Propriétés

  • isActive

    Booléen facultatif

    Si cette règle 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 satisferont les critères de 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, laissez cette propriété non définie.

DeviceProperties

Propriétés

  • level

    numéro facultatif

    Niveau sonore souhaité de l'appareil audio. Par défaut, il s'agit du 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.

Énumération

"ÉCOUTEUR"

"MIC"

"USB"

"BLUETOOTH"

"HDMI"

"INTERNAL_SPEAKER"

"INTERNAL_MIC"

"FRONT_MIC"

"REAR_MIC"

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

    Nombre

    Nouveau niveau sonore de l'appareil.

MuteChangedEvent

Propriétés

  • isMuted

    booléen

    Indique si le son de la diffusion est désormais coupé ou non.

  • streamType

    StreamType

    Type de flux pour lequel la valeur de désactivation du son a été modifiée. La nouvelle valeur pour couper le son s'applique à tous les appareils utilisant ce type de flux.

StreamType

Type de flux fourni par un appareil audio.

Énumération

"INPUT"

"RÉSULTAT"

Méthodes

getDevices()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.audio.getDevices(
  filter?: DeviceFilter,
  callback?: function,
)

Récupère une liste d'appareils audio filtrés en fonction de filter.

Paramètres

  • filtre

    DeviceFilter facultatif

    Propriétés de l'appareil selon lesquelles vous souhaitez 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

    function facultatif

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

    (devices: AudioDeviceInfo[]) => void

Renvoie

  • Promise&lt;AudioDeviceInfo[]&gt;

    Chrome 116 et versions ultérieures

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

getMute()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.audio.getMute(
  streamType: StreamType,
  callback?: function,
)

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

Paramètres

  • streamType

    StreamType

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

  • rappel

    function facultatif

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

    (value: boolean) => void

    • valeur

      booléen

Renvoie

  • Promise&lt;boolean&gt;

    Chrome 116 et versions ultérieures

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

setActiveDevices()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.audio.setActiveDevices(
  ids: DeviceIdLists,
  callback?: function,
)

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

Paramètres

  • Spécifie les identifiants 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 affectés.

    La transmission d'un ID d'appareil inexistant est une erreur.

  • rappel

    function facultatif

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

    () => void

Renvoie

  • Promesse<void>

    Chrome 116 et versions ultérieures

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

setMute()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.audio.setMute(
  streamType: StreamType,
  isMuted: boolean,
  callback?: function,
)

Définit l'état de désactivation du son pour un type de flux. Le son sera coupé sur tous les appareils audio utilisant le 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 masquage.

  • rappel

    function facultatif

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

    () => void

Renvoie

  • Promesse<void>

    Chrome 116 et versions ultérieures

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

setProperties()

<ph type="x-smartling-placeholder"></ph> 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 (Propriétés de l'appareil)

  • rappel

    function facultatif

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

    () => void

Renvoie

  • Promesse<void>

    Chrome 116 et versions ultérieures

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

Événements

onDeviceListChanged

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

Déclenché lorsque des appareils audio sont modifiés, que de nouveaux appareils sont ajoutés ou que des appareils existants sont supprimés.

Paramètres

onLevelChanged

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

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

Paramètres

onMuteChanged

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

Déclenché lorsque l'état de désactivation du son de l'entrée ou de la sortie audio est modifié. Notez que la coupure 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