Builder

Builder

Builder()

Default constructor

Builder

Builder(original: PictureInPictureParams)

Copy constructor

build

open fun build(): PictureInPictureParams!

setActions

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.

setAspectRatio

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.

setAutoEnterEnabled

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.

setCloseAction

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.

setExpandedAspectRatio

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

setSeamlessResizeEnabled

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.

setSourceRectHint

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.

setSubtitle

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.

setTitle

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.