chrome.desktopCapture

Beschreibung

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

Berechtigungen

desktopCapture

Typen

DesktopCaptureSourceType

Aufzählung zur Definition der Gruppe von Desktop-Medienquellen, die in selectDesktopMedia() verwendet werden.

Enum

SelfCapturePreferenceEnum

Chrome 107 und höher

Spiegelt SelfCapturePreferenceEnum.

Enum

SystemAudioPreferenceEnum

Chrome 105 und höher

Spiegelt SystemAudioPreferenceEnum.

Enum

Methoden

cancelChooseDesktopMedia()

chrome.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
)

Blendet das von „selectDesktopMedia()“ angezeigte Dialogfeld für die Desktop-Medienauswahl aus.

Parameters

  • desktopMediaRequestId

    Zahl

    Von selectDesktopMedia() zurückgegebene ID

chooseDesktopMedia()

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

Zeigt die Benutzeroberfläche der Desktop-Medienauswahl mit den angegebenen Quellen an.

Parameters

  • Satz von Quellen, die dem Nutzer angezeigt werden sollen. Die Reihenfolge der Tabs in der Auswahl richtet sich nach der Reihenfolge der Quellen.

  • targetTab

    Tabulatortaste optional

    Optionaler Tab, für den der Stream erstellt wird. Ist nichts angegeben, kann der resultierende Stream nur von der Anruferweiterung verwendet werden. Der Stream kann nur von Frames im jeweiligen Tab verwendet werden, deren Sicherheitsherkunft 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 intransparenter 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 (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 einigen Sekunden ab, wenn sie nicht verwendet wird.

    • Optionen

      Objekt

      Chrome 57 und höher

      Enthält Attribute, die den Stream beschreiben.

      • canRequestAudioTrack

        boolean

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

Rückgaben

  • Zahl

    Eine ID, die an cancelSelectDesktopMedia() weitergegeben werden kann, falls die Aufforderung abgebrochen werden muss.