PictureInPictureProvider

Kotlin |Java

public interface PictureInPictureProvider extends 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

`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.

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

Summary

Public methods
`abstract void`	`enterPictureInPictureMode(@NonNull PictureInPictureParamsCompat params)` Available since API 24 in the framework Activity class, puts the activity in picture-in-picture mode if possible in the current system state.
`abstract void`	`setPictureInPictureParams(@NonNull PictureInPictureParamsCompat params)` 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 methods

From androidx.core.app.OnPictureInPictureModeChangedProvider

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

From androidx.core.app.OnPictureInPictureUiStateChangedProvider

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

From androidx.core.app.OnUserLeaveHintProvider

`abstract void`	`addOnUserLeaveHintListener(@NonNull Runnable listener)` Add a new listener that will get a callback associated with `Activity.onUserLeaveHint`
`abstract void`	`removeOnUserLeaveHintListener(@NonNull Runnable listener)` Remove a previously added listener.

Public methods

enterPictureInPictureMode

Added in 1.18.0-alpha01

abstract void enterPictureInPictureMode(@NonNull PictureInPictureParamsCompat params)

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

abstract void setPictureInPictureParams(@NonNull PictureInPictureParamsCompat params)

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
`@NonNull PictureInPictureParamsCompat params`	`PictureInPictureParams` to use for picture-in-picture mode.