Document: pictureInPictureElement property

فهرست فصل‌ها دانلود آرشیوناشر

MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونه‌کد

{{APIRef("Picture-in-Picture API")}}

The **pictureInPictureElement** read-only property of the {{domxref("Document")}} interface returns the {{ domxref("Element") }} 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.

Value

A reference to the {{domxref("Element")}} object that's currently in picture-in-picture mode.

Returns null if the document has no associated element in picture-in-picture mode. For example, there's no picture-in-picture element, or the element is from an iframe.

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.

Examples

Basic usage

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

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

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • {{DOMxRef("HTMLVideoElement.requestPictureInPicture()")}}
  • {{DOMxRef("HTMLVideoElement.disablePictureInPicture")}}
  • {{DOMxRef("Document.pictureInPictureEnabled")}}
  • {{DOMxRef("Document.exitPictureInPicture()")}}
  • {{CSSxRef(":picture-in-picture")}}