Aggiungere video utilizzando la funzionalità Picture in picture (PIP)

Prova la funzionalità Scrivi
Jetpack Compose è il toolkit per l'interfaccia utente consigliato per Android. Scopri come supportare la modalità Picture in picture in Scrivi.

A partire da Android 8.0 (livello API 26), Android consente di avviare le attività in modalità Picture in picture (PiP). La modalità PiP è un tipo speciale di modalità multi-finestra utilizzata principalmente per la riproduzione di video. Consente all'utente di guardare un video in una piccola finestra bloccata in un angolo dello schermo mentre naviga tra le app o sfoglia i contenuti sulla schermata principale.

La modalità PIP sfrutta le API multi-finestra rese disponibili in Android 7.0 per fornire la finestra di overlay del video bloccata. Per aggiungere la modalità PiP alla tua app, devi registrare le attività che la supportano, passare alla modalità PiP se necessario e assicurarti che gli elementi dell'interfaccia utente siano nascosti e che la riproduzione dei video continui quando l'attività è in modalità PiP.

La finestra PiP viene visualizzata nel livello più alto dello schermo, in un angolo scelto dal sistema.

La modalità PiP è supportata anche sui dispositivi con sistema operativo Android TV compatibili con Android 14 (livello API 34) o versioni successive. Sebbene esistano molte somiglianze, esistono considerazioni aggiuntive da tenere presenti quando si utilizza la funzionalità PiP sulla TV.

In che modo gli utenti possono interagire con la finestra PiP

Gli utenti possono trascinare la finestra PiP in un'altra posizione. A partire da Android 12, gli utenti possono anche:

  • Tocca una volta la finestra per visualizzare un'opzione di attivazione/disattivazione a schermo intero, un pulsante di chiusura, un pulsante di impostazioni e azioni personalizzate fornite dall'app (ad esempio i controlli di riproduzione).

  • Tocca due volte la finestra per passare dalle dimensioni attuali del PiP a quelle massime o minime. Ad esempio, toccando due volte una finestra ingrandita, la riduci a icona e viceversa.

  • Nascondi la finestra trascinandola sul lato sinistro o destro. Per annullare l'oscuramento della finestra, tocca la parte visibile della finestra nascosta o trascinala verso l'esterno.

  • Ridimensiona la finestra PiP utilizzando la funzionalità pizzica per regolare lo zoom.

L'app controlla quando l'attività corrente entra in modalità PiP. Ecco alcuni esempi:

  • Un'attività può entrare in modalità PiP quando l'utente tocca il pulsante Home o scorri verso l'alto fino alla schermata Home. In questo modo, Google Maps continua a mostrare le indicazioni stradali mentre l'utente esegue contemporaneamente un'altra attività.

  • La tua app può spostare un video in modalità PIP quando l'utente torna dal video per sfogliare altri contenuti.

  • La tua app può passare un video in modalità PiP mentre un utente guarda la fine di un episodio di contenuti. Nella schermata principale vengono visualizzate informazioni promozionali o di riepilogo sull'episodio successivo della serie.

  • La tua app può offrire agli utenti un modo per mettere in coda altri contenuti mentre guardano un video. Il video continua a essere riprodotto in modalità PiP mentre sullo schermo principale viene visualizzata un'attività di selezione dei contenuti.

Dichiarare il supporto di PiP

Per impostazione predefinita, il sistema non supporta automaticamente il PiP per le app. Se vuoi supportare PiP nella tua app, registra la tua attività video nel file manifest impostando android:supportsPictureInPicture su true. Specifica inoltre che la tua attività gestisce le modifiche alla configurazione del layout in modo che non venga riavviata quando si verificano modifiche al layout durante le transizioni alla modalità PiP.

<activity android:name="VideoActivity"
    android:supportsPictureInPicture="true"
    android:configChanges=
        "screenSize|smallestScreenSize|screenLayout|orientation"
    ...

Passare l'attività a PiP

A partire da Android 12, puoi passare l'attività alla modalità PiP impostando il flag setAutoEnterEnabled su true. Con questa impostazione, un'attività passa automaticamente alla modalità PiP in base alle esigenze senza dover chiamare esplicitamente enterPictureInPictureMode() in onUserLeaveHint. Inoltre, offre il vantaggio aggiuntivo di garantire transizioni molto più fluide. Per maggiori dettagli, vedi Rendere più agevoli le transizioni alla modalità PiP dalla navigazione con i gesti.

