PictureInPictureProvider

Kotlin |Java

interface PictureInPictureProvider : OnPictureInPictureModeChangedProvider, OnPictureInPictureUiStateChangedProvider, OnUserLeaveHintProvider

Known direct subclasses

ComponentActivity

ComponentActivity

Base class for activities that enables composition of higher level components.

Known indirect subclasses

AppCompatActivity, BaseCarAppActivity, CarAppActivity, FragmentActivity, LauncherActivity, PreviewActivity

`AppCompatActivity`	Base class for activities that wish to use some of the newer platform features on older Android devices.
`BaseCarAppActivity`	Core logic for CarAppLibrary Activity interaction with a host.
`CarAppActivity`	The class representing a car app activity in the main display.
`FragmentActivity`	Base class for activities that want to use the support-based `Fragments`.
`LauncherActivity`	This class handles providing the right launcher activity when running native applications and Car App Library applications.
`PreviewActivity`	Activity used to run `@Composable` previews from Android Studio.

Provider interface to support PiP (Picture-in-Picture) functionalities.

Summary

Public functions
`Unit`	`enterPictureInPictureMode(params: PictureInPictureParamsCompat)` Available since API 24 in the framework Activity class, puts the activity in picture-in-picture mode if possible in the current system state.
`Unit`	`setPictureInPictureParams(params: PictureInPictureParamsCompat)` Available since API 26 in the framework Activity class, updates the properties of the picture-in-picture activity, or sets it to be used later when `enterPictureInPictureMode` is called

Inherited functions

From androidx.core.app.OnPictureInPictureModeChangedProvider

`Unit`	`addOnPictureInPictureModeChangedListener( listener: Consumer<PictureInPictureModeChangedInfo> )` Add a new listener that will get a callback associated with `Activity.onPictureInPictureModeChanged` with the new `PictureInPictureModeChangedInfo`.
`Unit`	`removeOnPictureInPictureModeChangedListener( listener: Consumer<PictureInPictureModeChangedInfo> )` Remove a previously added listener.

From androidx.core.app.OnPictureInPictureUiStateChangedProvider

`Unit`	`addOnPictureInPictureUiStateChangedListener( listener: Consumer<PictureInPictureUiStateCompat> )` Add a new listener that will get a callback associated with `Activity.onPictureInPictureUiStateChanged` with the new `PictureInPictureUiStateCompat`.
`Unit`	`removeOnPictureInPictureUiStateChangedListener( listener: Consumer<PictureInPictureUiStateCompat> )` Remove a previously added listener.

From androidx.core.app.OnUserLeaveHintProvider

`Unit`	`addOnUserLeaveHintListener(listener: Runnable)` Add a new listener that will get a callback associated with `Activity.onUserLeaveHint`
`Unit`	`removeOnUserLeaveHintListener(listener: Runnable)` Remove a previously added listener.

Public functions

enterPictureInPictureMode

Added in 1.18.0-alpha01

fun enterPictureInPictureMode(params: PictureInPictureParamsCompat): Unit

Available since API 24 in the framework Activity class, puts the activity in picture-in-picture mode if possible in the current system state. Any prior calls to setPictureInPictureParams will still apply when entering picture-in-picture through this call.

setPictureInPictureParams

Added in 1.18.0-alpha01

fun setPictureInPictureParams(params: PictureInPictureParamsCompat): Unit

Available since API 26 in the framework Activity class, updates the properties of the picture-in-picture activity, or sets it to be used later when enterPictureInPictureMode is called

Parameters
`params: PictureInPictureParamsCompat`	`PictureInPictureParams` to use for picture-in-picture mode.