chrome.audio

Opis

Interfejs chrome.audio API umożliwia użytkownikom uzyskiwanie informacji o urządzeniach audio podłączonych do systemu i sterowanie nimi. Ten interfejs API jest obecnie dostępny tylko w trybie kiosku w ChromeOS.

Uprawnienia

audio

Dostępność

Chrome 59 lub nowszy Tylko ChromeOS

Typy

AudioDeviceInfo

Właściwości

  • deviceName

    ciąg znaków

    Nazwa urządzenia.

  • deviceType

    DeviceType

    Typ urządzenia.

  • wyświetlanaNazwa

    ciąg znaków

    Przyjazna dla użytkownika nazwa (np. „Mikrofon USB”).

  • id

    ciąg znaków

    Unikalny identyfikator urządzenia audio.

  • isActive

    Wartość logiczna

    Wartość „true”, jeśli jest to obecnie aktywne urządzenie.

  • poziom

    liczba

    Poziom dźwięku urządzenia, głośność wyjściowa i wzmocnienie wejściowe.

  • stableDeviceId

    string opcjonalny

    Ciąg identyfikatora urządzenia trwałego, jeśli jest dostępny.

  • streamType

    StreamType

    Typ strumienia powiązany z tym urządzeniem.

DeviceFilter

Właściwości

  • isActive

    wartość logiczna opcjonalna

    Jeśli ta opcja jest ustawiona, filtr spełniają tylko urządzenia audio, których stan aktywności jest zgodny z tą wartością.

  • streamTypes

    StreamType[] opcjonalnie

    Jeśli to ustawienie jest włączone, filtr będzie spełniony tylko w przypadku urządzeń audio, których typ strumienia znajduje się na tej liście.

DeviceIdLists

Właściwości

  • dane wejściowe

    string[] opcjonalne

    Lista urządzeń wejściowych określonych przez ich identyfikatory.

    Aby wskazać, że urządzenia wejściowe nie powinny być objęte zmianami, pozostaw tę właściwość bez ustawienia.

  • output

    string[] opcjonalne

    Lista urządzeń wyjściowych określonych za pomocą identyfikatora.

    Aby wskazać, że urządzenia wyjściowe nie powinny być zmieniane, pozostaw tę właściwość bez ustawienia.

DeviceProperties

Właściwości

  • poziom

    number opcjonalny

    Żądany poziom dźwięku urządzenia audio. Domyślnie jest to bieżący poziom dźwięku urządzenia.

    Jeśli jest używany z urządzeniem wejściowym audio, reprezentuje wzmocnienie urządzenia audio.

    Jeśli jest używany z urządzeniem wyjściowym audio, reprezentuje głośność urządzenia audio.

DeviceType

Dostępne typy urządzeń audio.

Typ wyliczeniowy

„SŁUCHAWKI”

„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

Właściwości

  • deviceId

    ciąg znaków

    Identyfikator urządzenia, którego poziom dźwięku uległ zmianie.

  • poziom

    liczba

    Nowy poziom dźwięku urządzenia.

MuteChangedEvent

Właściwości

  • isMuted

    Wartość logiczna

    Określa, czy strumień jest teraz wyciszony.

  • streamType

    StreamType

    Typ strumienia, dla którego zmieniono wartość wyciszenia. Zaktualizowana wartość wyciszenia jest stosowana do wszystkich urządzeń z tym typem strumienia.

StreamType

Typ strumienia, który zapewnia urządzenie audio.

Typ wyliczeniowy

„INPUT”

„OUTPUT”

Metody

getDevices()

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

Pobiera listę urządzeń audio filtrowaną na podstawie filter.

Parametry

  • filtr

    DeviceFilter opcjonalny

    Właściwości urządzenia, według których można filtrować listę zwróconych urządzeń audio. Jeśli filtr nie jest skonfigurowany lub ma wartość {}, zwrócona lista urządzeń będzie zawierać wszystkie dostępne urządzenia audio.

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    (devices: AudioDeviceInfo[]) => void

Zwroty

  • Promise<AudioDeviceInfo[]>

    Chrome 116 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

getMute()

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

Pobiera stan wyciszenia w całym systemie dla określonego typu strumienia.

Parametry

  • streamType

    StreamType

    Typ strumienia, dla którego należy pobrać stan wyciszenia.

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    (value: boolean) => void

    • wartość

      Wartość logiczna

Zwroty

  • Promise<boolean>

    Chrome 116 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

setActiveDevices()

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

Ustawia listy aktywnych urządzeń wejściowych lub wyjściowych.

Parametry

  • identyfikatory,

    DeviceIdLists

    Określa identyfikatory urządzeń, które mają być aktywne. Jeśli lista wejściowa lub wyjściowa nie jest skonfigurowana, urządzenia z danej kategorii nie będą objęte zmianami.

    Przekazanie nieistniejącego identyfikatora urządzenia jest błędem.

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    () => void

Zwroty

  • Promise<void>

    Chrome 116 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

setMute()

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

Ustawia stan wyciszenia dla typu strumienia. Stan wyciszenia zostanie zastosowany do wszystkich urządzeń audio z określonym typem strumienia audio.

Parametry

  • streamType

    StreamType

    Typ strumienia, dla którego ma zostać ustawiony stan wyciszenia.

  • isMuted

    Wartość logiczna

    Nowa wartość wyciszenia.

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    () => void

Zwroty

  • Promise<void>

    Chrome 116 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

setProperties()

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

Ustawia właściwości urządzenia wejściowego lub wyjściowego.

Parametry

  • id

    ciąg znaków

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    () => void

Zwroty

  • Promise<void>

    Chrome 116 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

Wydarzenia

onDeviceListChanged

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

Wywoływane, gdy zmieniają się urządzenia audio, np. gdy dodawane są nowe urządzenia lub usuwane są istniejące.

Parametry

onLevelChanged

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

Wysyłane, gdy zmieni się poziom dźwięku na aktywnym urządzeniu audio.

Parametry

onMuteChanged

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

Wywoływane, gdy zmieni się stan wyciszenia wejścia lub wyjścia audio. Pamiętaj, że stan wyciszenia jest ustawieniem systemowym, a nowa wartość ma zastosowanie do każdego urządzenia audio z określonym typem strumienia.

Parametry