Se scegli come target Android 11 o versioni precedenti, un'attività deve chiamare enterPictureInPictureMode() per passare alla modalità PiP. Ad esempio, il seguente codice imposta un'attività sulla modalità PiP quando l'utente fa clic su un pulsante dedicato nell'interfaccia utente dell'app:

Kotlin

override fun onActionClicked(action: Action) {
    if (action.id.toInt() == R.id.lb_control_picture_in_picture) {
        activity?.enterPictureInPictureMode()
        return
    }
}

Java

@Override
public void onActionClicked(Action action) {
    if (action.getId() == R.id.lb_control_picture_in_picture) {
        getActivity().enterPictureInPictureMode();
        return;
    }
    ...
}

Potresti includere una logica che inserisca un'attività in modalità PiP anziché in background. Ad esempio, Google Maps passa alla modalità PiP se l'utente preme il pulsante Home o Recenti mentre l'app è in navigazione. Puoi gestire questo caso eseguendo l'override di onUserLeaveHint():

Kotlin

override fun onUserLeaveHint() {
    if (iWantToBeInPipModeNow()) {
        enterPictureInPictureMode()
    }
}

Java

@Override
public void onUserLeaveHint () {
    if (iWantToBeInPipModeNow()) {
        enterPictureInPictureMode();
    }
}

Consigliato: offri agli utenti un'esperienza di transizione PiP raffinata

Android 12 ha apportato notevoli miglioramenti estetici alle transizioni animate tra le finestre a schermo intero e PiP. Ti consigliamo vivamente di implementare tutte le modifiche applicabili. Una volta apportate, queste modifiche verranno adattate automaticamente agli schermi di grandi dimensioni, come i dispositivi pieghevoli e i tablet, senza ulteriori interventi.

Se la tua app non include aggiornamenti applicabili, le transizioni PiP sono ancora funzionali, ma le animazioni sono meno raffinate. Ad esempio, la transizione dalla modalità schermo intero alla modalità PiP può causare la scomparsa della finestra PiP durante la transizione prima che riappaia al termine della transizione.

Queste modifiche riguardano quanto segue.

  • Miglioramento delle transizioni alla modalità PiP dalla navigazione tramite gesti
  • Impostazione di un sourceRectHint appropriato per entrare e uscire dalla modalità PiP
  • Disattivazione del ridimensionamento continuo per i contenuti non video

Consulta l'esempio di PictureInPicture in Kotlin per Android come riferimento per attivare un'esperienza di transizione raffinata.

Rendere più fluide le transizioni alla modalità PiP dalla navigazione tramite gesti

A partire da Android 12, il flag setAutoEnterEnabled offre un'animazione molto più fluida per la transizione ai contenuti video in modalità PiP utilizzando la navigazione con gesti, ad esempio quando scorri verso l'alto per tornare alla home page dalla modalità a schermo intero.

Per apportare questa modifica, segui i passaggi riportati di seguito e consulta questo esempio come riferimento:

  1. Utilizza setAutoEnterEnabled per creare PictureInPictureParams.Builder:

    Kotlin

    setPictureInPictureParams(PictureInPictureParams.Builder()
        .setAspectRatio(aspectRatio)
        .setSourceRectHint(sourceRectHint)
        .setAutoEnterEnabled(true)
        .build())

    Java

    setPictureInPictureParams(new PictureInPictureParams.Builder()
        .setAspectRatio(aspectRatio)
        .setSourceRectHint(sourceRectHint)
        .setAutoEnterEnabled(true)
        .build());
  2. Chiama setPictureInPictureParams con le informazioni aggiornate su PictureInPictureParams in anticipo. L'app non attende il callbackonUserLeaveHint (come avrebbe fatto in Android 11).

    Ad esempio, potresti chiamare setPictureInPictureParams alla prima riproduzione e a tutte le successive se il formato cambia.

  3. Chiama setAutoEnterEnabled(false), ma solo se necessario. Ad esempio, probabilmente non vorrai attivare la modalità PIP se la riproduzione corrente è in stato di pausa.

Impostare un sourceRectHint appropriato per entrare e uscire dalla modalità PiP

A partire dall'introduzione del Picture in picture in Android 8.0, setSourceRectHint indicava l'area dell'attività visibile dopo la transizione al picture-in-picture, ad esempio i limiti della visualizzazione del video in un video player.

