Document.exitPictureInPicture()
The Document
method
exitPictureInPicture()
requests that a video contained
in this document, which is currently floating, be taken out of picture-in-picture
mode, restoring the previous state of the screen. This usually reverses the
effects of a previous call to HTMLVideoElement.requestPictureInPicture()
.
Syntax
exitPromise = document.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
full-screen mode, the catch()
handler for the promise is called.
Examples
This example causes the current document to exit picture-in-picture mode whenever the mouse button is clicked within it.
document.onclick = function (event) {
if (document.pictureInPictureElement) {
document.exitPictureInPicture()
.then(() => console.log("Document Exited from Picture-in-Picture mode"))
.catch((err) => console.error(err))
} else {
video.requestPictureInPicture();
}
}
Specifications
Specification | Status | Comment |
---|---|---|
Picture-in-Picture API The definition of 'Document.exitPictureInPicture()' in that specification. |
Draft | Initial definition |
Browser compatibility
BCD tables only load in the browser