Added in API level 26

Builder

class Builder
kotlin.Any
   ↳ android.app.PictureInPictureParams.Builder

Builder class for PictureInPictureParams objects.

Summary

Public constructors

Default constructor

Copy constructor
Public methods
open PictureInPictureParams!

open PictureInPictureParams.Builder!

Sets the user actions.
open PictureInPictureParams.Builder
setActions(actions: MutableList<RemoteAction!>?, primaryAction: RemoteAction?)

Sets the user actions and a primary action.
open PictureInPictureParams.Builder!
setAspectRatio(aspectRatio: Rational!)

Sets the aspect ratio.
open PictureInPictureParams.Builder
setAutoEnterEnabled(autoEnterEnabled: Boolean)

Sets whether the system will automatically put the activity in picture-in-picture mode without needing/waiting for the activity to call Activity.enterPictureInPictureMode(PictureInPictureParams).
open PictureInPictureParams.Builder

Sets a close action that should be invoked before the default close PiP action.
open PictureInPictureParams.Builder
setExpandedAspectRatio(expandedAspectRatio: Rational?)

Sets the aspect ratio for the expanded picture-in-picture mode.
open PictureInPictureParams.Builder
setOverlayActions(overlayActions: MutableList<RemoteAction!>?, primaryOverlayAction: RemoteAction?)

Sets the overlay actions and a primary overlay action.
open PictureInPictureParams.Builder
setSeamlessResizeEnabled(seamlessResizeEnabled: Boolean)

Sets whether the system can seamlessly resize the window while the activity is in picture-in-picture mode.
open PictureInPictureParams.Builder!
setSourceRectHint(launchBounds: Rect!)

Sets the window-coordinate bounds of an activity transitioning to picture-in-picture.
open PictureInPictureParams.Builder

Sets a subtitle for the picture-in-picture window, which may be displayed by the system to give the user more detailed information about what this PIP is displaying.
open PictureInPictureParams.Builder

Sets a title for the picture-in-picture window, which may be displayed by the system to give the user information about what this PIP is generally being used for.

Public constructors

Builder

Added in API level 26
Builder()

Default constructor

Builder

Added in API level 33
Builder(original: PictureInPictureParams)

Copy constructor

Parameters
original PictureInPictureParams: PictureInPictureParams instance this builder is built upon.
This value cannot be null.

Public methods

build

Added in API level 26
open fun build(): PictureInPictureParams!
Return
PictureInPictureParams! an immutable PictureInPictureParams to be used when entering or updating the activity in picture-in-picture.

setActions

Added in API level 26
open fun setActions(actions: MutableList<RemoteAction!>!): PictureInPictureParams.Builder!

Sets the user actions. If there are more than Activity.getMaxNumPictureInPictureActions() actions, then the input list will be truncated to that number.

Parameters
actions MutableList<RemoteAction!>!: the new actions to show in the picture-in-picture menu.
Return
PictureInPictureParams.Builder! this builder instance.

setActions

Added in API level 37.2
open fun setActions(
    actions: MutableList<RemoteAction!>?, 
    primaryAction: RemoteAction?
): PictureInPictureParams.Builder

Sets the user actions and a primary action. If there are more than Activity.getMaxNumPictureInPictureActions() actions, then the input list will be truncated to that number.

If the primary action is valid, the system would use a modern UI for the PiP menu.

Parameters
actions MutableList<RemoteAction!>?: the new actions to show in the picture-in-picture menu.
This value may be null.
primaryAction RemoteAction?: to be used as the primary action in the PiP menu. This action MUST be one of the actions set via actions.
This value may be null.
Return
PictureInPictureParams.Builder this builder instance.
This value cannot be null.

setAspectRatio

Added in API level 26
open fun setAspectRatio(aspectRatio: Rational!): PictureInPictureParams.Builder!

Sets the aspect ratio. This aspect ratio is defined as the desired width / height, and does not change upon device rotation.

Parameters
aspectRatio Rational!: the new aspect ratio for the activity in picture-in-picture, must be between 2.39:1 and 1:2.39 (inclusive).
Return
PictureInPictureParams.Builder! this builder instance.

setAutoEnterEnabled

Added in API level 31
open fun setAutoEnterEnabled(autoEnterEnabled: Boolean): PictureInPictureParams.Builder

Sets whether the system will automatically put the activity in picture-in-picture mode without needing/waiting for the activity to call Activity.enterPictureInPictureMode(PictureInPictureParams). If true, Activity.onPictureInPictureRequested() will never be called. This property is false by default.

Parameters
autoEnterEnabled Boolean: true if the system will automatically put the activity in picture-in-picture mode.
Return
PictureInPictureParams.Builder this builder instance.
This value cannot be null.

setCloseAction

Added in API level 33
open fun setCloseAction(action: RemoteAction?): PictureInPictureParams.Builder

