Firefox Tomorrow

web api constructor

DocumentPictureInPictureEvent: DocumentPictureInPictureEvent() constructor

View on MDN ↗

Secure context

The DocumentPictureInPictureEvent() constructor creates a new DocumentPictureInPictureEvent object instance.

Syntax

new DocumentPictureInPictureEvent(type, init)

Parameters

  • type
    • : A string representing the type of event. In the case of DocumentPictureInPictureEvent this is always enter.
  • init
    • : An object containing the following properties:
      • window
        • : A Window instance representing the browsing context inside the DocumentPictureInPicture window the event was fired on.

Examples

A developer would not use this constructor manually. A new DocumentPictureInPictureEvent object is constructed when a handler is invoked as a result of the enter event firing.

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

SpecificationsStandards references are available on the canonical MDN page.

Browser compatibility

Browser compatibilityCompatibility data is available on the canonical MDN page.

See also