chroom.audio

Beschrijving

De chrome.audio API is bedoeld om gebruikers in staat te stellen informatie te verkrijgen over de audioapparaten die op het systeem zijn aangesloten en deze te bedienen. Deze API is momenteel alleen beschikbaar in kioskmodus voor ChromeOS.

Rechten

audio

Beschikbaarheid

AlleenChrome 59+ ChromeOS

Soorten

AudioDeviceInfo

Eigenschappen

  • toestelnaam

    snaar

    Toestelnaam.

  • soort apparaat

    Soort apparaat

    Type apparaat.

  • Weergavenaam

    snaar

    De gebruiksvriendelijke naam (bijvoorbeeld "USB-microfoon").

  • ID kaart

    snaar

    De unieke identificatie van het audioapparaat.

  • is actief

    Booleaans

    Waar als dit het huidige actieve apparaat is.

  • niveau

    nummer

    Het geluidsniveau van het apparaat, volume voor uitvoer, versterking voor invoer.

  • stableDeviceId

    tekenreeks optioneel

    De stabiele/aanhoudende apparaat-id-tekenreeks, indien beschikbaar.

  • streamType

    Streamtype

    Streamtype dat aan dit apparaat is gekoppeld.

DeviceFilter

Eigenschappen

  • is actief

    Booleaans optioneel

    Indien ingesteld, voldoen alleen audioapparaten waarvan de actieve status overeenkomt met deze waarde aan het filter.

  • streamTypen

    StreamType [] optioneel

    Indien ingesteld, zullen alleen audioapparaten waarvan het streamtype in deze lijst is opgenomen, aan het filter voldoen.

DeviceIdLists

Eigenschappen

  • invoer

    tekenreeks[] optioneel

    Lijst met invoerapparaten gespecificeerd op basis van hun ID.

    Laat deze eigenschap uitgeschakeld om aan te geven dat invoerapparaten niet worden beïnvloed.

  • uitgang

    tekenreeks[] optioneel

    Lijst met uitvoerapparaten gespecificeerd op basis van hun ID.

    Laat deze eigenschap uitgeschakeld om aan te geven dat uitvoerapparaten niet worden beïnvloed.

DeviceProperties

Eigenschappen

  • niveau

    nummer optioneel

    Het gewenste geluidsniveau van het audioapparaat. Standaard ingesteld op het huidige geluidsniveau van het apparaat.

    Indien gebruikt met een audio-invoerapparaat, vertegenwoordigt dit de versterking van het audioapparaat.

    Indien gebruikt met een audio-uitvoerapparaat, vertegenwoordigt dit het volume van het audioapparaat.

DeviceType

Beschikbare typen audioapparaten.

Enum

"HOOFDTELEFOON"

"MIC"

"USB"

"BLUETOOTH"

"HDMI"

"INTERNAL_SPEAKER"

"INTERNAL_MIC"

"VOOR_MIC"

"REAR_MIC"

"KEYBOARD_MIC"

"HOTWORD"

"LINE-OUT"

"POST_MIX_LOOPBACK"

"POST_DSP_LOOPBACK"

"ALSA_LOOPBACK"

"ANDER"

LevelChangedEvent

Eigenschappen

  • apparaat ID

    snaar

    ID van apparaat waarvan het geluidsniveau is gewijzigd.

  • niveau

    nummer

    Het nieuwe geluidsniveau van het apparaat.

MuteChangedEvent

Eigenschappen

  • is gedempt

    Booleaans

    Of de stream nu gedempt is of niet.

  • streamType

    StreamType

    Het type stream waarvoor de mute-waarde is gewijzigd. De bijgewerkte mute-waarde geldt voor alle apparaten met dit streamtype.

StreamType

Type stream dat een audioapparaat levert.

Enum

"INVOER"

"OUTPUT"

Methoden

getDevices()

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

Krijgt een lijst met audioapparaten die zijn gefilterd op basis van filter .

Parameters

  • filter

    DeviceFilter optioneel

    Apparaateigenschappen waarop de lijst met geretourneerde audioapparaten moet worden gefilterd. Als het filter niet is ingesteld of is ingesteld op {} , bevat de geretourneerde apparaatlijst alle beschikbare audioapparaten.

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (devices: AudioDeviceInfo[])=>void

Geeft terug

  • Beloof < AudioDeviceInfo []>

    Chroom 116+

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

getMute()

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

Haalt de systeembrede mute-status op voor het opgegeven streamtype.

Parameters

  • streamType

    StreamType

    Streamtype waarvoor de mute-status moet worden opgehaald.

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (value: boolean)=>void

    • waarde

      Booleaans

Geeft terug

  • Beloof<boolean>

    Chroom 116+

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

setActiveDevices()

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

Stelt lijsten in met actieve invoer- en/of uitvoerapparaten.

Parameters

  • Specificeert ID's van apparaten die actief moeten zijn. Als de invoer- of uitvoerlijst niet is ingesteld, heeft dit geen gevolgen voor apparaten in die categorie.

    Het is een fout om een ​​niet-bestaand apparaat-ID door te geven.

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    ()=>void

Geeft terug

  • Beloof <nietig>

    Chroom 116+

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

setMute()

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

Stelt de mute-status in voor een streamtype. De mute-status is van toepassing op alle audioapparaten met het opgegeven audiostreamtype.

Parameters

  • streamType

    StreamType

    Streamtype waarvoor de mute-status moet worden ingesteld.

  • is gedempt

    Booleaans

    Nieuwe mute-waarde.

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    ()=>void

Geeft terug

  • Beloof <nietig>

    Chroom 116+

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

setProperties()

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

Stelt de eigenschappen in voor het invoer- of uitvoerapparaat.

Parameters

  • ID kaart

    snaar

  • eigenschappen

    Apparaateigenschappen

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    ()=>void

Geeft terug

  • Beloof <nietig>

    Chroom 116+

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

Evenementen

onDeviceListChanged

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

Wordt geactiveerd wanneer audioapparaten worden gewijzigd, waarbij nieuwe apparaten worden toegevoegd of bestaande apparaten worden verwijderd.

Parameters

onLevelChanged

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

Wordt geactiveerd wanneer het geluidsniveau verandert voor een actief audioapparaat.

Parameters

onMuteChanged

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

Wordt geactiveerd wanneer de mute-status van de audio-invoer of -uitvoer verandert. Houd er rekening mee dat de mute-status voor het hele systeem geldt en dat de nieuwe waarde van toepassing is op elk audioapparaat met een opgegeven streamtype.

Parameters