DocumentPictureInPicture

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

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.

EventTarget DocumentPictureInPicture

Instance properties

window Read only

Returns a Window instance representing the browsing context inside the Picture-in-Picture window.

Instance methods

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

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

Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
DocumentPictureInPicture
Experimental
enter event
Experimental
requestWindow
Experimental
window
Experimental

See also