chrome.audio

Opis

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

Uprawnienia

audio

Dostępność

Chrome 59 i nowsze Tylko w systemie 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

    Prawda, jeśli jest to aktualnie aktywne urządzenie.

  • poziom

    liczba

    Poziom głośności urządzenia, głośność wyjścia, wzmocnienie wejścia.

  • stableDeviceId

    ciąg znaków opcjonalny

    Stabilny/trwały ciąg znaków identyfikatora urządzenia (jeśli jest dostępny).

  • streamType

    StreamType

    Typ strumienia powiązany z tym urządzeniem.

DeviceFilter

Właściwości

  • isActive

    logiczna opcjonalna

    Jeśli jest ustawiony, filtr będzie uwzględniał tylko urządzenia audio, których aktywny stan jest zgodny z tą wartością.

  • streamTypes

    StreamType[] opcjonalnie

    Jeśli to ustawienie jest włączone, filtr będzie uwzględniał tylko urządzenia audio, których typ strumienia znajduje się na tej liście.

DeviceIdLists

Właściwości

  • dane wejściowe

    string[] opcjonalnie

    Lista urządzeń wejściowych z ich identyfikatorami.

    Aby wskazać, że urządzenia wejściowe nie powinny być objęte działaniem tej właściwości, pozostaw ją niezaznaczoną.

  • output

    string[] opcjonalnie

    Lista urządzeń wyjściowych z ich identyfikatorami.

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

DeviceProperties

Właściwości

  • poziom

    number opcjonalny

    Żądany poziom głośności urządzenia audio. Domyślnie jest to bieżący poziom głośności 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

"HEADPHONE"

„MIC”

„USB”

"BLUETOOTH"

"HDMI"

"INTERNAL_SPEAKER"

"INTERNAL_MIC"

"FRONT_MIC"

"REAR_MIC"

"KEYBOARD_MIC"

"SŁOWO KLUCZOWE"

"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 głośności uległ zmianie.

  • poziom

    liczba

    Nowy poziom głośności urządzenia.

MuteChangedEvent

Właściwości

  • isMuted

    wartość logiczna

    Określa, czy strumień jest obecnie wyciszony.

  • streamType

    StreamType

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

StreamType

Typ strumienia udostępnianego przez urządzenie audio.

Typ wyliczeniowy

"INPUT"

"WYJŚCIE"

Metody

getDevices()

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

Pobiera listę urządzeń audio filtrowanych 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.

  • wywołanie zwrotne

    function opcjonalny

    Parametr callback ma postać:

    (devices: AudioDeviceInfo[]) => void

Zwroty

  • Promise<AudioDeviceInfo[]>

    Chrome w wersji 116 lub nowszej

    Obietnice są obsługiwane w pliku manifestu w wersji 3 i późniejszych, ale wywołania zwrotne są dostępne ze względu na zgodność wsteczną. Nie możesz używać obu w tym samym wywołaniu funkcji. Obiet na obietnice zwracany jest z tym samym typem, który jest przekazywany do funkcji zwracającej wywołanie zwrotne.

getMute()

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

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

Parametry

  • streamType

    StreamType

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

  • wywołanie zwrotne

    function opcjonalny

    Parametr callback ma postać:

    (value: boolean) => void

    • wartość

      wartość logiczna

Zwroty

  • Promise<boolean>

    Chrome w wersji 116 lub nowszej

    Obietnice są obsługiwane w pliku manifestu w wersji 3 i późniejszych, ale wywołania zwrotne są dostępne ze względu na zgodność wsteczną. Nie możesz używać obu w tym samym wywołaniu funkcji. Obiet na obietnice zwracany jest z tym samym typem, który jest przekazywany do funkcji zwracającej wywołanie zwrotne.

setActiveDevices()

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

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

Parametry

  • Określa identyfikatory urządzeń, które powinny być aktywne. Jeśli lista wejściowa lub wyjściowa nie jest skonfigurowana, nie ma to wpływu na urządzenia w tej kategorii.

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

  • wywołanie zwrotne

    function opcjonalny

    Parametr callback ma postać:

    () => void

Zwroty

  • Obietnica<void>

    Chrome 116 lub nowszy

    Obietnice są obsługiwane w pliku manifestu w wersji 3 i późniejszych, ale wywołania zwrotne są dostępne ze względu na zgodność wsteczną. Nie możesz używać obu w tym samym wywołaniu funkcji. Obiet na obietnice zwracany jest z tym samym typem, który jest przekazywany do funkcji zwracającej wywołanie zwrotne.

setMute()

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

Ustawia stan wyciszenia dla typu strumienia. Stan wyciszenia będzie dotyczył wszystkich urządzeń audio z określonym typem strumienia audio.

Parametry

  • streamType

    StreamType

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

  • isMuted

    wartość logiczna

    Nowa wartość wyciszenia.

  • wywołanie zwrotne

    function opcjonalny

    Parametr callback ma postać:

    () => void

Zwroty

  • Obietnica<void>

    Chrome 116 lub nowszy

    Obietnice są obsługiwane w pliku manifestu w wersji 3 i późniejszych, ale wywołania zwrotne są dostępne ze względu na zgodność wsteczną. Nie możesz używać obu w tym samym wywołaniu funkcji. Obiet na obietnice zwracany jest z tym samym typem, który jest przekazywany do funkcji zwracającej wywołanie zwrotne.

setProperties()

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

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

Parametry

  • id

    ciąg znaków

  • wywołanie zwrotne

    function opcjonalny

    Parametr callback ma postać:

    () => void

Zwroty

  • Obietnica<void>

    Chrome 116 lub nowszy

    Obietnice są obsługiwane w pliku manifestu w wersji 3 i późniejszych, ale wywołania zwrotne są dostępne ze względu na zgodność wsteczną. Nie możesz używać obu w tym samym wywołaniu funkcji. Obiet na obietnice zwracany jest z tym samym typem, który jest przekazywany do funkcji zwracającej wywołanie zwrotne.

Wydarzenia

onDeviceListChanged

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

Wywoływany, gdy zmieniają się urządzenia audio, czyli gdy dodano nowe urządzenia lub usunięto istniejące.

Parametry

onLevelChanged

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

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

Parametry

onMuteChanged

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

Wywoływane, gdy stan wyciszenia wejścia lub wyjścia dźwięku ulegnie zmianie. Pamiętaj, że wyciszenie jest ustawieniem systemowym, a nowa wartość ma zastosowanie do wszystkich urządzeń audio z określonym typem strumienia.

Parametry