Dokument: exitPictureInPicture() Methode
Eingeschränkt verfügbar
Diese Funktion ist nicht Baseline, da sie in einigen der am weitesten verbreiteten Browser nicht funktioniert.
Want more browser support for this feature? Tell us why.
Die exitPictureInPicture() Methode der Document-Schnittstelle fordert an, dass ein Video in diesem Dokument, das derzeit schwebt, aus dem Bild-in-Bild-Modus herausgenommen wird.
Dies versucht die Auswirkungen eines vorherigen Aufrufs von HTMLVideoElement.requestPictureInPicture() rückgängig zu machen und das Video wieder in den Website-Fluss zu integrieren.
Syntax
exitPictureInPicture()
Parameter
Keine.
Rückgabewert
Ein Promise, das aufgelöst wird, sobald der User-Agent den Bild-in-Bild-Modus verlassen hat. Wenn beim Versuch, den Bild-in-Bild-Modus zu verlassen, ein Fehler auftritt, wird der catch()-Handler für das Promise aufgerufen.
Ausnahmen
InvalidStateErrorDOMException-
Ausgelöst, wenn
document.pictureInPictureElementnullist.
Beispiele
>Grundlegende Verwendung
Dieses Beispiel bewirkt, dass das aktuelle Dokument den Bild-in-Bild-Modus verlässt, sobald die Maustaste darin geklickt wird.
document.onclick = (event) => {
if (document.pictureInPictureElement) {
document
.exitPictureInPicture()
.then(() => console.log("Document Exited from Picture-in-Picture mode"))
.catch((err) => console.error(err));
} else {
video.requestPictureInPicture();
}
};
Beachten Sie, dass Sie, wenn Sie verfolgen möchten, welches Video auf Ihrer Seite derzeit im Bild-in-Bild-Modus abgespielt wird, die Ereignisse enterpictureinpicture und leavepictureinpicture auf dem (den) HTMLVideoElement Element(en) überwachen sollten. Alternativ können Sie prüfen, ob Document.pictureInPictureElement auf das aktuelle HTMLVideoElement-Element verweist.
Spezifikationen
| Spezifikation |
|---|
| Picture-in-Picture> # dom-document-exitpictureinpicture> |