chrome.audio

Beschreibung

Die chrome.audio API wird bereitgestellt, damit Nutzer Informationen über die mit dem System verbundenen Audiogeräte abrufen und steuern können. 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

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

  • stableDeviceId

    String optional

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

  • streamType

    StreamType

    Mit diesem Gerät verknüpfter Streamtyp.

DeviceFilter

Attribute

  • isActive (Aktiv)

    Boolescher Wert optional

    Wenn festgelegt, erfüllen nur Audiogeräte, deren aktiver Status diesem Wert entspricht, den Filter.

  • streamTypes

    StreamType[] optional

    Wenn dieser Wert festgelegt ist, erfüllen nur Audiogeräte, deren Streamtyp in dieser Liste enthalten ist, den Filter.

DeviceIdLists

Attribute

  • Eingabe

    string[] optional

    Liste der durch ihre ID angegebenen Eingabegeräte.

    Um anzugeben, dass Eingabegeräte nicht betroffen sein sollen, lassen Sie diese Eigenschaft nicht konfiguriert.

  • output

    string[] optional

    Liste der Ausgabegeräte, die durch ihre ID angegeben sind.

    Wenn Ausgabegeräte nicht betroffen sein sollen, lassen Sie diese Eigenschaft nicht festgelegt.

DeviceProperties

Attribute

  • Level

    Zahl optional

    Die gewünschte Lautstärke des Audiogeräts. Die Standardeinstellung ist die aktuelle Lautstärke des Geräts.

    Bei Verwendung mit dem Audioeingabegerät stellt die Verstärkung des Audiogeräts dar.

    Gibt bei Verwendung mit dem Audioausgabegerät die Lautstärke des Audiogeräts an.

DeviceType

Verfügbare Audiogerätetypen.

Enum

"HEADPHONE"

„MIC“

„USB“

"BLUETOOTH"

„HDMI“

"INTERNAL_REFERENZ"

"INTERNAL_MIC"

„FRONT_MIC“

„REAR_MIC“

„KEYBOARD_MIC“

"HOTWORD"

„LINEOUT“

"POST_MIX_LOOPBACK"

„POST_DSP_LOOPBACK“

„ALSA_LOOPBACK“

"OTHER"

LevelChangedEvent

Attribute

  • deviceId

    String

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

  • Level

    Zahl

    Der neue Geräuschpegel 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 Wert für die Stummschaltung geändert hat. Der aktualisierte Wert für die Stummschaltung gilt für alle Geräte mit diesem Streamtyp.

StreamType

Die Art des Streams, den ein Audiogerät bereitstellt.

Enum

"INPUT"

"AUSGABE"

Methoden

getDevices()

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

Ruft eine Liste mit Audiogeräten ab, die nach filter gefiltert sind.

Parameter

  • Filter

    DeviceFilter optional

    Geräteeigenschaften, nach denen die Liste der zurückgegebenen Audiogeräte gefiltert werden soll. Wenn der Filter nicht konfiguriert oder auf „{}“ gesetzt ist, enthält die zurückgegebene Geräteliste alle verfügbaren Audiogeräte.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (devices: AudioDeviceInfo[]) => void

Gibt Folgendes zurück:

  • Promise&lt;AudioDeviceInfo[]&gt;

    Chrome 116 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

getMute()

<ph type="x-smartling-placeholder"></ph> Versprechen 
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

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (value: boolean) => void

    • Wert

      boolean

Gibt Folgendes zurück:

  • Promise&lt;boolean&gt;

    Chrome 116 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

setActiveDevices()

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

Legt Listen der aktiven Eingabe- und/oder Ausgabegeräte fest.

Parameter

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

    Die Übergabe einer nicht vorhandenen Geräte-ID gilt als Fehler.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    () => void

Gibt Folgendes zurück:

  • Versprechen<void>

    Chrome 116 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

setMute()

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

Legt den Stummschaltungsstatus für einen Streamtyp fest. Die Stummschaltung gilt für alle Audiogeräte mit dem angegebenen Audiostreamtyp.

Parameter

  • streamType

    StreamType

    Streamtyp, für den die Stummschaltung festgelegt werden soll.

  • isMuted

    boolean

    Neuer Wert für die Ausblendung.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    () => void

Gibt Folgendes zurück:

  • Versprechen<void>

    Chrome 116 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

setProperties()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.audio.setProperties(
  id: string,
  properties: DeviceProperties,
  callback?: function,
)

Legt die Attribute für das Eingabe- oder Ausgabegerät fest.

Parameter

  • id

    String

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    () => void

Gibt Folgendes zurück:

  • Versprechen<void>

    Chrome 116 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

Ereignisse

onDeviceListChanged

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

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

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (devices: AudioDeviceInfo[]) => void

onLevelChanged

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

Wird ausgelöst, wenn sich die Lautstärke für ein aktives Audiogerät ändert

Parameter

onMuteChanged

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

Wird ausgelöst, wenn sich die Stummschaltung der Audioeingabe oder -ausgabe ändert. Der Stummschaltungsstatus gilt systemübergreifend und der neue Wert gilt für alle Audiogeräte mit dem angegebenen Streamtyp.

Parameter