DocumentPictureInPicture
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
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.
Instance methods
Inherits methods from its parent, EventTarget.
requestWindow()-
Opens 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.
enter-
Fired when the Picture-in-Picture window is successfully opened.
Examples
js
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
| Specification |
|---|
| Document Picture-in-Picture Specification # documentpictureinpicture |
Browser compatibility
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
DocumentPictureInPicture
|
|
|
|
|
|
|
|
|
|
|
|
|
enter event
|
|
|
|
|
|
|
|
|
|
|
|
|
requestWindow
|
|
|
|
|
|
|
|
|
|
|
|
|
disallowReturnToOpener option
|
|
|
|
|
|
|
|
|
|
|
|
|
preferInitialWindowPlacement option
|
|
|
|
|
|
|
|
|
|
|
|
|
window
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- In development. Supported in a pre-release version.
- In development. Supported in a pre-release version.
- No support
- No support