PictureInPictureParams

Kotlin |Java

class PictureInPictureParams : Parcelable

kotlin.Any
↳	android.app.PictureInPictureParams

Represents a set of parameters used to initialize and update an Activity in picture-in-picture mode.

Summary

Nested classes
	`Builder` Builder class for `PictureInPictureParams` objects.

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
Int	`describeContents()`
Boolean	`equals(other: Any?)`
MutableList<RemoteAction!>	`getActions()` Returns the list of user actions that are associated with the activity when in picture-in-picture mode.
Rational?	`getAspectRatio()` Returns the expected aspect ratio of the picture-in-picture window.
RemoteAction?	`getCloseAction()` Returns the action that is to replace the system close action.
Rational?	`getExpandedAspectRatio()` Returns the desired aspect ratio of the expanded picture-in-picture window.
Rect?	`getSourceRectHint()` Returns the source rect hint.
CharSequence?	`getSubtitle()` Returns the subtitle of the picture-in-picture window that may be displayed to the user.
CharSequence?	`getTitle()` Returns the title of the picture-in-picture window that may be displayed to the user.
Int	`hashCode()`
Boolean	`isAutoEnterEnabled()` Returns whether auto enter picture-in-picture is enabled.
Boolean	`isSeamlessResizeEnabled()` Returns whether seamless resize is enabled.
String	`toString()`
Unit	`writeToParcel(out: Parcel, flags: Int)`

Properties
static Parcelable.Creator<PictureInPictureParams!>	`CREATOR`

Public methods

describeContents

Added in API level 26

fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

equals

Added in API level 26

fun equals(other: Any?): Boolean

Parameters
`obj`	the reference object with which to compare.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getActions

Added in API level 33

fun getActions(): MutableList<RemoteAction!>

Returns the list of user actions that are associated with the activity when in picture-in-picture mode.

Return
`MutableList<RemoteAction!>`	the user actions in a new list. This value cannot be `null`.

See Also

android.app.PictureInPictureParams.Builder#setActions(List)

getAspectRatio

Added in API level 33

fun getAspectRatio(): Rational?

Returns the expected aspect ratio of the picture-in-picture window.

Return
`Rational?`	aspect ratio as the desired width / height or `null` if not set.

See Also

android.app.PictureInPictureParams.Builder#setAspectRatio(Rational)

getCloseAction

Added in API level 33

fun getCloseAction(): RemoteAction?

Returns the action that is to replace the system close action.

Return
`RemoteAction?`	the close action or `null` if not set.

See Also

android.app.PictureInPictureParams.Builder#setCloseAction(RemoteAction)

getExpandedAspectRatio

Added in API level 33

fun getExpandedAspectRatio(): Rational?

Returns the desired aspect ratio of the expanded picture-in-picture window.

Return
`Rational?`	aspect ratio as the desired width / height or `null` if not set.

See Also

android.app.PictureInPictureParams.Builder#setExpandedAspectRatio(Rational)

getSourceRectHint

Added in API level 33

fun getSourceRectHint(): Rect?

Returns the source rect hint.

Return
`Rect?`	the source rect hint also known as launch bounds or `null` if not set.

See Also

android.app.PictureInPictureParams.Builder#setSourceRectHint(Rect)

getSubtitle

Added in API level 33

fun getSubtitle(): CharSequence?

Returns the subtitle of the picture-in-picture window that may be displayed to the user.

Return
`CharSequence?`	subtitle of the picture-in-picture window. This value may be `null`.

See Also

android.app.PictureInPictureParams.Builder#setSubtitle(CharSequence)

getTitle

Added in API level 33

fun getTitle(): CharSequence?

Returns the title of the picture-in-picture window that may be displayed to the user.

Return
`CharSequence?`	title of the picture-in-picture window. This value may be `null`.

See Also

android.app.PictureInPictureParams.Builder#setTitle(CharSequence)

hashCode

Added in API level 26

fun hashCode(): Int

Return
`Int`	a hash code value for this object.

isAutoEnterEnabled

Added in API level 33

fun isAutoEnterEnabled(): Boolean

Returns whether auto enter picture-in-picture is enabled.

Return
`Boolean`	`true` if the system will automatically put the activity in picture-in-picture mode.

See Also

android.app.PictureInPictureParams.Builder#setAutoEnterEnabled(boolean)

isSeamlessResizeEnabled

Added in API level 33

fun isSeamlessResizeEnabled(): Boolean

Returns whether seamless resize is enabled.

Return
`Boolean`	true if the system can seamlessly resize the window while activity is in picture-in-picture mode.

See Also

android.app.PictureInPictureParams.Builder#setSeamlessResizeEnabled(boolean)

toString

Added in API level 26

fun toString(): String

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 26

fun writeToParcel(
    out: Parcel, 
    flags: Int
): Unit

Parameters
`dest`	The Parcel in which the object should be written. This value cannot be `null`.
`flags`	Int: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 26

static val CREATOR: Parcelable.Creator<PictureInPictureParams!>