Document: exitPictureInPicture() Methode

Limited availability

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

Die exitPictureInPicture() Methode des Document Interfaces fordert, dass ein Video in diesem Dokument, das derzeit schwebt, aus dem Bild-in-Bild-Modus genommen wird, wodurch der vorherige Zustand des Bildschirms wiederhergestellt wird. Dies kehrt normalerweise die Auswirkungen eines vorherigen Aufrufs von HTMLVideoElement.requestPictureInPicture() um.

Syntax

js
exitPictureInPicture()

Parameter

Keine.

Rückgabewert

Ein Promise, das aufgelöst wird, sobald der User-Agent den Bild-in-Bild-Modus verlassen hat. Wenn ein Fehler beim Versuch auftritt, den Vollbildmodus zu beenden, wird der catch()-Handler des Promises aufgerufen.

Ausnahmen

InvalidStateError DOMException

Wird ausgelöst, wenn document.pictureInPictureElement null ist.

Beispiele

Dieses Beispiel bewirkt, dass das aktuelle Dokument den Bild-in-Bild-Modus verlässt, wann immer die Maustaste innerhalb davon geklickt wird.

js
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 enterpictureinpicture- und exitpictureinpicture-Ereignisse auf dem/den betreffenden HTMLVideoElement Element(en) anhören sollten. Alternativ können Sie überprüfen, ob Document.pictureInPictureElement auf das aktuelle HTMLVideoElement Element verweist.

Spezifikationen

Specification
Picture-in-Picture
# ref-for-dom-document-exitpictureinpicture

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch