DocumentPictureInPicture
Document Picture-in-Picture API
Document Picture-in-Picture API
The DocumentPictureInPicture interface of the Document Picture-in-Picture API is the entry point for creating and handling document picture-in-picture windows.
It is accessed via the Window.documentPictureInPicture property.
Instance properties
Inherits properties from its parent, EventTarget.
- window
- : Returns a Window instance representing the browsing context inside the Picture-in-Picture window.
Instance methods
Inherits methods from its parent, EventTarget.
- requestWindow()
- : Opens the Picture-in-Picture window for the current main browsing context. Returns a Promise that fulfills with a Window instance representing the browsing context inside the Picture-in-Picture window.
Events
Inherits events from its parent, EventTarget.
- enter
- : Fired 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,
});
// …
See Document Picture-in-Picture API Example for a full working demo (see the full source code also).
Specifications
Browser compatibility
See also
- Document Picture-in-Picture API
- Using the Document Picture-in-Picture API