PictureInPictureParams
public
final
class
PictureInPictureParams
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.app.PictureInPictureParams |
Represents a set of parameters used to initialize and update an Activity in picture-in-picture mode.
Summary
Nested classes | |
---|---|
class |
PictureInPictureParams.Builder
Builder class for |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<PictureInPictureParams> |
CREATOR
|
Public methods | |
---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
boolean
|
equals(Object o)
Indicates whether some other object is "equal to" this one. |
List<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. |
void
|
writeToParcel(Parcel out, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Fields
Public methods
describeContents
public int describeContents ()
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.
Returns | |
---|---|
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
public boolean equals (Object o)
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
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons 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 | |
---|---|
o |
Object : the reference object with which to compare. |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getActions
public List<RemoteAction> getActions ()
Returns the list of user actions that are associated with the activity when in picture-in-picture mode.
Returns | |
---|---|
List<RemoteAction> |
the user actions in a new list.
This value cannot be null . |
getAspectRatio
public Rational getAspectRatio ()
Returns the expected aspect ratio of the picture-in-picture window.
Returns | |
---|---|
Rational |
aspect ratio as the desired width / height or null if not set. |
getCloseAction
public RemoteAction getCloseAction ()
Returns the action that is to replace the system close action.
Returns | |
---|---|
RemoteAction |
the close action or null if not set. |
getExpandedAspectRatio
public Rational getExpandedAspectRatio ()
Returns the desired aspect ratio of the expanded picture-in-picture window.
Returns | |
---|---|
Rational |
aspect ratio as the desired width / height or null if not set. |
getSourceRectHint
public Rect getSourceRectHint ()
Returns the source rect hint.
Returns | |
---|---|
Rect |
the source rect hint also known as launch bounds or null if not set. |
getSubtitle
public CharSequence getSubtitle ()
Returns the subtitle of the picture-in-picture window that may be displayed to the user.
Returns | |
---|---|
CharSequence |
subtitle of the picture-in-picture window.
This value may be null . |
getTitle
public CharSequence getTitle ()
Returns the title of the picture-in-picture window that may be displayed to the user.
Returns | |
---|---|
CharSequence |
title of the picture-in-picture window.
This value may be null . |
hashCode
public int hashCode ()
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
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 inequals
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 thehashCode
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 thehashCode
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.
Returns | |
---|---|
int |
a hash code value for this object. |
isAutoEnterEnabled
public boolean isAutoEnterEnabled ()
Returns whether auto enter picture-in-picture is enabled.
Returns | |
---|---|
boolean |
true if the system will automatically put the activity in
picture-in-picture mode. |
isSeamlessResizeEnabled
public boolean isSeamlessResizeEnabled ()
Returns whether seamless resize is enabled.
Returns | |
---|---|
boolean |
true if the system can seamlessly resize the window while activity is in picture-in-picture mode. |
toString
public String toString ()
Returns a string representation of the object.
Returns | |
---|---|
String |
a string representation of the object. |
writeToParcel
public void writeToParcel (Parcel out, int flags)
Flatten this object in to a Parcel.
Parameters | |
---|---|
out |
Parcel : 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.PARCELABLE_WRITE_RETURN_VALUE .
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-04-11 UTC.