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.
EventTarget
DocumentPictureInPicture
Instance properties
window
Read only Experimental
Returns a Window
instance representing the browsing context inside the Picture-in-Picture window.
Instance methods
requestWindow()
Experimental
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
enter
Experimental
Fired when the Picture-in-Picture window is successfully opened.
Examples
const videoPlayer = document. getElementById ( "player" ) ;
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
Desktop
Mobile
Chrome
Edge
Firefox
Internet Explorer
Opera
Safari
WebView Android
Chrome Android
Firefox for Android
Opera Android
Safari on IOS
Samsung Internet
DocumentPictureInPicture
116
116
No
No
102
No
No
No
No
No
No
No
enter_event
116
116
No
No
102
No
No
No
No
No
No
No
requestWindow
116
116
No
No
102
No
No
No
No
No
No
No
window
116
116
No
No
102
No
No
No
No
No
No
No
See also