Added in API level 31

PlaybackMetrics

---

Kotlin |Java

class PlaybackMetrics : Parcelable

kotlin.Any
↳	android.media.metrics.PlaybackMetrics

This class is used to store playback data.

Summary

Nested classes
	Builder A builder for PlaybackMetrics

Constants
static Int	CONTENT_TYPE_AD Advertisement contents.
static Int	CONTENT_TYPE_MAIN Main contents.
static Int	CONTENT_TYPE_OTHER Other contents.
static Int	CONTENT_TYPE_UNKNOWN Unknown content type.
static Int	DRM_TYPE_CLEARKEY Clear key DRM type.
static Int	DRM_TYPE_NONE DRM is not used.
static Int	DRM_TYPE_OTHER Other DRM type.
static Int	DRM_TYPE_PLAY_READY Play ready DRM type.
static Int	DRM_TYPE_WIDEVINE_L1 Widevine L1 DRM type.
static Int	DRM_TYPE_WIDEVINE_L3 Widevine L3 DRM type.
static Int	DRM_TYPE_WV_L3_FALLBACK Widevine L3 fallback DRM type.
static Int	PLAYBACK_TYPE_LIVE Live playback type.
static Int	PLAYBACK_TYPE_OTHER Other playback type.
static Int	PLAYBACK_TYPE_UNKNOWN Unknown playback type.
static Int	PLAYBACK_TYPE_VOD VOD (Video on Demand) playback type.
static Int	STREAM_SOURCE_DEVICE Stream from device.
static Int	STREAM_SOURCE_MIXED Stream from more than one sources.
static Int	STREAM_SOURCE_NETWORK Stream from network.
static Int	STREAM_SOURCE_UNKNOWN Unknown stream source.
static Int	STREAM_TYPE_DASH DASH (Dynamic Adaptive Streaming over HTTP) stream type.
static Int	STREAM_TYPE_HLS HLS (HTTP Live Streaming) stream type.
static Int	STREAM_TYPE_OTHER Other stream type.
static Int	STREAM_TYPE_PROGRESSIVE Progressive stream type.
static Int	STREAM_TYPE_SS SS (HTTP Smooth Streaming) stream type.
static Int	STREAM_TYPE_UNKNOWN Unknown stream type.

Inherited constants

From class Parcelable Int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. Int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
Int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
Boolean	equals(other: Any?) Indicates whether some other object is "equal to" this one.
Int	getAudioUnderrunCount() Gets audio underrun count.
Int	getContentType() Gets content type.
ByteArray	getDrmSessionId() Gets DRM session ID.
Int	getDrmType() Gets DRM type.
LongArray	getExperimentIds() Gets experiment IDs.
Long	getLocalBytesRead() Gets number of local bytes read.
Long	getMediaDurationMillis() Gets the media duration in milliseconds.
Bundle	getMetricsBundle() Gets metrics-related information that is not supported by dedicated methods.
Long	getNetworkBytesRead() Gets number of network bytes read.
Long	getNetworkTransferDurationMillis() Gets network transfer duration in milliseconds.
Int	getPlaybackType() Gets playback type.
String?	getPlayerName() Gets player name.
String?	getPlayerVersion() Gets player version.
Int	getStreamSource() Gets stream source type.
Int	getStreamType() Gets stream type.
Int	getVideoFramesDropped() Gets video frames dropped.
Int	getVideoFramesPlayed() Gets video frames played.
Int	hashCode() Returns a hash code value for the object.
String	toString() Returns a string representation of the object.
Unit	writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<PlaybackMetrics!>	CREATOR

Constants

CONTENT_TYPE_AD

Added in API level 31

static val CONTENT_TYPE_AD: Int

Advertisement contents.

Value: 2

CONTENT_TYPE_MAIN

Added in API level 31

static val CONTENT_TYPE_MAIN: Int

Main contents.

Value: 1

CONTENT_TYPE_OTHER

Added in API level 31

static val CONTENT_TYPE_OTHER: Int

Other contents.

Value: 3

CONTENT_TYPE_UNKNOWN

