chroom.audio

Beschrijving

De chrome.audio API is beschikbaar gesteld om gebruikers informatie te laten verkrijgen over en controle te geven over de audioapparaten die op het systeem zijn aangesloten. Deze API is momenteel alleen beschikbaar in de kioskmodus voor ChromeOS.

Toestemmingen

audio

Beschikbaarheid

Chrome 59+ alleen voor ChromeOS

Soorten

AudioDeviceInfo

Eigenschappen

  • apparaatnaam

    snaar

    Apparaatnaam.

  • apparaattype

    Apparaattype

    Type apparaat.

  • displayweergave

    snaar

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

  • id

    snaar

    De unieke identificatiecode van het audioapparaat.

  • isActief

    booleaans

    Dit klopt als dit het momenteel actieve apparaat is.

  • niveau

    nummer

    Het geluidsniveau van het apparaat, het uitvoervolume en de ingangsversterking.

  • stabiele apparaat-ID

    string optioneel

    De stabiele/permanente apparaat-ID-string, indien beschikbaar.

  • streamType

    StreamType

    Streamtype dat aan dit apparaat is gekoppeld.

DeviceFilter

Eigenschappen

  • isActief

    boolean optioneel

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

  • streamTypes

    StreamType [] optioneel

    Indien ingesteld, voldoen alleen audioapparaten waarvan het streamtype in deze lijst voorkomt aan het filter.

DeviceIdLists

Eigenschappen

  • invoer

    string[] optioneel

    Lijst met invoerapparaten, gespecificeerd door hun ID.

    Om aan te geven dat invoerapparaten niet beïnvloed mogen worden, laat u deze eigenschap oningesteld.

  • uitvoer

    string[] optioneel

    Lijst met uitvoerapparaten, gespecificeerd door hun ID.

    Om aan te geven dat uitvoerapparaten niet beïnvloed mogen worden, laat u deze eigenschap oningesteld.

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-ingangsapparaat, geeft dit de versterking van het audioapparaat aan.

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

DeviceType

Beschikbare typen audioapparaten.

Enum

"HOOFDTELEFOON"

"MIC"

"USB"

"BLUETOOTH"

"HDMI"

"INTERNAL_SPEAKER"

"INTERNAL_MIC"

"FRONT_MIC"

"ACHTERMICROFOON"

"TOETSENBORD_MICROFOON"

"HET WOORD"

"LINEOUT"

"POST_MIX_LOOPBACK"

"POST_DSP_LOOPBACK"

"ALSA_LOOPBACK"

"ANDER"

LevelChangedEvent

Eigenschappen

  • apparaat-ID

    snaar

    ID van het apparaat waarvan het geluidsniveau is veranderd.

  • niveau

    nummer

    Het nieuwe geluidsniveau van het apparaat.

MuteChangedEvent

Eigenschappen

  • is gedempt

    booleaans

    Of de stream nu wel of niet gedempt is.

  • streamType

    StreamType

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

StreamType

Het type stream dat een audioapparaat levert.

Enum

"INVOER"

"UITVOER"

Methoden

getDevices()

chrome.audio.getDevices(
  filter?: DeviceFilter,
): Promise<AudioDeviceInfo[]>

Geeft een lijst met audioapparaten weer, gefilterd op basis van filter .

Parameters

  • filter

    Apparaatfilter optioneel

    Apparaateigenschappen waarmee de lijst met geretourneerde audioapparaten kan worden gefilterd. Als het filter niet is ingesteld of is ingesteld op {} , bevat de lijst met geretourneerde apparaten alle beschikbare audioapparaten.

Retourneert

  • Promise< AudioDeviceInfo []>

    Chrome 116+

    Geeft de gevraagde lijst met audioapparaten weer.

getMute()

chrome.audio.getMute(
  streamType: StreamType,
): Promise<boolean>

Geeft de systeemwijde mute-status weer voor het opgegeven streamtype.

Parameters

  • streamType

    StreamType

    Streamtype waarvoor de mute-status moet worden opgehaald.

Retourneert

  • Belofte<boolean>

    Chrome 116+

    Een belofte die wordt opgelost met een booleanwaarde die aangeeft of demping is ingesteld of niet voor het opgegeven streamtype.

setActiveDevices()

chrome.audio.setActiveDevices(
  ids: DeviceIdLists,
): Promise<void>

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

Parameters

  • Hiermee worden de ID's van de apparaten opgegeven die actief moeten zijn. Als de invoer- of uitvoerlijst niet is ingesteld, blijven de apparaten in die categorie ongewijzigd.

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

Retourneert

  • Promise<void>

    Chrome 116+

setMute()

chrome.audio.setMute(
  streamType: StreamType,
  isMuted: boolean,
): Promise<void>

Stelt de dempingsstatus in voor een bepaald type audiostream. De dempingsstatus is van toepassing op alle audioapparaten met het opgegeven type audiostream.

Parameters

  • streamType

    StreamType

    Streamtype waarvoor de mute-status moet worden ingesteld.

  • is gedempt

    booleaans

    Nieuwe dempingswaarde.

Retourneert

  • Promise<void>

    Chrome 116+

setProperties()

chrome.audio.setProperties(
  id: string,
  properties: DeviceProperties,
): Promise<void>

Hiermee worden de eigenschappen voor het invoer- of uitvoerapparaat ingesteld.

Parameters

Retourneert

  • Promise<void>

    Chrome 116+

Evenementen

onDeviceListChanged

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

Wordt geactiveerd wanneer audioapparaten wijzigen, bijvoorbeeld wanneer nieuwe apparaten worden toegevoegd of bestaande apparaten worden verwijderd.

Parameters

onLevelChanged

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

Wordt geactiveerd wanneer het geluidsniveau van een actief audioapparaat verandert.

Parameters

onMuteChanged

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

Deze gebeurtenis wordt geactiveerd wanneer de dempingsstatus van de audio-ingang of -uitgang verandert. Houd er rekening mee dat de dempingsstatus systeembreed is en dat de nieuwe waarde van toepassing is op elk audioapparaat met het opgegeven streamtype.

Parameters