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 |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
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. |
| 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()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 |
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!> | |
Public methods
describeContents
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
|
equals
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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
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. |
hashCode
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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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
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
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
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:
|