browser.desktopCapture

Beschrijving

De Desktop Capture API legt de content van het scherm, afzonderlijke vensters of afzonderlijke tabbladen vast.

Rechten

desktopCapture

Typen

DesktopCaptureSourceType

Enum die wordt gebruikt om een set desktopmediabronnen te definiëren die worden gebruikt in chooseDesktopMedia().

Enum

"screen"

"window"

tabblad

"audio"

SelfCapturePreferenceEnum

Chrome 107+ browser.* sinds Chrome 148

Spiegelt SelfCapturePreferenceEnum.

Enum

"include"

exclude

SystemAudioPreferenceEnum

Chrome 105 of hoger browser.* sinds Chrome 148

Komt overeen met SystemAudioPreferenceEnum.

Enum

"include"

exclude

WindowAudioPreferenceEnum

Chrome 140+ browser.* sinds Chrome 148

Komt overeen met WindowAudioPreferenceEnum.

Enum

"system"

"window"

exclude

Methoden

cancelChooseDesktopMedia()

browser.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
): void

Verbergt het dialoogvenster voor de desktopmediakiezer dat wordt getoond door chooseDesktopMedia().

Parameters

  • desktopMediaRequestId

    getal

    ID geretourneerd door chooseDesktopMedia()

chooseDesktopMedia()

browser.desktopCapture.chooseDesktopMedia(
  sources: DesktopCaptureSourceType[],
  targetTab?: Tab,
  callback: function,
): number

Toont de UI van de mediakiezer voor desktops met de opgegeven set bronnen.

Parameters

  • Set bronnen die aan de gebruiker moeten worden getoond. De volgorde van de bronnen in de set bepaalt de tabvolgorde in de kiezer.

  • targetTab

    Tab optioneel

    Optioneel tabblad waarvoor de stream is gemaakt. Als je niets invoert, kan de resulterende stream alleen worden gebruikt door de aanroepende extensie. De stream kan alleen worden gebruikt door frames op het aangegeven tabblad waarvan de beveiligingsoorsprong overeenkomt met tab.url. De oorsprong van het tabblad moet een beveiligde oorsprong zijn, bijvoorbeeld HTTPS.

  • callback

    functie

    De parameter callback ziet er zo uit: 

    (streamId: string, options: object) => void

    • streamId

      tekenreeks

      Een ondoorzichtige tekenreeks die kan worden doorgegeven aan de getUserMedia() API om een mediastream te genereren die overeenkomt met de bron die de gebruiker heeft geselecteerd. Als de gebruiker geen bron heeft geselecteerd (dat wil zeggen, de prompt heeft geannuleerd), wordt de callback aangeroepen met een lege streamId. De gemaakte streamId kan maar één keer worden gebruikt en verloopt na een paar seconden als deze niet wordt gebruikt.

    • opties

      object

      Chrome 57+ browser.* sinds Chrome 148

      Bevat eigenschappen die de stream beschrijven.

      • canRequestAudioTrack

        booleaans

        Waar als 'audio' is opgenomen in parameterbronnen en de eindgebruiker het selectievakje Audio delen niet uitvinkt. Anders is de waarde onwaar en moet je niet om een audiostream vragen via de getUserMedia-aanroep.

Retourzendingen

  • getal

    Een ID die kan worden doorgegeven aan cancelChooseDesktopMedia() als de prompt moet worden geannuleerd.