Web/API/DocumentOrShadowRoot/pictureInPictureElement

The DocumentOrShadowRoot.pictureInPictureElement read-only property returns the HTMLVideoElement that is currently being presented in picture-in-picture mode in this document, or null if picture-in-picture mode is not currently in use.

Although this property is read-only, it will not throw if it is modified (even in strict mode); the setter is a no-operation and will be ignored.

Syntax

var video = document.pictureInPictureElement;

Return value

A reference to the HTMLVideoElement object that's currently in picture-in-picture mode; if picture-in-picture mode isn't currently in use by the document, the returned value is null.

Examples

This example presents a function, Document.exitPictureInPicture(), which tests the value returned by pictureInPictureElement. If the document is in picture-in-picture mode (pictureInPictureElement isn't null), exitPictureInPicture() is run to exit picture-in-picture mode.

function exitPictureInPicture() {
  if (document.pictureInPictureElement) {
    document.exitPictureInPicture();
  }
}

Specifications

Specification	Status	Comment
UnknownThe definition of 'Document.pictureInPictureElement' in that specification.	Unknown	Initial definition

Browser compatibility

No compatibility data found. Please contribute data for "api.DocumentOrShadowRoot.pictureInPictureElement" (depth: 1) to the MDN compatibility data repository.