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ść
Typy
AudioDeviceInfo
Właściwości
-
deviceName
string,
Nazwa urządzenia.
-
deviceType
Typ urządzenia.
-
displayName
string,
Przyjazna dla użytkownika nazwa (np. „Mikrofon USB”).
-
id
string,
Unikalny identyfikator urządzenia audio.
-
isActive
boolean
Prawda, jeśli jest to obecnie aktywne urządzenie.
-
poziom
Liczba
Poziom dźwięku urządzenia, głośność wyjścia, wzmocnienie na wejściu.
-
stableDeviceId
ciąg znaków opcjonalny
Stabilny/trwały ciąg identyfikatora urządzenia, jeśli jest dostępny.
-
streamType
Typ strumienia powiązany z tym urządzeniem.
DeviceFilter
Właściwości
-
isActive
wartość logiczna opcjonalna
Jeśli zasada jest skonfigurowana, filtr będzie spełniać tylko te urządzenia audio, których stan aktywności pasuje do tej wartości.
-
streamTypes
StreamType[] opcjonalny
Jeśli zasada jest skonfigurowana, filtr będzie spełniać tylko urządzenia audio, których typ strumienia znajduje się na tej liście.
DeviceIdLists
Właściwości
-
dane wejściowe
string[] opcjonalny
Lista urządzeń wejściowych określonych za pomocą identyfikatorów.
Aby wskazać, że ta właściwość nie ma wpływu na urządzenia wejściowe, pozostaw tę właściwość nieskonfigurowaną.
-
wynik
string[] opcjonalny
Lista urządzeń wyjściowych określonych za pomocą identyfikatorów.
Aby wskazać, że ta właściwość nie ma 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 urządzenia audio. Domyślnie jest to bieżący poziom dźwięku urządzenia.
Jeśli jest używany z wejściem 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.
Enum
LevelChangedEvent
Właściwości
-
deviceId
string,
Identyfikator urządzenia, którego poziom dźwięku się zmienił.
-
poziom
Liczba
Nowy poziom dźwięku na urządzeniu.
MuteChangedEvent
Właściwości
-
isMuted
boolean
Wskazuje, czy strumień jest teraz wyciszony.
-
streamType
Rodzaj strumienia, którego wartość wyciszenia została zmieniona. Zaktualizowana wartość wyciszenia dotyczy wszystkich urządzeń z tym typem strumienia.
StreamType
Rodzaj strumienia dostarczanego przez urządzenie audio.
Enum
Metody
getDevices()
chrome.audio.getDevices(
filter?: DeviceFilter,
callback?: function,
)
Pobiera listę urządzeń audio przefiltrowanych na podstawie: filter
.
Parametry
-
filter
Opcjonalny DeviceFilter
Właściwości urządzenia służące do filtrowania listy 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 opcjonalnie
Parametr
callback
wygląda tak:(devices: AudioDeviceInfo[]) => void
-
urządzenia
-
Akcje powrotne
-
Promise<AudioDeviceInfo[]>
Chrome 116 i nowsze wersjeObietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.
getMute()
chrome.audio.getMute(
streamType: StreamType,
callback?: function,
)
Pobiera stan wyciszenia w całym systemie dla określonego typu strumienia.
Parametry
-
streamType
Typ strumienia, dla którego ma być pobierany stan wyciszenia.
-
wywołanie zwrotne
funkcja opcjonalnie
Parametr
callback
wygląda tak:(value: boolean) => void
-
value
boolean
-
Akcje powrotne
-
Promise<boolean>
Chrome 116 i nowsze wersjeObietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.
setActiveDevices()
chrome.audio.setActiveDevices(
ids: DeviceIdLists,
callback?: function,
)
Ustawia listę aktywnych urządzeń wejściowych i wyjściowych.
Parametry
-
ids
Określa identyfikatory urządzeń, które powinny być aktywne. Jeśli lista danych wejściowych lub wyjściowych nie jest skonfigurowana, nie ma to wpływu na urządzenia w danej kategorii.
Przesłanie nieistniejącego identyfikatora urządzenia to błąd.
-
wywołanie zwrotne
funkcja opcjonalnie
Parametr
callback
wygląda tak:() => void
Akcje powrotne
-
Promise<void>
Chrome 116 i nowsze wersjeObietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.
setMute()
chrome.audio.setMute(
streamType: StreamType,
isMuted: boolean,
callback?: function,
)
Określa stan wyciszenia danego typu transmisji. Stan wyciszenia będzie stosowany do wszystkich urządzeń audio określonego typu strumienia.
Parametry
-
streamType
Typ strumienia, dla którego należy ustawić stan wyciszenia.
-
isMuted
boolean
Nowa wartość ignorowania.
-
wywołanie zwrotne
funkcja opcjonalnie
Parametr
callback
wygląda tak:() => void
Akcje powrotne
-
Promise<void>
Chrome 116 i nowsze wersjeObietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.
setProperties()
chrome.audio.setProperties(
id: string,
properties: DeviceProperties,
callback?: function,
)
Ustawia właściwości urządzenia wejściowego lub wyjściowego.
Parametry
-
id
string,
-
usługi
-
wywołanie zwrotne
funkcja opcjonalnie
Parametr
callback
wygląda tak:() => void
Akcje powrotne
-
Promise<void>
Chrome 116 i nowsze wersjeObietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.
Wydarzenia
onDeviceListChanged
chrome.audio.onDeviceListChanged.addListener(
callback: function,
)
Uruchamiane, gdy urządzenia audio ulegną zmianie, np. w przypadku dodania nowych lub usunięcia istniejących urządzeń.
Parametry
-
wywołanie zwrotne
funkcja
Parametr
callback
wygląda tak:(devices: AudioDeviceInfo[]) => void
-
urządzenia
-
onLevelChanged
chrome.audio.onLevelChanged.addListener(
callback: function,
)
Uruchamiane, gdy poziom dźwięku zmieni się dla aktywnego urządzenia audio.
Parametry
-
wywołanie zwrotne
funkcja
Parametr
callback
wygląda tak:(event: LevelChangedEvent) => void
-
event
-
onMuteChanged
chrome.audio.onMuteChanged.addListener(
callback: function,
)
Uruchamiane po zmianie stanu 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 o określonym typie strumienia.
Parametry
-
wywołanie zwrotne
funkcja
Parametr
callback
wygląda tak:(event: MuteChangedEvent) => void
-
event
-