browser.audio

Beschreibung

Die chrome.audio API wird bereitgestellt, damit Nutzer Informationen zu den mit dem System verbundenen Audiogeräten abrufen und diese steuern können. Diese API ist derzeit nur im Kioskmodus für ChromeOS verfügbar.

Berechtigungen

audio

Verfügbarkeit

Chrome 59 oder höher browser.* seit Chrome 148 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 Geräuschpegel des Geräts, die Lautstärke für die Ausgabe und die Verstärkung für die Eingabe.

  • stableDeviceId

    String optional

    Der String der stabilen/gespeicherten Geräte-ID, falls verfügbar.

  • streamType

    StreamType

    Mit diesem Gerät verknüpfter Streamtyp.

DeviceFilter

Attribute

  • isActive (Aktiv)

    Boolesch optional

    Wenn diese Option festgelegt ist, erfüllen nur Audiogeräte, deren aktiver Status mit diesem Wert übereinstimmt, den Filter.

  • streamTypes

    StreamType[] optional

    Wenn diese Option festgelegt ist, werden nur Audiogeräte, deren Streamtyp in dieser Liste enthalten ist, vom Filter berücksichtigt.

DeviceIdLists

Attribute

  • Eingabe

    string[] optional

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

    Wenn Eingabegeräte nicht betroffen sein sollen, lassen Sie dieses Attribut leer.

  • Ausgabe

    string[] optional

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

    Wenn Ausgabegeräte nicht betroffen sein sollen, lassen Sie dieses Attribut 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.

    Bei Verwendung mit einem Audioeingabegerät wird die Verstärkung des Audiogeräts dargestellt.

    Bei Verwendung mit einem Audioausgabegerät wird die Lautstärke des Audiogeräts dargestellt.

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 Lautstärkepegel 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

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

Enum

"INPUT"

"OUTPUT"

Methoden

getDevices()

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

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

Parameter

  • Filter

    DeviceFilter optional

    Geräteeigenschaften, 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.

Ausgabe

  • Promise<AudioDeviceInfo[]>

    Chrome 116 und höher browser.* seit Chrome 148

    Gibt die angeforderte Liste der Audiogeräte zurück.

getMute()

browser.audio.getMute(
  streamType: StreamType,
): Promise<boolean>

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

Parameter

  • streamType

    StreamType

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

Ausgabe

  • Promise<boolean>

    Chrome 116 und höher browser.* seit Chrome 148

    Promise, das mit einem booleschen Wert aufgelöst wird, der angibt, ob die Stummschaltung für den angegebenen Streamtyp festgelegt ist oder nicht.

setActiveDevices()

browser.audio.setActiveDevices(
  ids: DeviceIdLists,
): Promise<void>

Legt Listen der aktiven 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.

    Die Übergabe einer nicht vorhandenen Geräte-ID ist ein Fehler.

Ausgabe

  • Promise<void>

    Chrome 116 und höher browser.* seit Chrome 148

setMute()

browser.audio.setMute(
  streamType: StreamType,
  isMuted: boolean,
): Promise<void>

Legt den Stummschaltungsstatus für einen Streamtyp fest. 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 Wert für die Stummschaltung.

Ausgabe

  • Promise<void>

    Chrome 116 und höher browser.* seit Chrome 148

setProperties()

browser.audio.setProperties(
  id: string,
  properties: DeviceProperties,
): Promise<void>

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

Parameter

Ausgabe

  • Promise<void>

    Chrome 116 und höher browser.* seit Chrome 148

Ereignisse

onDeviceListChanged

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

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

Parameter

onLevelChanged

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

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

Parameter

onMuteChanged

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

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

Parameter