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 |
Inherited constants | |
---|---|
Public methods | |
---|---|
Int | |
Boolean | |
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. |
Rect? |
Returns the source rect hint. |
CharSequence? |
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 |
Returns whether auto enter picture-in-picture is enabled. |
Boolean |
Returns whether seamless resize is enabled. |
String |
toString() |
Unit |
writeToParcel(out: Parcel, flags: Int) |
Properties | |
---|---|
static Parcelable.Creator<PictureInPictureParams!> |
Public methods
describeContents
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
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
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
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
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
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. |
getSourceRectHint
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
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
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 . |
isAutoEnterEnabled
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
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
fun toString(): String
Return | |
---|---|
String |
a string representation of the object. |
writeToParcel
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 |