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()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
Boolean	`equals(other: Any?)` Indicates whether some other object is "equal to" this one.
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()` Returns a hash code value for the object.
Boolean	`isAutoEnterEnabled()` Returns whether auto enter picture-in-picture is enabled.
Boolean	`isSeamlessResizeEnabled()` Returns whether seamless resize is enabled.
String	`toString()` Returns a string representation of the object.
Unit	`writeToParcel(out: Parcel, flags: Int)` Flatten this object in to a Parcel.

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

Public methods

describeContents

Added in API level 26

fun describeContents(): Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

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

equals

Added in API level 26

fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

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

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

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

Returns a string representation of the object.

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 26

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

Flatten this object in to a Parcel.

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 the following: `PARCELABLE_WRITE_RETURN_VALUE`

Properties

CREATOR

Added in API level 26

static val CREATOR: Parcelable.Creator<PictureInPictureParams!>