Document.pictureInPictureEnabled is a read-only Boolean that is true when a video may enter picture-in-picture (floating window) via HTMLVideoElement.requestPictureInPicture(), otherwise false (MDN).
Read the notes below before you get or set this property. Prefer feature detection when support is limited.
Use document.pictureInPictureEnabled. Start with this line.
document.pictureInPictureEnabled| Call | What it does |
|---|---|
document.pictureInPictureEnabled | Primary signature. |
Built into the browser. Read or assign document.pictureInPictureEnabled — no import required.
document.pictureInPictureEnabled| Parameter | Description |
|---|---|
| Permissions-Policy | Optional. Can deny PiP (MDN) |
| Return Value | Description |
|---|---|
| * | Boolean (true / false) |
pictureInPictureEnabledLog whether picture-in-picture is available in the current document.
console.log(document.pictureInPictureEnabled);
// true or falsedocument.pictureInPictureEnabled.true. A video may call requestPictureInPicture().false. Do not offer PiP (or explain why).requestPictureInPicture() (MDN)Check availability first, then enter — or log a friendly message.
function requestPictureInPicture(videoElement) {
if (document.pictureInPictureEnabled) {
videoElement.requestPictureInPicture();
} else {
console.log("Your browser cannot use picture-in-picture right now");
}
}
// Demo without starting real PiP:
if (document.pictureInPictureEnabled) {
console.log("PiP is available — safe to call requestPictureInPicture().");
} else {
console.log("Your browser cannot use picture-in-picture right now");
}true.false, skip requestPictureInPicture().Availability is not the same as “in picture-in-picture now.”
const allowed = document.pictureInPictureEnabled;
const active = document.pictureInPictureElement !== null;
console.log(allowed); // can we enter PiP?
console.log(active); // are we in PiP now?
// Common combo: allowed && !active → show "Enter PiP"pictureInPictureEnabled answers “is PiP allowed?”pictureInPictureElement !== null answers “are we in PiP?”Document.pictureInPictureEnabled is marked Limited availability on MDN (not Baseline). It is not Deprecated, Experimental, or Non-standard — still feature-detect in production.
Read-only Boolean — true when HTMLVideoElement.requestPictureInPicture() is allowed for this document.
Bottom line: Check document.pictureInPictureEnabled before calling requestPictureInPicture(). Pair with pictureInPictureElement for current state, and exit with document.exitPictureInPicture().
Learn the Document property that exposes the embeds/plugins collection.
11 people found this page helpful