PictureInPictureUiState
public
final
class
PictureInPictureUiState
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.app.PictureInPictureUiState |
Used by Activity#onPictureInPictureUiStateChanged(PictureInPictureUiState)
.
Summary
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<PictureInPictureUiState> |
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. |
int
|
hashCode()
Returns a hash code value for the object. |
boolean
|
isStashed()
Returns whether Picture-in-Picture is stashed or not. |
boolean
|
isTransitioningToPip()
Returns |
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. |
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. |
isStashed
public boolean isStashed ()
Returns whether Picture-in-Picture is stashed or not. A stashed PiP means it is only
partially visible to the user, with some parts of it being off-screen. This is usually a
UI state that is triggered by the user, such as flinging the PiP to the edge or letting go
of PiP while dragging partially off-screen.
Developers can use this in conjunction with
Activity#onPictureInPictureUiStateChanged(PictureInPictureUiState)
to get a signal
when the PiP stash state has changed. For example, if the state changed from false
to
true
, developers can choose to temporarily pause video playback if PiP is of video
content. Vice versa, if changing from true
to false
and video content is
paused, developers can resume video playback.
Returns | |
---|---|
boolean |
See also:
isTransitioningToPip
public boolean isTransitioningToPip ()
Returns true
if the app is going to enter Picture-in-Picture (PiP) mode.
This state is associated with the entering PiP animation. When that animation starts,
whether via auto enter PiP or calling
Activity#enterPictureInPictureMode(PictureInPictureParams)
explicitly, app can expect
Activity#onPictureInPictureUiStateChanged(PictureInPictureUiState)
callback with
isTransitioningToPip()
to be true
first,
followed by Activity#onPictureInPictureModeChanged(boolean, Configuration)
when it
fully settles in PiP mode.
When app receives the
Activity#onPictureInPictureUiStateChanged(PictureInPictureUiState)
callback with
isTransitioningToPip()
being true
, it's recommended to hide certain UI
elements, such as video controls, to archive a clean entering PiP animation.
In case an application wants to restore the previously hidden UI elements when exiting
PiP, it is recommended to do that in
onPictureInPictureModeChanged(isInPictureInPictureMode=false)
callback rather
than the beginning of exit PiP animation.
Returns | |
---|---|
boolean |
writeToParcel
public void writeToParcel (Parcel out, int flags)
Flatten this object in to a Parcel.
Parameters | |
---|---|
out |
Parcel : 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 |