Added in API level 31

static val CONTENT_TYPE_UNKNOWN: Int

Unknown content type.

Value: 0

DRM_TYPE_CLEARKEY

Added in API level 31

static val DRM_TYPE_CLEARKEY: Int

Clear key DRM type.

Value: 6

DRM_TYPE_NONE

Added in API level 31

static val DRM_TYPE_NONE: Int

DRM is not used.

Value: 0

DRM_TYPE_OTHER

Added in API level 31

static val DRM_TYPE_OTHER: Int

Other DRM type.

Value: 1

DRM_TYPE_PLAY_READY

Added in API level 31

static val DRM_TYPE_PLAY_READY: Int

Play ready DRM type.

Value: 2

DRM_TYPE_WIDEVINE_L1

Added in API level 31

static val DRM_TYPE_WIDEVINE_L1: Int

Widevine L1 DRM type.

Value: 3

DRM_TYPE_WIDEVINE_L3

Added in API level 31

static val DRM_TYPE_WIDEVINE_L3: Int

Widevine L3 DRM type.

Value: 4

DRM_TYPE_WV_L3_FALLBACK

Added in API level 31

static val DRM_TYPE_WV_L3_FALLBACK: Int

Widevine L3 fallback DRM type.

Value: 5

PLAYBACK_TYPE_LIVE

Added in API level 31

static val PLAYBACK_TYPE_LIVE: Int

Live playback type.

Value: 2

PLAYBACK_TYPE_OTHER

Added in API level 31

static val PLAYBACK_TYPE_OTHER: Int

Other playback type.

Value: 3

PLAYBACK_TYPE_UNKNOWN

Added in API level 31

static val PLAYBACK_TYPE_UNKNOWN: Int

Unknown playback type.

Value: 0

PLAYBACK_TYPE_VOD

Added in API level 31

static val PLAYBACK_TYPE_VOD: Int

VOD (Video on Demand) playback type.

Value: 1

STREAM_SOURCE_DEVICE

Added in API level 31

static val STREAM_SOURCE_DEVICE: Int

Stream from device.

Value: 2

STREAM_SOURCE_MIXED

Added in API level 31

static val STREAM_SOURCE_MIXED: Int

Stream from more than one sources.

Value: 3

STREAM_SOURCE_NETWORK

Added in API level 31

static val STREAM_SOURCE_NETWORK: Int

Stream from network.

Value: 1

STREAM_SOURCE_UNKNOWN

Added in API level 31

static val STREAM_SOURCE_UNKNOWN: Int

Unknown stream source.

Value: 0

STREAM_TYPE_DASH

Added in API level 31

static val STREAM_TYPE_DASH: Int

DASH (Dynamic Adaptive Streaming over HTTP) stream type.

Value: 3

STREAM_TYPE_HLS

Added in API level 31

static val STREAM_TYPE_HLS: Int

HLS (HTTP Live Streaming) stream type.

Value: 4

STREAM_TYPE_OTHER

Added in API level 31

static val STREAM_TYPE_OTHER: Int

Other stream type.

Value: 1

STREAM_TYPE_PROGRESSIVE

Added in API level 31

static val STREAM_TYPE_PROGRESSIVE: Int

Progressive stream type.

Value: 2

STREAM_TYPE_SS

Added in API level 31

static val STREAM_TYPE_SS: Int

SS (HTTP Smooth Streaming) stream type.

Value: 5

STREAM_TYPE_UNKNOWN

Added in API level 31

static val STREAM_TYPE_UNKNOWN: Int

Unknown stream type.

Value: 0

Public methods

describeContents

Added in API level 31

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 CONTENTS_FILE_DESCRIPTOR

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.

getAudioUnderrunCount

Added in API level 31

fun getAudioUnderrunCount(): Int

Gets audio underrun count.

Return
Int	the audio underrun count, or -1 if unknown. Value is between -1 and java.lang.Integer#MAX_VALUE inclusive

getContentType

Added in API level 31

fun getContentType(): Int

Gets content type.

