Picture in picture per qualsiasi elemento, non solo per i <video>

François Beaufort

L'API Document Picture-in-Picture consente di aprire una finestra sempre in primo piano che può essere compilata con contenuti HTML arbitrari. Estende l'API Picture in picture per <video> che consente di inserire un elemento HTML <video> solo in una finestra Picture in picture (PiP).

La finestra Picture in picture nell'API Document Picture-in-Picture è simile a una finestra vuota della stessa origine aperta utilizzando window.open(), con alcune differenze:

• La finestra Picture in picture è mobile e si trova sopra le altre finestre.
• La finestra Picture in picture non dura mai più a lungo della finestra di apertura.
• Non è possibile navigare nella finestra Picture in picture.
• La posizione della finestra Picture in picture non può essere impostata dal sito web.

Stato

Casi d'uso

Puoi utilizzare questa API in diversi modi, tra cui lettori video personalizzati, app di videoconferenza e di produttività.

Video player personalizzato

Un sito web può fornire un'esperienza video Picture in Picture con l'API Picture in Picture esistente per <video>, ma è molto limitata. La finestra PIP esistente accetta pochi input e ha una capacità limitata di applicare stili. Con un documento completo in modalità Picture in picture, il sito web può fornire controlli e input personalizzati (ad esempio sottotitoli codificati, playlist, barra di scorrimento, Mi piace e Non mi piace per i video) per migliorare l'esperienza di visione dei video in modalità PiP dell'utente.

Videoconferenze

Spesso gli utenti abbandonano temporaneamente la scheda del browser durante una sessione di videoconferenza, ad esempio quando presentano contenuti da un'altra scheda alla chiamata, prendono appunti o svolgono altre attività di multitasking. Tuttavia, nella maggior parte dei casi, l'utente vuole comunque vedere la chiamata, quindi questo è un caso d'uso ideale per Picture in picture. Ancora una volta, l'esperienza attuale che un sito web di videoconferenze può offrire con l'API Picture in Picture per <video> è limitata nello stile e nell'input. Con un documento completo in Picture in picture, il sito web può combinare facilmente più stream video in un'unica finestra PIP, senza ricorrere a trucchi per canvas, e fornire controlli personalizzati, come l'invio di un messaggio, la disattivazione dell'audio di un altro utente o l'alzata di mano.

Produttività

Le ricerche hanno dimostrato che gli utenti hanno bisogno di più modi per essere produttivi sul web. Documento in Picture in picture offre alle app web la flessibilità di fare di più. Che si tratti di modifica del testo, presa di appunti, elenchi di attività, messaggistica e chat o strumenti di progettazione e sviluppo, le app web ora possono mantenere i loro contenuti sempre accessibili.

Interfaccia

Proprietà

documentPictureInPicture.window

Restituisce l'eventuale finestra Picture in picture corrente. In caso contrario, restituisce null.

Metodi

documentPictureInPicture.requestWindow(options)

Restituisce una promessa che viene risolta quando viene aperta una finestra Picture in picture. La promessa viene rifiutata se viene chiamata senza un gesto dell'utente. Il dizionario options contiene i seguenti membri facoltativi:

width

Imposta la larghezza iniziale della finestra Picture in picture.

height

Imposta l'altezza iniziale della finestra Picture in picture.

disallowReturnToOpener

Nasconde il pulsante "Torna alla scheda" nella finestra Picture in picture se è true. Il valore predefinito è false.

preferInitialWindowPlacement

Apre la finestra Picture in picture nella posizione e nelle dimensioni predefinite se è vero. Per impostazione predefinita, è false.

Eventi

documentPictureInPicture.onenter

Attivato il giorno documentPictureInPicture quando viene aperta una finestra Picture in picture.

Esempi

Il seguente codice HTML configura un video player personalizzato e un elemento pulsante per aprire il video player in una finestra Picture in picture.

<div id="playerContainer">
  <div id="player">
    <video id="video"></video>
  </div>
</div>
<button id="pipButton">Open Picture-in-Picture window</button>

Aprire una finestra Picture in picture

