PlaybackSession
public
final
class
PlaybackSession
extends Object
implements
AutoCloseable
java.lang.Object | |
↳ | android.media.metrics.PlaybackSession |
An instance of this class represents a session of media playback used to report playback
metrics and events.
Create a new instance using MediaMetricsManager#createPlaybackSession
.
Summary
Public methods | |
---|---|
void
|
close()
Closes this resource, relinquishing any underlying resources. |
boolean
|
equals(Object o)
Indicates whether some other object is "equal to" this one. |
LogSessionId
|
getSessionId()
A session ID is used to identify a unique playback and to tie together lower-level playback components. |
int
|
hashCode()
Returns a hash code value for the object. |
void
|
reportNetworkEvent(NetworkEvent event)
Reports network event. |
void
|
reportPlaybackErrorEvent(PlaybackErrorEvent event)
Reports error event. |
void
|
reportPlaybackMetrics(PlaybackMetrics metrics)
Reports playback metrics. |
void
|
reportPlaybackStateEvent(PlaybackStateEvent event)
Reports playback state event. |
void
|
reportTrackChangeEvent(TrackChangeEvent event)
Reports track change event. |
Inherited methods | |
---|---|
Public methods
close
public void close ()
Closes this resource, relinquishing any underlying resources.
This method is invoked automatically on objects managed by the
try
-with-resources statement.
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 : This value may be null . |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getSessionId
public LogSessionId getSessionId ()
A session ID is used to identify a unique playback and to tie together lower-level
playback components.
Associate this session with a ERROR(/MediaCodec)
by passing the ID into
ERROR(/MediaFormat)
through ERROR(/MediaFormat#LOG_SESSION_ID)
when
creating the ERROR(/MediaCodec)
.
Associate this session with an ERROR(/AudioTrack)
by calling
ERROR(/AudioTrack#setLogSessionId)
.
Associate this session with ERROR(/MediaDrm)
and ERROR(/MediaCrypto)
by calling
ERROR(/MediaDrm#getPlaybackComponent)
and then calling
ERROR(/PlaybackComponent#setLogSessionId)
.
Returns | |
---|---|
LogSessionId |
This value cannot 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. |
reportNetworkEvent
public void reportNetworkEvent (NetworkEvent event)
Reports network event.
Parameters | |
---|---|
event |
NetworkEvent : This value cannot be null . |
reportPlaybackErrorEvent
public void reportPlaybackErrorEvent (PlaybackErrorEvent event)
Reports error event.
Parameters | |
---|---|
event |
PlaybackErrorEvent : This value cannot be null . |
reportPlaybackMetrics
public void reportPlaybackMetrics (PlaybackMetrics metrics)
Reports playback metrics.
Parameters | |
---|---|
metrics |
PlaybackMetrics : This value cannot be null . |
reportPlaybackStateEvent
public void reportPlaybackStateEvent (PlaybackStateEvent event)
Reports playback state event.
Parameters | |
---|---|
event |
PlaybackStateEvent : This value cannot be null . |
reportTrackChangeEvent
public void reportTrackChangeEvent (TrackChangeEvent event)
Reports track change event.
Parameters | |
---|---|
event |
TrackChangeEvent : This value cannot be null . |