PlaybackSession

Kotlin |Java

class PlaybackSession : AutoCloseable

kotlin.Any
↳	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
Unit	`close()` Closes this resource, relinquishing any underlying resources.
Boolean	`equals(other: Any?)` 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.
Unit	`reportNetworkEvent(event: NetworkEvent)` Reports network event.
Unit	`reportPlaybackErrorEvent(event: PlaybackErrorEvent)` Reports error event.
Unit	`reportPlaybackMetrics(metrics: PlaybackMetrics)` Reports playback metrics.
Unit	`reportPlaybackStateEvent(event: PlaybackStateEvent)` Reports playback state event.
Unit	`reportTrackChangeEvent(event: TrackChangeEvent)` Reports track change event.

Public methods

close

Added in API level 31

fun close(): Unit

Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the try-with-resources statement.

Exceptions
`java.lang.Exception`	if this resource cannot be closed

equals

Added in API level 31

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 return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

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.
`o`	This value may be `null`.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getSessionId

Added in API level 31

fun getSessionId(): LogSessionId

A session ID is used to identify a unique playback and to tie together lower-level playback components. Associate this session with a MediaCodec by passing the ID into MediaFormat through MediaFormat#LOG_SESSION_ID when creating the MediaCodec. Associate this session with an AudioTrack by calling AudioTrack#setLogSessionId. Associate this session with MediaDrm and MediaCrypto by calling MediaDrm#getPlaybackComponent and then calling PlaybackComponent#setLogSessionId.

Return
`LogSessionId`	This value cannot be `null`.

hashCode

Added in API level 31

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 hashCode method must consistently return the same integer, provided no information used in equals 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 the hashCode 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 the hashCode 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.

Return
`Int`	a hash code value for this object.

reportNetworkEvent

Added in API level 31

fun reportNetworkEvent(event: NetworkEvent): Unit

Reports network event.

Parameters
`event`	NetworkEvent: This value cannot be `null`.

reportPlaybackErrorEvent

Added in API level 31

fun reportPlaybackErrorEvent(event: PlaybackErrorEvent): Unit

Reports error event.

Parameters
`event`	PlaybackErrorEvent: This value cannot be `null`.

reportPlaybackMetrics

Added in API level 31

fun reportPlaybackMetrics(metrics: PlaybackMetrics): Unit

Reports playback metrics.

Parameters
`metrics`	PlaybackMetrics: This value cannot be `null`.

reportPlaybackStateEvent

Added in API level 31

fun reportPlaybackStateEvent(event: PlaybackStateEvent): Unit

Reports playback state event.

Parameters
`event`	PlaybackStateEvent: This value cannot be `null`.

reportTrackChangeEvent

Added in API level 31

fun reportTrackChangeEvent(event: TrackChangeEvent): Unit

Reports track change event.

Parameters
`event`	TrackChangeEvent: This value cannot be `null`.