Con Android 12, il sistema utilizza sourceRectHint per implementare un'animazione molto più fluida sia quando si entra che quando si esce dalla modalità PiP.

Per impostare correttamente sourceRectHint per entrare ed uscire dalla modalità PiP:

  1. Costruisci PictureInPictureParams utilizzando i limiti appropriati come sourceRectHint. Ti consigliamo inoltre di associare un ascoltatore di modifiche al layout al video player:

    Kotlin

    val mOnLayoutChangeListener =
    OnLayoutChangeListener { v: View?, oldLeft: Int,
            oldTop: Int, oldRight: Int, oldBottom: Int, newLeft: Int, newTop:
            Int, newRight: Int, newBottom: Int ->
        val sourceRectHint = Rect()
        mYourVideoView.getGlobalVisibleRect(sourceRectHint)
        val builder = PictureInPictureParams.Builder()
            .setSourceRectHint(sourceRectHint)
        setPictureInPictureParams(builder.build())
    }
    
    mYourVideoView.addOnLayoutChangeListener(mOnLayoutChangeListener)

    Java

    private final View.OnLayoutChangeListener mOnLayoutChangeListener =
            (v, oldLeft, oldTop, oldRight, oldBottom, newLeft, newTop, newRight,
            newBottom) -> {
        final Rect sourceRectHint = new Rect();
        mYourVideoView.getGlobalVisibleRect(sourceRectHint);
        final PictureInPictureParams.Builder builder =
            new PictureInPictureParams.Builder()
                .setSourceRectHint(sourceRectHint);
        setPictureInPictureParams(builder.build());
    };
    
    mYourVideoView.addOnLayoutChangeListener(mOnLayoutChangeListener);
  2. Se necessario, aggiorna sourceRectHint prima che il sistema avvii la transizione di uscita. Quando il sistema sta per uscire dalla modalità PiP, la gerarchia delle visualizzazioni dell'attività viene organizzata in base alla configurazione di destinazione (ad esempio, schermo intero). L'app può associare un listener per le modifiche al layout alla vista principale o alla vista di destinazione (ad esempio la visualizzazione del player video) per rilevare l'evento e aggiornare sourceRectHint prima dell'inizio dell'animazione.

    Kotlin

    // Listener is called immediately after the user exits PiP but before animating.
    playerView.addOnLayoutChangeListener { _, left, top, right, bottom,
                        oldLeft, oldTop, oldRight, oldBottom ->
        if (left != oldLeft
            || right != oldRight
            || top != oldTop
            || bottom != oldBottom) {
            // The playerView's bounds changed, update the source hint rect to
            // reflect its new bounds.
            val sourceRectHint = Rect()
            playerView.getGlobalVisibleRect(sourceRectHint)
            setPictureInPictureParams(
                PictureInPictureParams.Builder()
                    .setSourceRectHint(sourceRectHint)
                    .build()
            )
        }
    }

    Java

    // Listener is called right after the user exits PiP but before animating.
    playerView.addOnLayoutChangeListener((v, left, top, right, bottom,
                        oldLeft, oldTop, oldRight, oldBottom) -> {
        if (left != oldLeft
            || right != oldRight
            || top != oldTop
            || bottom != oldBottom) {
            // The playerView's bounds changed, update the source hint rect to
            // reflect its new bounds.
            final Rect sourceRectHint = new Rect();
            playerView.getGlobalVisibleRect(sourceRectHint);
            setPictureInPictureParams(
                new PictureInPictureParams.Builder()
                    .setSourceRectHint(sourceRectHint)
                    .build());
        }
    });

Disattivare il ridimensionamento automatico per i contenuti non video

Android 12 aggiunge il flag setSeamlessResizeEnabled, che offre un'animazione di transizione molto più fluida quando si ridimensionano i contenuti non video nella finestra PiP. In precedenza, il ridimensionamento dei contenuti non video in una finestra PiP poteva creare degli artefatti visivi fastidiosi.

Per disattivare il ridimensionamento continuo per i contenuti non video:

Kotlin

setPictureInPictureParams(PictureInPictureParams.Builder()
    .setSeamlessResizeEnabled(false)
    .build())

Java

setPictureInPictureParams(new PictureInPictureParams.Builder()
    .setSeamlessResizeEnabled(false)
    .build());

Gestire l'interfaccia utente durante il PIP

