chrome.desktopCapture

Beschreibung

Die Desktop Capture API erfasst den Inhalt des Bildschirms, einzelne Fenster oder einzelne Tabs.

Berechtigungen

desktopCapture

Typen

DesktopCaptureSourceType

Enum, mit dem die Desktop-Medienquellen definiert werden, die in „chooseDesktopMedia()“ verwendet werden.

Enum

"screen"

"window"

Tabulatortaste

„audio“

SelfCapturePreferenceEnum

Chrome 107 und höher

Spiegelt SelfCapturePreferenceEnum wider.

Enum

„include“

„exclude“

SystemAudioPreferenceEnum

Chrome 105 und höher

Entspricht SystemAudioPreferenceEnum.

Enum

„include“

„exclude“

Methoden

cancelChooseDesktopMedia()

chrome.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
)

Blendet das Dialogfeld für die Desktopmedienauswahl aus, das von „chooseDesktopMedia()“ angezeigt wird.

Parameter

  • desktopMediaRequestId

    Zahl

    Von „chooseDesktopMedia()“ zurückgegebene ID

chooseDesktopMedia()

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

Die Benutzeroberfläche der Medienauswahl für Computer mit den angegebenen Quellen.

Parameter

  • Quellen, die dem Nutzer angezeigt werden sollen. Die Reihenfolge der Quellen im Set bestimmt die Tab-Reihenfolge in der Auswahl.

  • targetTab

    Tab optional

    Optionaler Tab, für den der Stream erstellt wird. Wenn keine Angabe erfolgt, kann der resultierende Stream nur von der aufrufenden Erweiterung verwendet werden. Der Stream kann nur von Frames auf dem angegebenen Tab verwendet werden, deren Sicherheitsursprung mit tab.url übereinstimmt. Der Tab muss einen sicheren Ursprung haben, z.B. HTTPS.

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

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

    • streamId

      String

      Ein nicht transparenter String, der an die getUserMedia() API übergeben werden kann, um einen Medienstream zu generieren, der der vom Nutzer ausgewählten Quelle entspricht. Wenn der Nutzer keine Quelle ausgewählt hat (d.h. die Aufforderung abgebrochen hat), wird der Callback mit einer leeren streamId aufgerufen. Die erstellte streamId kann nur einmal verwendet werden und läuft nach wenigen Sekunden ab, wenn sie nicht verwendet wird.

    • Optionen

      Objekt

      Chrome 57 und höher

      Enthält Eigenschaften, die den Stream beschreiben.

      • canRequestAudioTrack

        boolean

        „Wahr“, wenn „audio“ in den Parameterquellen enthalten ist und der Endnutzer das Kästchen „Audio teilen“ nicht deaktiviert. Andernfalls ist der Wert „falsch“. In diesem Fall sollte kein Audiostream über den getUserMedia-Aufruf angefordert werden.

Gibt Folgendes zurück:

  • Zahl

    Eine ID, die an cancelChooseDesktopMedia() übergeben werden kann, falls die Aufforderung abgebrochen werden muss.