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 que 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 de l'appareil audio.

  • isActive

    booléen

    "True" si cet appareil est actuellement actif.

  • level

    Nombre

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

  • stableDeviceId

    chaîne 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 valeur est définie, seuls les appareils audio dont l'état actif correspond à cette valeur satisferont au filtre.

  • streamTypes

    StreamType[] facultatif

    Si cette valeur est définie, seuls les appareils audio dont le type de flux est inclus dans cette liste seront acceptés par le 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é.

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

    Si utilisé avec un appareil de sortie audio, 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"

"MICRO_ARRIÈRE"

"KEYBOARD_MIC"

"HOTWORD"

"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

    Nombre

    Nouveau niveau sonore de l'appareil.

MuteChangedEvent

Propriétés

  • isMuted

    booléen

    Indique si le flux est maintenant coupé ou non.

  • streamType

    StreamType

    Type du flux pour lequel la valeur de mise en sourdine a changé. La valeur de mise en sourdine mise à jour s'applique à tous les appareils avec ce type de flux.

StreamType

Type de flux fourni par un appareil audio.

Énumération

"INPUT"

"SORTIE"

Méthodes

getDevices()

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 à l'aide desquelles filtrer la liste des périphériques 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.

  • rappel

    fonction facultatif

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

    (devices: AudioDeviceInfo[]) => void

Renvoie

  • Promise<AudioDeviceInfo[]>

    Chrome 116 ou version ultérieure

    Les promesses sont compatibles avec la version 3 du fichier manifeste 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 se résout 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 la 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 mise en sourdine doit être récupéré.

  • rappel

    fonction facultatif

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

    (value: boolean) => void

    • valeur

      booléen

Renvoie

  • Promise<boolean>

    Chrome 116 ou version ultérieure

    Les promesses sont compatibles avec la version 3 du fichier manifeste 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 se résout avec le même type que celui transmis au rappel.

setActiveDevices()

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 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 affectés.

    Le fait de transmettre un ID d'appareil inexistant est considéré comme une erreur.

  • rappel

    fonction facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 116 ou version ultérieure

    Les promesses sont compatibles avec la version 3 du fichier manifeste 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 se résout 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 de la mise en sourdine pour un type de flux. L'état de mise en sourdine s'applique à tous les appareils audio avec le type de flux audio spécifié.

Paramètres

  • streamType

    StreamType

    Type de flux pour lequel l'état de mise en sourdine doit être défini.

  • isMuted

    booléen

    Nouvelle valeur de mise en sourdine.

  • rappel

    fonction facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 116 ou version ultérieure

    Les promesses sont compatibles avec la version 3 du fichier manifeste 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 se résout 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 de l'appareil d'entrée ou de sortie.

Paramètres

  • id

    chaîne

  • du bucket

    DeviceProperties

  • rappel

    fonction facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 116 ou version ultérieure

    Les promesses sont compatibles avec la version 3 du fichier manifeste 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 se résout 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 changent, 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 change pour un appareil audio actif.

Paramètres

onMuteChanged

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

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

Paramètres