Quando l'attività entra o esce dalla modalità Picture in picture (PiP), il sistema chiama Activity.onPictureInPictureModeChanged() o Fragment.onPictureInPictureModeChanged().

Android 15 introduce modifiche che garantiscono una transizione ancora più fluida quando si accede alla modalità PiP. Questo è utile per le app che hanno elementi dell'interfaccia utente sovrapposti all'interfaccia utente principale, che passa in PiP.

Gli sviluppatori utilizzano il callback onPictureInPictureModeChanged() per definire la logica che attiva/disattiva la visibilità degli elementi dell'interfaccia utente sovrapposti. Questo callback viene attivato al termine dell'animazione di entrata o uscita in PiP. A partire da Android 15, la classe PictureInPictureUiState include un nuovo stato.

Con questo nuovo stato dell'interfaccia utente, le app che hanno come target Android 15 osservano il callback Activity#onPictureInPictureUiStateChanged() che viene invocato con isTransitioningToPip() non appena inizia l'animazione PiP. Esistono molti elementi dell'interfaccia utente che non sono pertinenti per l'app quando è in modalità PiP, ad esempio visualizzazioni o layout che includono informazioni come suggerimenti, video in programma, valutazioni e titoli. Quando l'app passa alla modalità PiP, utilizza il callback onPictureInPictureUiStateChanged() per nascondere questi elementi dell'interfaccia utente. Quando l'app passa alla modalità a schermo intero dalla finestra PiP, utilizza il callback onPictureInPictureModeChanged() per mostrare nuovamente questi elementi, come mostrato negli esempi seguenti:

Kotlin

override fun onPictureInPictureUiStateChanged(pipState: PictureInPictureUiState) {
        if (pipState.isTransitioningToPip()) {
          // Hide UI elements.
        }
    }

Java

@Override
public void onPictureInPictureUiStateChanged(PictureInPictureUiState pipState) {
        if (pipState.isTransitioningToPip()) {
          // Hide UI elements.
        }
    }

Kotlin

override fun onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean) {
        if (isInPictureInPictureMode) {
          // Unhide UI elements.
        }
    }

Java

@Override
public void onPictureInPictureModeChanged(boolean isInPictureInPictureMode) {
        if (isInPictureInPictureMode) {
          // Unhide UI elements.
        }
    }

Questa rapida attivazione/disattivazione della visibilità degli elementi dell'interfaccia utente irrilevanti (per una finestra PiP) contribuisce a garantire un'animazione di entrata PiP più fluida e senza sfarfallio.

Sostituisci questi callback per ridisegnare gli elementi dell'interfaccia utente dell'attività. Tieni presente che, in modalità PiP, la tua attività viene mostrata in una piccola finestra. Gli utenti non possono interagire con gli elementi dell'interfaccia utente dell'app quando l'app è in modalità PiP e i dettagli di piccoli elementi dell'interfaccia utente possono essere difficili da vedere. Le attività di riproduzione video con un'interfaccia utente minima offrono la migliore esperienza utente.

Se la tua app deve fornire azioni personalizzate per il PiP, consulta la sezione Aggiungere controlli in questa pagina. Rimuovi gli altri elementi dell'interfaccia utente prima che l'attività entri in PiP e ripristinali quando l'attività torna a essere a schermo intero.

Aggiungi controlli

La finestra PiP può mostrare i controlli quando l'utente apre il menu della finestra (facendo tap sulla finestra su un dispositivo mobile o selezionando il menu dal telecomando della TV).

Se un'app ha una sessione multimediale attiva, vengono visualizzati i controlli di riproduzione, pausa, avanti e indietro.

Puoi anche specificare azioni personalizzate in modo esplicito creando PictureInPictureParams con PictureInPictureParams.Builder.setActions() prima di entrare in modalità PiP e passando i parametri quando entri in modalità PiP utilizzando enterPictureInPictureMode(android.app.PictureInPictureParams) o setPictureInPictureParams(android.app.PictureInPictureParams). Fai attenzione. Se provi ad aggiungere più di getMaxNumPictureInPictureActions(), visualizzerai solo il numero massimo.

Riprodurre un video in modalità PiP

Quando l'attività passa a PiP, il sistema la inserisce in stato di pausa e chiama il metodo onPause() dell'attività. La riproduzione del video non deve essere messa in pausa, ma deve continuare se l'attività viene messa in pausa durante la transizione alla modalità PiP.