Le seguenti chiamate JavaScript documentPictureInPicture.requestWindow() quando l'utente fa clic sul pulsante per aprire una finestra Picture in picture vuota. La promessa restituita viene risolta con un oggetto JavaScript della finestra Picture in picture. Il video player viene spostato in quella finestra utilizzando append().

pipButton.addEventListener('click', async () => {
  const player = document.querySelector("#player");

  // Open a Picture-in-Picture window.
  const pipWindow = await documentPictureInPicture.requestWindow();

  // Move the player to the Picture-in-Picture window.
  pipWindow.document.body.append(player);
});

Impostare le dimensioni della finestra Picture in picture

Per impostare le dimensioni della finestra Picture in Picture, imposta le opzioni width e height di documentPictureInPicture.requestWindow() sulle dimensioni ideali della finestra PIP. Chrome potrebbe ridurre i valori delle opzioni se sono troppo grandi o troppo piccoli per adattarsi a una dimensione della finestra intuitiva.

pipButton.addEventListener("click", async () => {
  const player = document.querySelector("#player");

  // Open a Picture-in-Picture window whose size is
  // the same as the player's.
  const pipWindow = await documentPictureInPicture.requestWindow({
    width: player.clientWidth,
    height: player.clientHeight,
  });

  // Move the player to the Picture-in-Picture window.
  pipWindow.document.body.append(player);
});

Nascondere il pulsante "Torna alla scheda" nella finestra PIP

Per nascondere il pulsante nella finestra Picture in Picture che consente all'utente di tornare alla scheda di apertura, imposta l'opzione disallowReturnToOpener di documentPictureInPicture.requestWindow() su true.

pipButton.addEventListener("click", async () => {
  // Open a Picture-in-Picture window which hides the "back to tab" button.
  const pipWindow = await documentPictureInPicture.requestWindow({
    disallowReturnToOpener: true,
  });
});

Apri PIP nella posizione e nelle dimensioni predefinite

Per non riutilizzare la posizione o le dimensioni della finestra Picture in picture precedente, imposta l'opzione preferInitialWindowPlacement di documentPictureInPicture.requestWindow() su true.

pipButton.addEventListener("click", async () => {
  // Open a Picture-in-Picture window in its default position / size.
  const pipWindow = await documentPictureInPicture.requestWindow({
    preferInitialWindowPlacement: true,
  });
});

Copia i fogli di stile in PIP

Per copiare tutti i fogli di stile CSS dalla finestra di origine, scorri styleSheets collegati o incorporati esplicitamente nel documento e aggiungili alla finestra Picture in Picture. Tieni presente che si tratta di una copia unica.

pipButton.addEventListener("click", async () => {
  const player = document.querySelector("#player");

  // Open a Picture-in-Picture window.
  const pipWindow = await documentPictureInPicture.requestWindow();

  // Copy style sheets over from the initial document
  // so that the player looks the same.
  [...document.styleSheets].forEach((styleSheet) => {
    try {
      const cssRules = [...styleSheet.cssRules].map((rule) => rule.cssText).join('');
      const style = document.createElement('style');

      style.textContent = cssRules;
      pipWindow.document.head.appendChild(style);
    } catch (e) {
      const link = document.createElement('link');

      link.rel = 'stylesheet';
      link.type = styleSheet.type;
      link.media = styleSheet.media;
      link.href = styleSheet.href;
      pipWindow.document.head.appendChild(link);
    }
  });

  // Move the player to the Picture-in-Picture window.
  pipWindow.document.body.append(player);
});

Gestisci la chiusura della finestra PIP

Ascolta l'evento "pagehide" della finestra per sapere quando la finestra Picture in picture viene chiusa (perché il sito web l'ha avviata o perché l'utente l'ha chiusa manualmente). Il gestore eventi è un buon posto per estrarre di nuovo gli elementi dalla finestra Picture in picture, come mostrato qui.

