Document: exitPictureInPicture() method
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Want more browser support for this feature? Tell us why.
The exitPictureInPicture() method of the Document interface requests that a video contained in this document, which is currently floating, be taken out of picture-in-picture mode.
This attempts to reverse the effects of a previous call to HTMLVideoElement.requestPictureInPicture(), restoring the video back into the website flow.
Syntax
exitPictureInPicture()
Parameters
None.
Return value
A Promise, which is resolved once the user agent has finished exiting picture-in-picture mode.
If an error occurs while attempting to exit picture-in-picture mode, the catch() handler for the promise is called.
Exceptions
InvalidStateErrorDOMException-
Thrown if
document.pictureInPictureElementisnull.
Examples
Basic usage
This example causes the current document to exit picture-in-picture mode whenever the mouse button is clicked within it.
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();
}
};
Note that if you want to track which video on your page is currently playing in picture-in-picture mode, you should listen to the enterpictureinpicture and leavepictureinpicture events on the HTMLVideoElement element(s) in question.
Alternatively, you can check whether Document.pictureInPictureElement refers to the current HTMLVideoElement element.
Specifications
| Specification |
|---|
| Picture-in-Picture # dom-document-exitpictureinpicture |