chrome.audio

Beschreibung

Die chrome.audio API ermöglicht es Nutzern, Informationen zu den an das 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 Schallpegel 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)

    boolean optional

    Wenn dieser Wert festgelegt ist, werden nur Audiogeräte, deren aktiver Status mit diesem Wert übereinstimmt, vom Filter berücksichtigt.

  • streamTypes

    StreamType[] optional

    Wenn diese Option festgelegt 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 durch ihre ID angegeben werden.

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

  • output

    string[] optional

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

    Wenn Ausgabegeräte nicht betroffen sein sollen, lassen Sie diese Eigenschaft 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 sie mit einem Audioeingabegerät verwendet wird, stellt sie die Verstärkung des Audiogeräts dar.

    Wenn sie mit einem Audioausgabegerät verwendet wird, stellt sie die Lautstärke des Audiogeräts dar.

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"

"OTHER"

LevelChangedEvent

Attribute

  • deviceId

    String

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

  • Level

    Zahl

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

StreamType

Typ des Streams, den ein Audiogerät bereitstellt.

Enum

"INPUT"

"OUTPUT"

Methoden

getDevices()

Promise 
chrome.audio.getDevices(
  filter?: DeviceFilter,
  callback?: function,
): Promise<AudioDeviceInfo[]>

Ruft eine Liste von Audiogeräten ab, die nach filter gefiltert werden.

Parameter

  • filtern

    DeviceFilter optional

    Geräteattribute, nach denen die Liste der zurückgegebenen Audiogeräte gefiltert werden soll. 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

Ausgabe

  • Promise<AudioDeviceInfo[]>

    Chrome 116 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

getMute()

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

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: 

    (value: boolean) => void

    • Wert

      boolean

Ausgabe

  • Promise<boolean>

    Chrome 116 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

setActiveDevices()

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

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

Parameter

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

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

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Ausgabe

  • Promise<void>

    Chrome 116 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

setMute()

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

Legt den Stummschaltungsstatus für einen Streamtyp fest. Der Stummschaltungsstatus wird auf alle Audiogeräte mit dem angegebenen Audiostreamtyp angewendet.

Parameter

  • streamType

    StreamType

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

  • isMuted

    boolean

    Neuer Wert für die Stummschaltung.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Ausgabe

  • Promise<void>

    Chrome 116 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

setProperties()

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

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

Parameter

  • id

    String

  • Properties

    DeviceProperties

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Ausgabe

  • Promise<void>

    Chrome 116 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

Ereignisse

onDeviceListChanged

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

Wird ausgelöst, wenn sich Audiogeräte ändern, entweder durch Hinzufügen neuer Geräte oder Entfernen vorhandener Geräte.

Parameter

onLevelChanged

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

Wird ausgelöst, wenn sich der Schallpegel für ein aktives Audiogerät ändert.

Parameter

onMuteChanged

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

Wird ausgelöst, wenn sich der Stummschaltungsstatus der Audioeingabe oder ‑ausgabe ändert. Der Stummschaltungsstatus gilt systemweit und der neue Wert wird auf jedes Audiogerät mit dem angegebenen Streamtyp angewendet.

Parameter