In Android 7.0 e versioni successive, dovresti mettere in pausa e riprendere la riproduzione dei video quando il sistema chiama onStop() e onStart() della tua attività. In questo modo, puoi evitare di dover controllare se la tua app è in modalità PiP in onPause() e proseguire esplicitamente la riproduzione.

Se non hai impostato il flag setAutoEnterEnabled su true e devi mettere in pausa la riproduzione nell'implementazione di onPause(), controlla la modalità PiP chiamando isInPictureInPictureMode() e gestisci la riproduzione in modo appropriato. Ad esempio:

Kotlin

override fun onPause() {
    super.onPause()
    // If called while in PiP mode, do not pause playback.
    if (isInPictureInPictureMode) {
        // Continue playback.
    } else {
        // Use existing playback logic for paused activity behavior.
    }
}

Java

@Override
public void onPause() {
    // If called while in PiP mode, do not pause playback.
    if (isInPictureInPictureMode()) {
        // Continue playback.
        ...
    } else {
        // Use existing playback logic for paused activity behavior.
        ...
    }
}

Quando l'attività esce dalla modalità PiP e torna alla modalità a schermo intero, il sistema riprende l'attività e chiama il metodo onResume().

Utilizzare una singola attività di riproduzione per PiP

Nella tua app, un utente potrebbe selezionare un nuovo video mentre cerca contenuti nella schermata principale, mentre un'attività di riproduzione video è in modalità PiP. Riproduci il nuovo video nell'attività di riproduzione esistente in modalità a schermo intero, anziché avviare una nuova attività che potrebbe confondere l'utente.

Per assicurarti che venga utilizzata una singola attività per le richieste di riproduzione dei video e che la modalità PiP venga attivata o disattivata in base alle esigenze, imposta android:launchMode su singleTask nel file manifest:

<activity android:name="VideoActivity"
    ...
    android:supportsPictureInPicture="true"
    android:launchMode="singleTask"
    ...

Nella tua attività, sostituisci onNewIntent() e gestisci il nuovo video, interrompendo se necessario la riproduzione di eventuali video esistenti.

Best practice

La modalità PiP potrebbe essere disattivata sui dispositivi con poca RAM. Prima che la tua app utilizzi PiP, verifica che sia disponibile chiamando hasSystemFeature(PackageManager.FEATURE_PICTURE_IN_PICTURE).

La modalità PiP è pensata per le attività che riproducono video a schermo intero. Quando attivi la modalità PiP per la tua attività, evita di mostrare altro oltre ai contenuti video. Monitora quando la tua attività entra in modalità PiP e nascondi gli elementi dell'interfaccia utente, come descritto in Gestire l'interfaccia utente durante la modalità PiP.

Quando un'attività è in modalità PiP, per impostazione predefinita non riceve lo stato attivo per l'input. Per ricevere gli eventi di input in modalità PiP, utilizza MediaSession.setCallback(). Per ulteriori informazioni sull'utilizzo di setCallback(), vedi Visualizzare una scheda Now Playing.

Quando la tua app è in modalità PiP, la riproduzione del video nella finestra PiP può causare interferenze audio con un'altra app, ad esempio un'app di riproduzione di musica o di ricerca vocale. Per evitare questo problema, richiedi l'attenzione audio quando inizi a riprodurre il video e gestisci le notifiche di modifica dell'attenzione audio, come descritto in Gestire l'attenzione audio. Se ricevi una notifica di perdita dell'attenzione audio in modalità PiP, metti in pausa o interrompi la riproduzione del video.

Quando l'app sta per entrare in modalità PiP, tieni presente che solo l'attività in primo piano viene visualizzata in modalità PiP. In alcuni casi, ad esempio sui dispositivi con più finestre, è possibile che l'attività riportata di seguito venga visualizzata e torni visibile insieme all'attività PiP. Devi gestire questa richiesta di conseguenza, inclusa l'attività di seguito per ricevere un onResume() o un onPause(). È anche possibile che l'utente interagisca con l'attività. Ad esempio, se hai visualizzato un'attività di elenco di video e l'attività di riproduzione di un video in modalità PiP, l'utente potrebbe selezionare un nuovo video dall'elenco e l'attività PiP dovrebbe aggiornarsi di conseguenza.

Codice di esempio aggiuntivo

Per scaricare un'app di esempio scritta in Kotlin, consulta Esempio di PictureInPicture Android (Kotlin).