DocumentPictureInPicture
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Experimental:This is anexperimental technology
Check theBrowser compatibility table carefully before using this in production.
Secure context: This feature is available only insecure contexts (HTTPS), in some or allsupporting browsers.
TheDocumentPictureInPicture interface of theDocument Picture-in-Picture API is the entry point for creating and handling document picture-in-picture windows.
It is accessed via theWindow.documentPictureInPicture property.
In this article
Instance properties
Inherits properties from its parent,EventTarget.
windowRead onlyExperimentalReturns a
Windowinstance representing the browsing context inside the Picture-in-Picture window.
Instance methods
Inherits methods from its parent,EventTarget.
requestWindow()ExperimentalOpens the Picture-in-Picture window for the current main browsing context. Returns a
Promisethat fulfills with aWindowinstance representing the browsing context inside the Picture-in-Picture window.
Events
Inherits events from its parent,EventTarget.
enterExperimentalFired when the Picture-in-Picture window is successfully opened.
Examples
const videoPlayer = document.getElementById("player");// …// Open a Picture-in-Picture window.const pipWindow = await window.documentPictureInPicture.requestWindow({ width: videoPlayer.clientWidth, height: videoPlayer.clientHeight,});// …SeeDocument Picture-in-Picture API Example for a full working demo (see the fullsource code also).
Specifications
| Specification |
|---|
| Document Picture-in-Picture Specification> # documentpictureinpicture> |