chrome.audio

Beschreibung

Die chrome.audio API ermöglicht es Nutzern, Informationen zu den am System angeschlossenen Audiogeräten abzurufen und diese zu steuern. Diese API ist derzeit nur im Kioskmodus für ChromeOS verfügbar.

Berechtigungen

audio

Verfügbarkeit

Chrome 59 und höher Nur ChromeOS

Typen

AudioDeviceInfo

Attribute

  • deviceName

    String

    Gerätename

  • deviceType

    DeviceType

    Typ des Geräts.

  • displayName

    String

    Der nutzerfreundliche Name (z.B. „USB-Mikrofon“).

  • id

    String

    Die eindeutige Kennung des Audiogeräts.

  • isActive (Aktiv)

    boolean

    „True“, wenn dies das aktuell aktive Gerät ist.

  • Level

    Zahl

    Der Lautstärkepegel des Geräts, die Lautstärke für die Ausgabe und die Verstärkung für die Eingabe.

  • stableDeviceId

    String optional

    Der stabile/persistente Geräte-ID-String, falls verfügbar.

  • streamType

    StreamType

    Der mit diesem Gerät verknüpfte Streamtyp.

DeviceFilter

Attribute

  • isActive (Aktiv)

    boolescher Wert optional

    Wenn dieser Wert festgelegt ist, werden nur Audiogeräte gefiltert, deren aktiver Status mit diesem Wert übereinstimmt.

  • streamTypes

    StreamType[] optional

    Wenn diese Option festgelegt ist, werden nur Audiogeräte gefiltert, deren Streamtyp in dieser Liste enthalten ist.

DeviceIdLists

Attribute

  • Eingabe

    string[] optional

    Liste der Eingabegeräte, die anhand ihrer ID angegeben sind.

    Wenn Eingabegeräte nicht betroffen sein sollen, lassen Sie diese Property leer.

  • output

    string[] optional

    Liste der Ausgabegeräte, die anhand ihrer ID angegeben werden.

    Wenn Ausgabegeräte nicht betroffen sein sollen, lassen Sie diese Property leer.

DeviceProperties

Attribute

  • Level

    number optional

    Die gewünschte Lautstärke des Audiogeräts. Standardmäßig wird die aktuelle Lautstärke des Geräts verwendet.

    Wenn mit einem Audioeingabegerät verwendet, entspricht der Wert der Verstärkung des Audiogeräts.

    Wenn mit einem Audioausgabegerät verwendet, entspricht der Wert der Lautstärke des Audiogeräts.

DeviceType

Verfügbare Audiogerätetypen.

Enum

„HEADPHONE“

„MIC“

„USB“

„BLUETOOTH“

„HDMI“

"INTERNAL_SPEAKER"

"INTERNAL_MIC"

"FRONT_MIC"

"REAR_MIC"

"KEYBOARD_MIC"

„HOTWORD“

„LINEOUT“

"POST_MIX_LOOPBACK"

"POST_DSP_LOOPBACK"

"ALSA_LOOPBACK"

„SONSTIGE“

LevelChangedEvent

Attribute

  • deviceId

    String

    ID des Geräts, dessen Lautstärke sich geändert hat.

  • Level

    Zahl

    Die neue Lautstärke des Geräts.

MuteChangedEvent

Attribute

  • isMuted

    boolean

    Gibt an, ob der Stream jetzt stummgeschaltet ist.

  • streamType

    StreamType

    Der Typ des Streams, für den sich der Stummschaltungsstatus geändert hat. Der aktualisierte Stummschaltungswert gilt für alle Geräte mit diesem Streamtyp.

StreamType

Der Streamtyp, den ein Audiogerät bereitstellt.

Enum

"INPUT"

"OUTPUT"

Methoden

getDevices()

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

Eine Liste von Audiogeräten wird abgerufen, die nach filter gefiltert ist.

Parameter

  • Filter

    DeviceFilter optional

    Geräteeigenschaften, anhand derer die Liste der zurückgegebenen Audiogeräte gefiltert werden kann. Wenn der Filter nicht festgelegt oder auf {} festgelegt ist, enthält die zurückgegebene Geräteliste alle verfügbaren Audiogeräte.

  • callback

    function optional

    Der Parameter callback sieht so aus: 

    (devices: AudioDeviceInfo[]) => void