pipButton.addEventListener("click", async () => {
  const player = document.querySelector("#player");

  // Open a Picture-in-Picture window.
  const pipWindow = await documentPictureInPicture.requestWindow();

  // Move the player to the Picture-in-Picture window.
  pipWindow.document.body.append(player);

  // Move the player back when the Picture-in-Picture window closes.
  pipWindow.addEventListener("pagehide", (event) => {
    const playerContainer = document.querySelector("#playerContainer");
    const pipPlayer = event.target.querySelector("#player");
    playerContainer.append(pipPlayer);
  });
});

Chiudi la finestra Picture in picture in modo programmatico utilizzando il metodo close().

// Close the Picture-in-Picture window programmatically.
// The "pagehide" event will fire normally.
pipWindow.close();

Ascoltare quando il sito web entra in modalità PIP

Ascolta l'evento "enter" su documentPictureInPicture per sapere quando viene aperta una finestra Picture in picture. L'evento contiene un oggetto window per accedere alla finestra Picture in picture.

documentPictureInPicture.addEventListener("enter", (event) => {
  const pipWindow = event.window;
});

Accedere agli elementi nella finestra PIP

Accedi agli elementi nella finestra Picture in Picture dall'oggetto restituito da documentPictureInPicture.requestWindow() o con documentPictureInPicture.window.

const pipWindow = documentPictureInPicture.window;
if (pipWindow) {
  // Mute video playing in the Picture-in-Picture window.
  const pipVideo = pipWindow.document.querySelector("#video");
  pipVideo.muted = true;
}

Gestire gli eventi dalla finestra PIP

Crea pulsanti e controlli e rispondi agli eventi di input dell'utente (ad esempio "click"), come sempre in JavaScript.

// Add a "mute" button to the Picture-in-Picture window.
const pipMuteButton = pipWindow.document.createElement("button");
pipMuteButton.textContent = "Mute";
pipMuteButton.addEventListener("click", () => {
  const pipVideo = pipWindow.document.querySelector("#video");
  pipVideo.muted = true;
});
pipWindow.document.body.append(pipMuteButton);

Ridimensionare la finestra PIP

Utilizza i metodi resizeBy() e resizeTo() della finestra per ridimensionare la finestra Picture in picture. Entrambi i metodi richiedono un gesto dell'utente.

const resizeButton = pipWindow.document.createElement('button');
resizeButton.textContent = 'Resize';
resizeButton.addEventListener('click', () => {
  // Expand the Picture-in-Picture window's width by 20px and height by 30px.
  pipWindow.resizeBy(20, 30);
});
pipWindow.document.body.append(resizeButton);

Impostare lo stato attivo sulla finestra di apertura

Utilizza il metodo focus() Finestra per impostare lo stato attivo sulla finestra di apertura dalla finestra Picture in picture. Questo metodo richiede un gesto dell'utente.

const returnToTabButton = pipWindow.document.createElement("button");
returnToTabButton.textContent = "Return to opener tab";
returnToTabButton.addEventListener("click", () => {
  window.focus();
});
pipWindow.document.body.append(returnToTabButton);

Modalità di visualizzazione PIP CSS

Utilizza la modalità di visualizzazione CSS picture-in-picture per scrivere regole CSS specifiche che vengono applicate solo quando (parte della) l'app web viene visualizzata in modalità Picture in picture.

@media all and (display-mode: picture-in-picture) {
  body {
    margin: 0;
  }
  h1 {
    font-size: 0.8em;
  }
}

Rilevamento delle funzionalità

Per verificare se l'API Document Picture-in-Picture è supportata, utilizza:

if ('documentPictureInPicture' in window) {
  // The Document Picture-in-Picture API is supported.
}

Demo

• VideoJS player: prova la demo del video player VideoJS con l'API Document Picture-in-Picture.
• Tomodoro, un'app web pomodoro, sfrutta l'API Document Picture-in-Picture quando disponibile. Consulta la relativa richiesta di pull di GitHub.

Condividi il tuo feedback

Invia segnalazioni su GitHub con suggerimenti e domande.

Link utili

• Spiegazione pubblica
• Specifiche WICG
• Bug di monitoraggio di Chromium
• Voce di ChromeStatus.com
• Componente Blink: Blink>Media>PictureInPicture
• TAG Review
• Intenzione di sperimentare
• Intenzione di spedizione