About picture-in-picture (PiP)

Picture-in-picture (PiP) is a special type of multi-window mode mostly used for video playback. It lets the user watch a video in a small window pinned to a corner of the screen while navigating between apps or browsing content on the main screen.

PiP leverages the multi-window APIs made available in Android 7.0 to provide the pinned video overlay window. To add PiP to your app, you need to register your activity, switch your activity to PiP mode as needed, and make sure UI elements are hidden and video playback continues when the activity is in PiP mode.

Implement PiP with Jetpack

Use the Jetpack Picture-in-Picture library to implement picture-in-picture experience as it streamlines integration and reduces common in-app issues. Refer to our platform sample app to see an example of its usage. However, if you prefer to implement PiP using the platform APIs, refer to the following documentation.

Handle your UI in PiP mode

When you enter PiP mode, your app's entire UI enters the PiP window unless you specify how your UI should look in and out of PiP mode.

First, you need to know when your app is in PiP mode or not. You can use OnPictureInPictureModeChangedProvider to achieve this. The following code checks whether your app is in PiP mode.

@Composable
funrememberIsInPipMode():Boolean{
if(Build.VERSION.SDK_INT>=Build.VERSION_CODES.O){
valactivity=LocalContext.current.findActivity()
varpipModebyremember{mutableStateOf(activity.isInPictureInPictureMode)}
DisposableEffect(activity){
valobserver=Consumer<PictureInPictureModeChangedInfo>{info->
pipMode=info.isInPictureInPictureMode
}
activity.addOnPictureInPictureModeChangedListener(
observer
)
onDispose{activity.removeOnPictureInPictureModeChangedListener(observer)}
}
returnpipMode
}else{
returnfalse
}
}
PictureInPictureSnippets.kt 

Now, you can use rememberIsInPipMode() to toggle which UI elements to show when the app enters PiP mode:

valinPipMode=rememberIsInPipMode()
Column(modifier=modifier){
// This text will only show up when the app is not in PiP mode
if(!inPipMode){
Text(
text="Picture in Picture",
)
}
VideoPlayer()
}
PictureInPictureSnippets.kt