Sets a close action that should be invoked before the default close PiP action. The custom action must close the activity quickly using Activity.finish(). Otherwise, the system will forcibly close the PiP as if no custom close action was provided. If the action matches one set via PictureInPictureParams.Builder.setActions(List) it may be shown in place of that custom action in the menu.

Parameters
action RemoteAction?: to replace the system close action.
This value may be null.
Return
PictureInPictureParams.Builder this builder instance.
This value cannot be null.

setExpandedAspectRatio

Added in API level 33
open fun setExpandedAspectRatio(expandedAspectRatio: Rational?): PictureInPictureParams.Builder

Sets the aspect ratio for the expanded picture-in-picture mode. The aspect ratio is defined as the desired width / height.
The aspect ratio cannot be changed from horizontal to vertical or vertical to horizontal while the PIP is shown. Any such changes will be ignored.
Setting the expanded ratio shows the activity's support for expanded mode.
Requires the PackageManager#FEATURE_EXPANDED_PICTURE_IN_PICTURE feature which can be detected using PackageManager.hasSystemFeature(String).

Parameters
expandedAspectRatio Rational?: must not be between 2.39:1 and 1:2.39 (inclusive). If null, expanded picture-in-picture mode is not supported.
Return
PictureInPictureParams.Builder this builder instance.
This value cannot be null.

setOverlayActions

Added in API level 37.2
open fun setOverlayActions(
    overlayActions: MutableList<RemoteAction!>?, 
    primaryOverlayAction: RemoteAction?
): PictureInPictureParams.Builder

Sets the overlay actions and a primary overlay action. If there are more than Activity.getMaxNumPictureInPictureOverlayActions() actions, then the input list will be truncated to that number.

Unlike the standard actions set via setActions(List), these actions are rendered prominently as an overlay and are visible without requiring the user to tap on the window to reveal the menu.

Parameters
overlayActions MutableList<RemoteAction!>?: The actions to show in the picture-in-picture window overlay. Typically, for a media app, this action list can contain a Call-To-Action (CTA) and Skip action.
This value may be null.
primaryOverlayAction RemoteAction?: The action to be used as the primary action in the picture-in-picture window overlay. This action MUST be one of the actions set via overlayActions. For instance, a media app can use this to highlight a Call-to-Action (CTA) button while an ad is playing.
This value may be null.
Return
PictureInPictureParams.Builder this builder instance.
This value cannot be null.

setSeamlessResizeEnabled

Added in API level 31
open fun setSeamlessResizeEnabled(seamlessResizeEnabled: Boolean): PictureInPictureParams.Builder

Sets whether the system can seamlessly resize the window while the activity is in picture-in-picture mode. This should normally be the case for video content and when it's set to false, system will perform transitions to overcome the artifacts due to resize. This property is true by default for backwards compatibility.

Parameters
seamlessResizeEnabled Boolean: true if the system can seamlessly resize the window while activity is in picture-in-picture mode.
Return
PictureInPictureParams.Builder this builder instance.
This value cannot be null.

setSourceRectHint

Added in API level 26
open fun setSourceRectHint(launchBounds: Rect!): PictureInPictureParams.Builder!

Sets the window-coordinate bounds of an activity transitioning to picture-in-picture. The bounds is the area of an activity that will be visible in the transition to picture-in-picture mode. For the best effect, these bounds should also match the aspect ratio in the arguments. In Android 12+ these bounds are also reused to improve the exit transition from picture-in-picture mode. See Support smoother animations when exiting out of PiP mode for more details.

Parameters
launchBounds Rect!: window-coordinate bounds indicating the area of the activity that will still be visible following the transition into picture-in-picture (e.g. the video view bounds in a video player)
Return
PictureInPictureParams.Builder! this builder instance.

setSubtitle

Added in API level 33
open fun setSubtitle(subtitle: CharSequence?): PictureInPictureParams.Builder

Sets a subtitle for the picture-in-picture window, which may be displayed by the system to give the user more detailed information about what this PIP is displaying.
Setting a title via PictureInPictureParams.Builder.setTitle(CharSequence) should be prioritized. Subtitles longer than 1024 characters (default) are automatically truncated.

Parameters
subtitle CharSequence?: Details about the PIP content.
This value may be null.
Return
PictureInPictureParams.Builder this builder instance.
This value cannot be null.

setTitle

Added in API level 33
open fun setTitle(title: CharSequence?): PictureInPictureParams.Builder

Sets a title for the picture-in-picture window, which may be displayed by the system to give the user information about what this PIP is generally being used for. Titles longer than 1024 characters (default) are automatically truncated.

Parameters
title CharSequence?: General information about the PIP content.
This value may be null.
Return
PictureInPictureParams.Builder this builder instance.
This value cannot be null.