Return
Int	Value is one of the following: CONTENT_TYPE_UNKNOWN CONTENT_TYPE_MAIN CONTENT_TYPE_AD CONTENT_TYPE_OTHER

getDrmSessionId

Added in API level 31

fun getDrmSessionId(): ByteArray

Gets DRM session ID.

Return
ByteArray	This value cannot be null.

getDrmType

Added in API level 31

fun getDrmType(): Int

Gets DRM type.

Return
Int	Value is one of the following: DRM_TYPE_NONE DRM_TYPE_OTHER DRM_TYPE_PLAY_READY DRM_TYPE_WIDEVINE_L1 DRM_TYPE_WIDEVINE_L3 DRM_TYPE_WV_L3_FALLBACK DRM_TYPE_CLEARKEY

getExperimentIds

Added in API level 31

fun getExperimentIds(): LongArray

Gets experiment IDs.

Return
LongArray	This value cannot be null.

getLocalBytesRead

Added in API level 31

fun getLocalBytesRead(): Long

Gets number of local bytes read.

Return
Long	Value is -1 or greater

getMediaDurationMillis

Added in API level 31

fun getMediaDurationMillis(): Long

Gets the media duration in milliseconds.

Media duration is the length of the media.

Return
Long	the media duration in milliseconds, or -1 if unknown. Value is -1 or greater

getMetricsBundle

Added in API level 31

fun getMetricsBundle(): Bundle

Gets metrics-related information that is not supported by dedicated methods.

It is intended to be used for backwards compatibility by the metrics infrastructure.

Return
Bundle	This value cannot be null.

getNetworkBytesRead

Added in API level 31

fun getNetworkBytesRead(): Long

Gets number of network bytes read.

Return
Long	the number of network bytes read, or -1 if unknown. Value is -1 or greater

getNetworkTransferDurationMillis

Added in API level 31

fun getNetworkTransferDurationMillis(): Long

Gets network transfer duration in milliseconds.

Total transfer time spent reading from the network in ms. For parallel requests, the overlapping time intervals are counted only once.

Return
Long	Value is -1 or greater

getPlaybackType

Added in API level 31

fun getPlaybackType(): Int

Gets playback type.

Return
Int	Value is one of the following: PLAYBACK_TYPE_UNKNOWN PLAYBACK_TYPE_VOD PLAYBACK_TYPE_LIVE PLAYBACK_TYPE_OTHER

getPlayerName

Added in API level 31

fun getPlayerName(): String?

Gets player name.

Return
String?	This value may be null.

getPlayerVersion

Added in API level 31

fun getPlayerVersion(): String?

Gets player version.

Return
String?	This value may be null.

getStreamSource

Added in API level 31

fun getStreamSource(): Int

Gets stream source type.

Return
Int	Value is one of the following: STREAM_SOURCE_UNKNOWN STREAM_SOURCE_NETWORK STREAM_SOURCE_DEVICE STREAM_SOURCE_MIXED

getStreamType

Added in API level 31

fun getStreamType(): Int

Gets stream type.

Return
Int	Value is one of the following: STREAM_TYPE_UNKNOWN STREAM_TYPE_OTHER STREAM_TYPE_PROGRESSIVE STREAM_TYPE_DASH STREAM_TYPE_HLS STREAM_TYPE_SS

getVideoFramesDropped

Added in API level 31

fun getVideoFramesDropped(): Int

Gets video frames dropped.

Return
Int	the video frames dropped, or -1 if unknown. Value is between -1 and java.lang.Integer#MAX_VALUE inclusive

getVideoFramesPlayed

Added in API level 31

fun getVideoFramesPlayed(): Int

Gets video frames played.

Return
Int	the video frames played, or -1 if unknown. Value is between -1 and java.lang.Integer#MAX_VALUE inclusive

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.

toString

Added in API level 31

fun toString(): String

Returns a string representation of the object.

Return
String	a string representation of the object.

writeToParcel

Added in API level 31

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest	Parcel: 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: PARCELABLE_WRITE_RETURN_VALUE

Properties

CREATOR

Added in API level 31

static val CREATOR: Parcelable.Creator<PlaybackMetrics!>