PictureInPictureDelegate

Kotlin |Java

open class PictureInPictureDelegate

Known direct subclasses

BasicPictureInPicture

Basic Picture-in-Picture implementation.

Known indirect subclasses

VideoPlaybackPictureInPicture

Picture-in-Picture implementation optimized for Video Playback applications.

A delegate class to help set up PiP (Picture-in-Picture) functionalities on behalf of the given PictureInPictureProvider instance.

It's highly recommended to choose one of the implementations: BasicPictureInPicture, VideoPlaybackPictureInPicture instead of using this class directly.

Summary

Nested types
`class PictureInPictureDelegate.Event` Represents the PiP event emitted from the system.
`interface PictureInPictureDelegate.OnPictureInPictureEventListener` Unified listener interface for `Activity.onPictureInPictureModeChanged` and `Activity.onPictureInPictureUiStateChanged` callbacks.

Public constructors
`PictureInPictureDelegate( pictureInPictureProvider: PictureInPictureProvider )`

Public functions
`Unit`	`addOnPictureInPictureEventListener( executor: Executor, listener: PictureInPictureDelegate.OnPictureInPictureEventListener )` Adds `OnPictureInPictureEventListener` for events sent from system.
`Unit`	`removeOnPictureInPictureEventListener( listener: PictureInPictureDelegate.OnPictureInPictureEventListener )` Removes `OnPictureInPictureEventListener` for events sent from system.
`Unit`	`setPictureInPictureParams( pictureInPictureParamsCompat: PictureInPictureParamsCompat )` Sets the `PictureInPictureParamsCompat` instance for PiP.

PictureInPictureDelegate(
    pictureInPictureProvider: PictureInPictureProvider
)

Parameters
`pictureInPictureProvider: PictureInPictureProvider`	`PictureInPictureProvider` instance that this delegate will call into for actual Picture-in-Picture functionalities.

fun addOnPictureInPictureEventListener(
    executor: Executor,
    listener: PictureInPictureDelegate.OnPictureInPictureEventListener
): Unit

Adds OnPictureInPictureEventListener for events sent from system.

fun removeOnPictureInPictureEventListener(
    listener: PictureInPictureDelegate.OnPictureInPictureEventListener
): Unit

Removes OnPictureInPictureEventListener for events sent from system.

fun setPictureInPictureParams(
    pictureInPictureParamsCompat: PictureInPictureParamsCompat
): Unit

Sets the PictureInPictureParamsCompat instance for PiP.

Parameters
`pictureInPictureParamsCompat: PictureInPictureParamsCompat`	`PictureInPictureParamsCompat` instance to set, and it's subjected to be changed. For instance, the aspectRatio would be capped in between the minimal and maximum allowed aspectRatio; and the sourceRectHint would be center cropped to match the aspectRatio.