chrome.audio

Beschreibung

Die chrome.audio API wird bereitgestellt, damit Nutzer Informationen zu den mit dem System verbundenen Audiogeräten 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 benutzerfreundliche Name (z.B. „USB-Mikrofon“).

  • id

    String

    Die eindeutige ID des Audiogeräts.

  • isActive

    boolean

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

  • level

    Zahl

    Lautstärke des Geräts, Lautstärke für Ausgabe, Verstärkung für Eingang

  • stableDeviceId

    String optional

    Die stabile/bewahrte Geräte-ID-String, falls verfügbar.

  • streamType

    StreamType

    Mit diesem Gerät verknüpfter Streamtyp.

DeviceFilter

Attribute

  • isActive

    Boolescher Wert optional

    Wenn die Richtlinie konfiguriert ist, erfüllen nur Audiogeräte, deren aktiver Status mit diesem Wert übereinstimmt, die Filterbedingungen.

  • streamTypes

    StreamType[] optional

    Wenn die Richtlinie konfiguriert ist, erfüllen nur Audiogeräte, deren Streamtyp in dieser Liste enthalten ist, den Filter.

DeviceIdLists

Attribute

  • Eingabe

    string[] optional

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

    Wenn Sie angeben möchten, dass Eingabegeräte nicht betroffen sein sollen, lassen Sie diese Eigenschaft nicht konfiguriert.

  • output

    string[] optional

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

    Wenn Sie angeben möchten, dass Ausgabegeräte nicht betroffen sein sollen, lassen Sie diese Eigenschaft nicht konfiguriert.

DeviceProperties

Attribute

  • level

    Nummer optional

    Der gewünschte Lautstärkepegel des Audiogeräts. Die Standardeinstellung ist der aktuelle Lautstärkepegel des Geräts.

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

    Bei Verwendung mit einem Audioausgabegerät stellt dies die Lautstärke des Audiogeräts dar.

DeviceType

Verfügbare Audiogerätetypen.

Enum

"FRONT_MIC"

"KEYBOARD_MIC"

"HOTWORD"

"LINEOUT"

"POST_MIX_LOOPBACK"

"POST_DSP_LOOPBACK"

"ALSA_LOOPBACK"

"OTHER"

LevelChangedEvent

Attribute

  • deviceId

    String

    ID des Geräts, dessen Geräuschpegel 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 zur Ausblendung geändert hat. Der aktualisierte Wert für die Stummschaltung gilt für alle Geräte mit diesem Streamtyp.

StreamType

Der Typ des Streams, den ein Audiogerät bereitstellt.

Enum

Methoden

getDevices()

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

Ruft eine nach filter gefilterte Liste der Audiogeräte ab.

Parameters

  • Filter

    DeviceFilter optional

    Geräteeigenschaften, nach denen die Liste der zurückgegebenen Audiogeräte gefiltert wird. Wenn der Filter nicht festgelegt 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: 

    (devices: AudioDeviceInfo[])=>void

Rückgaben

  • Promise<AudioDeviceInfo[]>

    Chrome 116 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

getMute()

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

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

Parameters

  • streamType

    StreamType

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

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (value: boolean)=>void

    • value

      boolean

Rückgaben

  • Promise<boolean>

    Chrome 116 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

setActiveDevices()

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

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

Parameters

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

    Die Übergabe einer nicht vorhandenen Geräte-ID führt zu einem Fehler.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    ()=>void

Rückgaben

  • Promise<void>

    Chrome 116 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

setMute()

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

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

Parameters

  • streamType

    StreamType

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

  • isMuted

    boolean

    Neuer Wert für die Stummschaltung.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    ()=>void

Rückgaben

  • Promise<void>

    Chrome 116 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

setProperties()

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

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

Parameters

  • id

    String

  • Properties

    DeviceProperties

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    ()=>void

Rückgaben

  • Promise<void>

    Chrome 116 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

Veranstaltungen

onDeviceListChanged

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

Wird ausgelöst, wenn Audiogeräte geändert werden, weil entweder neue Geräte hinzugefügt oder vorhandene Geräte entfernt werden

Parameters

onLevelChanged

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

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

Parameters

onMuteChanged

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

Wird ausgelöst, wenn sich die Stummschaltung der Audioeingabe oder -ausgabe ändert Hinweis: Stummschaltung gilt systemweit und der neue Wert gilt für alle Audiogeräte mit einem bestimmten Streamtyp.

Parameters