DocumentPictureInPicture: enter event

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 enter event of the DocumentPictureInPicture interface is fired when the Picture-in-Picture window is successfully opened.

Syntax

Use the event name in methods like addEventListener(), or set an event handler property.

js
addEventListener("enter", (event) => {});

onenter = (event) => {};

Event type

A DocumentPictureInPictureEvent.

Examples

js
documentPictureInPicture.addEventListener("enter", (event) => {
  const pipWindow = event.window;
  console.log("Video player has entered the pip window");

  const pipMuteButton = pipWindow.document.createElement("button");
  pipMuteButton.textContent = "Mute";
  pipMuteButton.addEventListener("click", () => {
    const pipVideo = pipWindow.document.querySelector("#video");
    if (!pipVideo.muted) {
      pipVideo.muted = true;
      pipMuteButton.textContent = "Unmute";
    } else {
      pipVideo.muted = false;
      pipMuteButton.textContent = "Mute";
    }
  });

  pipWindow.document.body.append(pipMuteButton);
});

Specifications

Specification
Document Picture-in-Picture Specification
# dom-documentpictureinpicture-onenter

Browser compatibility

BCD tables only load in the browser

See also