DocumentPictureInPicture: requestWindow() Methode

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig, bevor Sie diese produktiv verwenden.

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Die requestWindow()-Methode der DocumentPictureInPicture-Schnittstelle öffnet das Picture-in-Picture-Fenster für den aktuellen Haupt-Browsing-Kontext. Sie gibt ein Promise zurück, das mit einer Window-Instanz erfüllt wird, die den Browsing-Kontext im Picture-in-Picture-Fenster repräsentiert.

Die requestWindow()-Methode erfordert eine transiente Aktivierung, d.h. sie muss als Reaktion auf eine Benutzeraktion wie einen Mausklick oder Tastendruck aufgerufen werden.

Syntax

js
requestWindow()
requestWindow(options)

Parameter

options Optional

Ein Optionsobjekt, das die folgenden Eigenschaften enthält:

height

Eine nicht negative Zahl, die die für den Viewport des Picture-in-Picture-Fensters festzulegende Höhe in Pixeln darstellt. Wenn options nicht angegeben ist, wird der Standardwert 0 verwendet.

width

Eine nicht negative Zahl, die die für den Viewport des Picture-in-Picture-Fensters festzulegende Breite in Pixeln darstellt. Wenn options nicht angegeben ist, wird der Standardwert 0 verwendet.

Hinweis: Wenn eine der Optionen angegeben wird, muss die andere ebenfalls angegeben werden, andernfalls wird ein Fehler ausgelöst. Wenn beide Werte nicht angegeben, als 0 angegeben oder zu groß festgelegt werden, wird der Browser die Werte entsprechend anpassen oder ignorieren, um eine angemessene Benutzererfahrung zu bieten. Die angepasste Größe variiert je nach Implementierung, Anzeigengröße und anderen Faktoren.

Rückgabewert

Ein Promise, das mit einem Window-Objekt ausfüllt, das den Browsing-Kontext im Picture-in-Picture-Fenster darstellt.

Ausnahmen

NotSupportedError DOMException

Wird geworfen, wenn die API explizit deaktiviert wurde (zum Beispiel über Browsereinstellungen).

NotAllowedError DOMException

Wird geworfen, wenn:

RangeError DOMException

Wird geworfen, wenn nur eines von height und width festgelegt ist, oder wenn height und width mit negativen Werten festgelegt sind.

Beispiele

js
const videoPlayer = document.getElementById("player");

// ...

// Open a Picture-in-Picture window.
const pipWindow = await window.documentPictureInPicture.requestWindow({
  width: videoPlayer.clientWidth,
  height: videoPlayer.clientHeight,
});

// ...

Spezifikationen

Specification
Document Picture-in-Picture
# dom-documentpictureinpicture-requestwindow

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch