chrome.audio

.

Opis

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

Uprawnienia

audio

Dostępność

Chrome w wersji 59 lub nowszej 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

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

  • poziom

    liczba

    Poziom dźwięku urządzenia, głośność na wyjściu, wzmocnienie dla wejścia.

  • stableDeviceId

    ciąg znaków opcjonalny

    Stabilny/trwały ciąg identyfikatora urządzenia, 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 jest ustawiony, filtr spełniają tylko te urządzenia audio, których stan aktywności odpowiada tej wartości.

  • streamTypes

    StreamType[] opcjonalny

    Jeśli jest ustawiony, filtr spełniają 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 określonych za pomocą identyfikatorów.

    Aby wskazać, że nie powinno to mieć wpływu na urządzenia wejściowe, pozostaw tę właściwość nieskonfigurowaną.

  • output

    string[] opcjonalnie

    Lista urządzeń wyjściowych określonych za pomocą ich identyfikatorów.

    Aby wskazać, że nie powinno to mieć wpływu na urządzenia wyjściowe, pozostaw tę właściwość nieskonfigurowaną.

DeviceProperties

Właściwości

  • poziom

    liczba opcjonalnie

    Poziom dźwięku wybrany przez urządzenie audio. Domyślnie ustawiany jest obecny poziom dźwięku urządzenia.

    Jeśli jest używana z wejściem audio, reprezentuje wzmocnienie urządzenia audio.

    Jeśli jest używany z urządzeniem wyjściowym audio, reprezentuje poziom głośności 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"

"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 się zmienił.

  • 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, w przypadku którego zmieniono wartość wyciszenia. Zaktualizowana wartość wyciszenia dotyczy wszystkich urządzeń z tym typem strumienia.

StreamType

Typ strumienia dostarczanego przez urządzenie audio.

Typ wyliczeniowy

"INPUT"

"OUTPUT"

Metody

getDevices()

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

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

Parametry

  • filtr

    Opcjonalne DeviceFilter

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

  • wywołanie zwrotne

    funkcja optional

    Parametr callback wygląda tak: 

    (devices: AudioDeviceInfo[]) => void

Zwroty

  • Promise<AudioDeviceInfo[]>

    Chrome 116 lub nowszy .

    Obietnice są obsługiwane w Manifest V3 i nowszych, ale wywołania zwrotne są podane w przypadku zgodność wsteczną. Nie można użyć obu w tym samym wywołaniu funkcji. Polecenie promowana jest realizowane z tym samym typem, który jest przekazywany do wywołania zwrotnego.

getMute()

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

Pobiera systemowy stan wyciszenia określonego typu strumienia.

Parametry

  • streamType

    StreamType

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

  • wywołanie zwrotne

    funkcja optional

    Parametr callback wygląda tak: 

    (value: boolean) => void

    • wartość

      wartość logiczna

Zwroty

  • Promise<boolean>

    Chrome 116 lub nowszy .

    Obietnice są obsługiwane w Manifest V3 i nowszych, ale wywołania zwrotne są podane w przypadku zgodność wsteczną. Nie można użyć obu w tym samym wywołaniu funkcji. Polecenie promowana jest realizowane z tym samym typem, który jest przekazywany do wywołania zwrotnego.

setActiveDevices()

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

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

Parametry

  • identyfikatory

    DeviceIdLists

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

    Przekazywanie nieistniejącego identyfikatora urządzenia powoduje błąd.

  • wywołanie zwrotne

    funkcja optional

    Parametr callback wygląda tak: 

    () => void

Zwroty

  • Obietnica<void>

    Chrome 116 lub nowszy .

    Obietnice są obsługiwane w Manifest V3 i nowszych, ale wywołania zwrotne są podane w przypadku zgodność wsteczną. Nie można użyć obu w tym samym wywołaniu funkcji. Polecenie promowana jest realizowane z tym samym typem, który jest przekazywany do wywołania zwrotnego.

setMute()

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

Ustawia stan wyciszenia dla danego 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 należy ustawić stan wyciszenia.

  • isMuted

    wartość logiczna

    Nowa wartość wyciszenia.

  • wywołanie zwrotne

    funkcja optional

    Parametr callback wygląda tak: 

    () => void

Zwroty

  • Obietnica<void>

    Chrome 116 lub nowszy .

    Obietnice są obsługiwane w Manifest V3 i nowszych, ale wywołania zwrotne są podane w przypadku zgodność wsteczną. Nie można użyć obu w tym samym wywołaniu funkcji. Polecenie promowana jest realizowane z tym samym typem, który jest przekazywany do wywołania zwrotnego.

setProperties()

Obietnica .
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

    funkcja optional

    Parametr callback wygląda tak: 

    () => void

Zwroty

  • Obietnica<void>

    Chrome 116 lub nowszy .

    Obietnice są obsługiwane w Manifest V3 i nowszych, ale wywołania zwrotne są podane w przypadku zgodność wsteczną. Nie można użyć obu w tym samym wywołaniu funkcji. Polecenie promowana jest realizowane z tym samym typem, który jest przekazywany do wywołania zwrotnego.

Wydarzenia

onDeviceListChanged

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

Uruchamiane, gdy zmienią się urządzenia audio albo zostaną dodane nowe lub istniejące urządzenia.

Parametry

onLevelChanged

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

Uruchamiane, gdy zmieni się poziom dźwięku aktywnego urządzenia audio.

Parametry

onMuteChanged

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

Uruchamiane, gdy zmieni się stan wyciszenia wejścia lub wyjścia audio. Pamiętaj, że stan wyciszenia dotyczy całego systemu, a nowa wartość dotyczy każdego urządzenia audio z określonym typem strumienia.

Parametry