Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.

PictureInPictureParams.Builder

public static class PictureInPictureParams.Builder
extends Object

java.lang.Object
   ↳ android.app.PictureInPictureParams.Builder


Builder class for PictureInPictureParams objects.

Summary

Public constructors

PictureInPictureParams.Builder()

Public methods

PictureInPictureParams build()
PictureInPictureParams.Builder setActions(List<RemoteAction> actions)

Sets the user actions.

PictureInPictureParams.Builder setAspectRatio(Rational aspectRatio)

Sets the aspect ratio.

PictureInPictureParams.Builder setSourceRectHint(Rect launchBounds)

Sets the source bounds hint.

Inherited methods

Public constructors

PictureInPictureParams.Builder

added in API level 26
public PictureInPictureParams.Builder ()

Public methods

build

added in API level 26
public PictureInPictureParams build ()

Returns
PictureInPictureParams an immutable PictureInPictureParams to be used when entering or updating the activity in picture-in-picture.

setActions

added in API level 26
public PictureInPictureParams.Builder setActions (List<RemoteAction> actions)

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

Parameters
actions List: the new actions to show in the picture-in-picture menu.

Returns
PictureInPictureParams.Builder this builder instance.

See also:

setAspectRatio

added in API level 26
public PictureInPictureParams.Builder setAspectRatio (Rational aspectRatio)

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

Returns
PictureInPictureParams.Builder this builder instance.

setSourceRectHint

added in API level 26
public PictureInPictureParams.Builder setSourceRectHint (Rect launchBounds)

Sets the source bounds hint. These bounds are only used when an activity first enters picture-in-picture, and describe the bounds in window coordinates of activity entering picture-in-picture that will be visible following the transition. For the best effect, these bounds should also match the aspect ratio in the arguments.

Parameters
launchBounds Rect: window-coordinate bounds indicating the area of the activity that will still be visible following the transition into picture-in-picture (eg. the video view bounds in a video player)

Returns
PictureInPictureParams.Builder this builder instance.