BasicPictureInPicture

Kotlin |Java

public class BasicPictureInPicture extends PictureInPictureDelegate

java.lang.Object
↳	androidx.core.pip.PictureInPictureDelegate
	↳	androidx.core.pip.BasicPictureInPicture

Known direct subclasses

VideoPlaybackPictureInPicture

VideoPlaybackPictureInPicture

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

Basic Picture-in-Picture implementation.

Configures PiP with a specific aspect ratio, custom actions, and controls enter behavior. Seamless resize is disabled and no sourceRectHint is used.

Summary

Public constructors
`BasicPictureInPicture( @NonNull PictureInPictureProvider pictureInPictureProvider )`

Public methods
`final @NonNull BasicPictureInPicture`	`setActions(@NonNull List<@NonNull RemoteAction> actions)` Sets the custom actions to be available in the Picture-in-Picture menu.
`final @NonNull BasicPictureInPicture`	`setAspectRatio(@NonNull Rational aspectRatio)` Sets the desired aspect ratio for the Picture-in-Picture window.
`final @NonNull BasicPictureInPicture`	`setEnabled(boolean enabled)` Sets whether the activity should automatically enter Picture-in-Picture mode when eligible (e.g., when swiping to home).

Protected methods
`final @NonNull PictureInPictureParamsCompat.Builder`	`getPictureInPictureParamsBuilder()`

Inherited methods

From androidx.core.pip.PictureInPictureDelegate

`final void`	`addOnPictureInPictureEventListener( @NonNull Executor executor, @NonNull PictureInPictureDelegate.OnPictureInPictureEventListener listener )` Adds `OnPictureInPictureEventListener` for events sent from system.
`final void`	`removeOnPictureInPictureEventListener( @NonNull PictureInPictureDelegate.OnPictureInPictureEventListener listener )` Removes `OnPictureInPictureEventListener` for events sent from system.
`final void`	`setPictureInPictureParams( @NonNull PictureInPictureParamsCompat pictureInPictureParamsCompat )` Sets the `PictureInPictureParamsCompat` instance for PiP.

Public constructors

BasicPictureInPicture

Added in 1.0.0-alpha02

public BasicPictureInPicture(
    @NonNull PictureInPictureProvider pictureInPictureProvider
)

Public methods

setActions

Added in 1.0.0-alpha02

public final @NonNull BasicPictureInPicture setActions(@NonNull List<@NonNull RemoteAction> actions)

Sets the custom actions to be available in the Picture-in-Picture menu.

Parameters
`@NonNull List<@NonNull RemoteAction> actions`	A list of RemoteActions.

Returns
`@NonNull BasicPictureInPicture`	This implementation instance for chaining.

setAspectRatio

Added in 1.0.0-alpha02

public final @NonNull BasicPictureInPicture setAspectRatio(@NonNull Rational aspectRatio)

Sets the desired aspect ratio for the Picture-in-Picture window.

Parameters
`@NonNull Rational aspectRatio`	The desired width/height ratio.

Returns
`@NonNull BasicPictureInPicture`	This implementation instance for chaining.

setEnabled

Added in 1.0.0-alpha02

public final @NonNull BasicPictureInPicture setEnabled(boolean enabled)

Sets whether the activity should automatically enter Picture-in-Picture mode when eligible (e.g., when swiping to home). This indicates the "willingness to enter PiP".

Parameters
`boolean enabled`	True if the Activity is PiP-able, false otherwise.

Returns
`@NonNull BasicPictureInPicture`	This implementation instance for chaining.

Protected methods

getPictureInPictureParamsBuilder

Added in 1.0.0-alpha02

protected final @NonNull PictureInPictureParamsCompat.Builder getPictureInPictureParamsBuilder()