W3cubDocs

/Web APIs

DocumentPictureInPictureEvent

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

The DocumentPictureInPictureEvent interface of the Document Picture-in-Picture API is the event object for the enter event, which fires when the Picture-in-Picture window is opened.

Constructor

DocumentPictureInPictureEvent() Experimental: Creates a new DocumentPictureInPictureEvent object instance.

Instance methods

Inherits methods from its parent, Event.

Instance properties

Inherits properties from its parent, Event.

window Read only Experimental: Returns a Window instance representing the browsing context inside the DocumentPictureInPicture window the event was fired on.

Examples

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 # documentpictureinpictureevent

Browser compatibility