Beschrijving
De chrome.audio API wordt geleverd zodat gebruikers informatie kunnen krijgen over de audioapparaten die aan het systeem zijn gekoppeld en deze kunnen bedienen. Deze API is op dit moment alleen beschikbaar in de kioskmodus voor ChromeOS.
Rechten
audioBeschikbaarheid
Typen
AudioDeviceInfo
Eigenschappen
-
deviceName
tekenreeks
Apparaatnaam.
-
deviceType
Type apparaat.
-
displayName
tekenreeks
De gebruiksvriendelijke naam (bijvoorbeeld USB-microfoon).
-
id
tekenreeks
De unieke ID van het audioapparaat.
-
isActive
booleaans
Waar als dit het huidige actieve apparaat is.
-
level
getal
Het geluidsniveau van het apparaat, het volume voor uitvoer, de versterking voor invoer.
-
stableDeviceId
tekenreeks optioneel
De stabiele/permanente apparaat-ID-tekenreeks, indien beschikbaar.
-
streamType
Het streamtype dat aan dit apparaat is gekoppeld.
DeviceFilter
Eigenschappen
-
isActive
booleaans optioneel
Als deze optie is ingesteld, voldoen alleen audioapparaten waarvan de actieve status overeenkomt met deze waarde aan het filter.
-
streamTypes
StreamType[] optioneel
Als je dit beleid instelt, voldoen alleen audioapparaten waarvan het streamtype in deze lijst is opgenomen aan het filter.
DeviceIdLists
Eigenschappen
-
invoer
string[] optioneel
Lijst met invoerapparaten, gespecificeerd op basis van hun ID.
Laat deze property oningesteld als je wilt dat invoerapparaten niet worden beïnvloed.
-
uitvoer
string[] optioneel
Lijst met uitvoerapparaten die worden aangegeven met hun ID.
Laat deze eigenschap oningesteld om aan te geven dat uitvoerapparaten niet moeten worden beïnvloed.
DeviceProperties
Eigenschappen
-
level
number optioneel
Het gewenste geluidsniveau van het audioapparaat. Standaard is dit het huidige geluidsniveau van het apparaat.
Als dit wordt gebruikt met een audio-invoerapparaat, staat dit voor de versterking van het audioapparaat.
Als deze wordt gebruikt met een audio-uitvoerapparaat, staat deze voor het volume van het audioapparaat.
DeviceType
Beschikbare typen audioapparaten.
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
Eigenschappen
-
deviceId
tekenreeks
ID van het apparaat waarvan het geluidsniveau is gewijzigd.
-
level
getal
Het nieuwe geluidsniveau van het apparaat.
MuteChangedEvent
Eigenschappen
-
isMuted
booleaans
Of de stream nu is gedempt.
-
streamType
Het type stream waarvoor de waarde voor dempen is gewijzigd. De geüpdatete waarde voor dempen is van toepassing op alle apparaten met dit streamtype.
StreamType
Het type stream dat een audioapparaat biedt.
Enum
"INPUT"
"OUTPUT"
Methoden
getDevices()
browser.audio.getDevices(
filter?: DeviceFilter,
): Promise<AudioDeviceInfo[]>
Haalt een lijst met audioapparaten op die zijn gefilterd op basis van filter.
Parameters
-
filter
DeviceFilter optioneel
Apparaateigenschappen waarop je de lijst met geretourneerde audioapparaten wilt filteren. Als het filter niet is ingesteld of is ingesteld op
{}, bevat de geretourneerde apparaatlijst alle beschikbare audioapparaten.
Retourzendingen
-
Promise<AudioDeviceInfo[]>
Chrome 116+ browser.* sinds Chrome 148Rapporteert de gevraagde lijst met audioapparaten.
getMute()
browser.audio.getMute(
streamType: StreamType,
): Promise<boolean>
Haalt de systeembrede dempingsstatus op voor het aangegeven streamtype.
Parameters
-
streamType
Streamtype waarvoor de dempingsstatus moet worden opgehaald.
Retourzendingen
-
Promise<boolean>
Chrome 116+ browser.* sinds Chrome 148Promise die wordt opgelost met een booleaanse waarde die aangeeft of dempen is ingesteld voor het aangegeven streamtype.
setActiveDevices()
browser.audio.setActiveDevices(
ids: DeviceIdLists,
): Promise<void>
Hiermee stel je lijsten met actieve invoer- en/of uitvoerapparaten in.
Parameters
-
ID's
Hiermee geef je de ID's op van apparaten die actief moeten zijn. Als de invoer- of uitvoerlijst niet is ingesteld, heeft dit geen invloed op apparaten in die categorie.
Het is een fout om een niet-bestaande apparaat-ID door te geven.
Retourzendingen
-
Promise<void>
Chrome 116+ browser.* sinds Chrome 148
setMute()
browser.audio.setMute(
streamType: StreamType,
isMuted: boolean,
): Promise<void>
Stelt de dempingsstatus in voor een streamtype. De dempingsstatus wordt toegepast op alle audioapparaten met het aangegeven type audiostream.
Parameters
-
streamType
Streamtype waarvoor de dempstatus moet worden ingesteld.
-
isMuted
booleaans
Nieuwe waarde voor geluid uitzetten.
Retourzendingen
-
Promise<void>
Chrome 116+ browser.* sinds Chrome 148
setProperties()
browser.audio.setProperties(
id: string,
properties: DeviceProperties,
): Promise<void>
Hiermee stel je de eigenschappen voor het invoer- of uitvoerapparaat in.
Parameters
-
id
tekenreeks
-
property's
Retourzendingen
-
Promise<void>
Chrome 116+ browser.* sinds Chrome 148
Evenementen
onDeviceListChanged
browser.audio.onDeviceListChanged.addListener(
callback: function,
)
Wordt geactiveerd als audioapparaten veranderen, of er nu nieuwe apparaten worden toegevoegd of bestaande apparaten worden verwijderd.
Parameters
-
callback
functie
De parameter
callbackziet er zo uit:(devices: AudioDeviceInfo[]) => void
-
apparaten
-
onLevelChanged
browser.audio.onLevelChanged.addListener(
callback: function,
)
Wordt geactiveerd als het geluidsniveau verandert voor een actief audioapparaat.
Parameters
-
callback
functie
De parameter
callbackziet er zo uit:(event: LevelChangedEvent) => void
-
gebeurtenis
-
onMuteChanged
browser.audio.onMuteChanged.addListener(
callback: function,
)
Wordt geactiveerd als de dempingsstatus van de audio-invoer of -uitvoer verandert. De dempingsstatus is systeembreed en de nieuwe waarde is van toepassing op elk audioapparaat met het opgegeven streamtype.
Parameters
-
callback
functie
De parameter
callbackziet er zo uit:(event: MuteChangedEvent) => void
-
gebeurtenis
-