chrome.desktopCapture

refresh date: 2026-09-25 robots: noindex

Beschreibung

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

Berechtigungen

desktopCapture

Typen

DesktopCaptureSourceType

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

Enum

"screen"

"window"

"tab"

"audio"

SelfCapturePreferenceEnum

Chrome 107 oder höher

Spiegelt SelfCapturePreferenceEnum wider.

Enum

"include"

"exclude"

SystemAudioPreferenceEnum

Chrome 105 oder höher

Spiegelt SystemAudioPreferenceEnum wider.

Enum

"include"

"exclude"

WindowAudioPreferenceEnum

Chrome 140 und höher

Spiegelt WindowAudioPreferenceEnum wider.

Enum

"system"

"window"

"exclude"

Methoden

cancelChooseDesktopMedia()

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

Blendet das Dialogfeld für die Desktop-Media-Auswahl aus, das von chooseDesktopMedia() angezeigt wird.

Parameter

  • desktopMediaRequestId

    Zahl

    Von chooseDesktopMedia() zurückgegebene ID

chooseDesktopMedia()

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

Zeigt die Benutzeroberfläche der Media-Auswahl für Computer mit den angegebenen Quellen an.

Parameter

  • Satz von Quellen, die dem Nutzer angezeigt werden sollen. Die Reihenfolge der Quellen im Set bestimmt die Reihenfolge der Tabs in der Auswahl.

  • targetTab

    Tab optional

    Optionaler Tab, für den der Stream erstellt wird. Wenn nicht angegeben, kann der resultierende Stream nur von der aufrufenden Erweiterung verwendet werden. Der Stream kann nur von Frames im angegebenen Tab verwendet werden, deren Sicherheitsursprung mit tab.url übereinstimmt. Der Ursprung des Tabs muss ein sicherer Ursprung sein, z.B. HTTPS.

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

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

    • streamId

      String

      Ein nicht lesbarer String, der an die getUserMedia() API übergeben werden kann, um einen Mediastream 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 einem leeren streamId aufgerufen. Der erstellte streamId kann nur einmal verwendet werden und läuft nach einigen Sekunden ab, wenn er nicht verwendet wird.

    • Optionen

      Objekt

      Chrome 57 oder höher

      Enthält Attribute, die den Stream beschreiben.

      • canRequestAudioTrack

        boolean

        „True“, wenn „audio“ in den Parameterquellen enthalten ist und der Endnutzer das Häkchen bei „Audio teilen“ nicht entfernt. Andernfalls „false“. In diesem Fall sollte kein Audiostream über den getUserMedia-Aufruf angefordert werden.

Ausgabe

  • Zahl

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