Added in API level 26

PictureInPictureParams


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 class for PictureInPictureParams objects.

Inherited constants
Public methods
Int

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!>

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

Rational?

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

RemoteAction?

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

Rational?

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

MutableList<RemoteAction!>

Returns the set of overlay actions that are associated with the activity when in picture-in-picture mode.

RemoteAction?

Returns the action that is to be used as the primary action in the PiP menu.

RemoteAction?

Returns the primary overlay action that is associated with the activity when in picture-in-picture mode.

Rect?

Returns the source rect hint.

CharSequence?

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

CharSequence?

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

Int

Returns a hash code value for the object.

Boolean

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

Boolean

Returns whether seamless resize is enabled.

String

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!>

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(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

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.

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.

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.

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.

getOverlayActions

fun getOverlayActions(): MutableList<RemoteAction!>

Returns the set of overlay actions that are associated with the activity when in picture-in-picture mode.

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

getPrimaryAction

fun getPrimaryAction(): RemoteAction?

Returns the action that is to be used as the primary action in the PiP menu.

Return
RemoteAction? the primary action or null if not set.

See Also

    getPrimaryOverlayAction

    fun getPrimaryOverlayAction(): RemoteAction?

    Returns the primary overlay action that is associated with the activity when in picture-in-picture mode.

    Return
    RemoteAction? the primary overlay action or null if not set.

    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.

    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.

    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.

    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.

    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.

    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:

    Properties

    CREATOR

    Added in API level 26
    static val CREATOR: Parcelable.Creator<PictureInPictureParams!>