Gibt Folgendes zurück:

  • Promise<AudioDeviceInfo[]>

    Chrome 116 und höher

    Versprechen werden in Manifest V3 und höher unterstützt, aber Callbacks sind für die Abwärtskompatibilität verfügbar. Sie können nicht beide für denselben Funktionsaufruf verwenden. Das Versprechen wird mit demselben Typ aufgelöst, der an den Rückruf übergeben wird.

getMute()

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

Ruft den systemweiten Stummschaltungsstatus für den angegebenen Streamtyp ab.

Parameter

  • streamType

    StreamType

    Streamtyp, für den der Stummschaltungsstatus abgerufen werden soll.

  • callback

    function optional

    Der Parameter callback sieht so aus: 

    (value: boolean) => void

    • Wert

      boolean

Gibt Folgendes zurück:

  • Promise<boolean>

    Chrome 116 und höher

    Versprechen werden in Manifest V3 und höher unterstützt, aber Callbacks sind für die Abwärtskompatibilität verfügbar. Sie können nicht beide für denselben Funktionsaufruf verwenden. Das Versprechen wird mit demselben Typ aufgelöst, der an den Rückruf übergeben wird.

setActiveDevices()

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

Hiermit werden Listen aktiver Eingabe- und/oder Ausgabegeräte festgelegt.

Parameter

  • Gibt die IDs der Geräte an, die aktiv sein sollen. Wenn weder die Eingabe- noch die Ausgabeliste festgelegt ist, sind die Geräte in dieser Kategorie nicht betroffen.

    Es ist ein Fehler, eine nicht vorhandene Geräte-ID zu übergeben.

  • callback

    function optional

    Der Parameter callback sieht so aus: 

    () => void

Gibt Folgendes zurück:

  • Promise<void>

    Chrome 116 und höher

    Versprechen werden in Manifest V3 und höher unterstützt, aber Callbacks sind für die Abwärtskompatibilität verfügbar. Sie können nicht beide für denselben Funktionsaufruf verwenden. Das Versprechen wird mit demselben Typ aufgelöst, der an den Rückruf übergeben wird.

setMute()

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

Hiermit wird der Stummschaltungsstatus für einen Streamtyp festgelegt. Der Stummschaltungsstatus gilt für alle Audiogeräte mit dem angegebenen Audiostreamtyp.

Parameter

  • streamType

    StreamType

    Streamtyp, für den der Stummschaltungsstatus festgelegt werden soll.

  • isMuted

    boolean

    Neuer Stummschaltungswert.

  • callback

    function optional

    Der Parameter callback sieht so aus: 

    () => void

Gibt Folgendes zurück:

  • Promise<void>

    Chrome 116 und höher

    Versprechen werden in Manifest V3 und höher unterstützt, aber Callbacks sind für die Abwärtskompatibilität verfügbar. Sie können nicht beide für denselben Funktionsaufruf verwenden. Das Versprechen wird mit demselben Typ aufgelöst, der an den Rückruf übergeben wird.

setProperties()

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

Hier legen Sie die Eigenschaften für das Eingabe- oder Ausgabegerät fest.

Parameter

  • id

    String

  • Properties

    DeviceProperties

  • callback

    function optional

    Der Parameter callback sieht so aus: 

    () => void

Gibt Folgendes zurück:

  • Promise<void>

    Chrome 116 und höher

    Versprechen werden in Manifest V3 und höher unterstützt, aber Callbacks sind für die Abwärtskompatibilität verfügbar. Sie können nicht beide für denselben Funktionsaufruf verwenden. Das Versprechen wird mit demselben Typ aufgelöst, der an den Rückruf übergeben wird.

Ereignisse

onDeviceListChanged

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

Wird ausgelöst, wenn sich Audiogeräte ändern, also neue Geräte hinzugefügt oder vorhandene Geräte entfernt werden.

Parameter

onLevelChanged

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

Wird ausgelöst, wenn sich der Lautstärkepegel eines aktiven Audiogeräts ändert.

Parameter

onMuteChanged

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

Wird ausgelöst, wenn sich der Stummschaltungsstatus der Audioeingabe oder -ausgabe ändert. Der Stummschaltungsstatus ist systemweit und der neue Wert gilt für jedes Audiogerät mit dem angegebenen Streamtyp.

Parameter