PlaybackMetrics

public final class PlaybackMetrics
extends Object implements Parcelable

java.lang.Object
   ↳ android.media.metrics.PlaybackMetrics

This class is used to store playback data.

Summary

Nested classes

class PlaybackMetrics.Builder

A builder for PlaybackMetrics 

Constants

int CONTENT_TYPE_AD

Advertisement contents.

int CONTENT_TYPE_MAIN

Main contents.

int CONTENT_TYPE_OTHER

Other contents.

int CONTENT_TYPE_UNKNOWN

Unknown content type.

int DRM_TYPE_CLEARKEY

Clear key DRM type.

int DRM_TYPE_NONE

DRM is not used.

int DRM_TYPE_OTHER

Other DRM type.

int DRM_TYPE_PLAY_READY

Play ready DRM type.

int DRM_TYPE_WIDEVINE_L1

Widevine L1 DRM type.

int DRM_TYPE_WIDEVINE_L3

Widevine L3 DRM type.

int DRM_TYPE_WV_L3_FALLBACK

Widevine L3 fallback DRM type.

int PLAYBACK_TYPE_LIVE

Live playback type.

int PLAYBACK_TYPE_OTHER

Other playback type.

int PLAYBACK_TYPE_UNKNOWN

Unknown playback type.

int PLAYBACK_TYPE_VOD

VOD (Video on Demand) playback type.

int STREAM_SOURCE_DEVICE

Stream from device.

int STREAM_SOURCE_MIXED

Stream from more than one sources.

int STREAM_SOURCE_NETWORK

Stream from network.

int STREAM_SOURCE_UNKNOWN

Unknown stream source.

int STREAM_TYPE_DASH

DASH (Dynamic Adaptive Streaming over HTTP) stream type.

int STREAM_TYPE_HLS

HLS (HTTP Live Streaming) stream type.

int STREAM_TYPE_OTHER

Other stream type.

int STREAM_TYPE_PROGRESSIVE

Progressive stream type.

int STREAM_TYPE_SS

SS (HTTP Smooth Streaming) stream type.

int STREAM_TYPE_UNKNOWN

Unknown stream type.

Inherited constants

Fields

public static final Creator<PlaybackMetrics> 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 getAudioUnderrunCount()

Gets audio underrun count.

int getContentType()

Gets content type.

byte[] getDrmSessionId()

Gets DRM session ID.

int getDrmType()

Gets DRM type.

long[] 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.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

CONTENT_TYPE_AD

Added in API level 31 
public static final int CONTENT_TYPE_AD

Advertisement contents.

Constant Value: 2 (0x00000002)

CONTENT_TYPE_MAIN

Added in API level 31 
public static final int CONTENT_TYPE_MAIN

Main contents.

Constant Value: 1 (0x00000001)

CONTENT_TYPE_OTHER

Added in API level 31 
public static final int CONTENT_TYPE_OTHER

Other contents.

Constant Value: 3 (0x00000003)

CONTENT_TYPE_UNKNOWN

Added in API level 31 
public static final int CONTENT_TYPE_UNKNOWN

Unknown content type.

Constant Value: 0 (0x00000000)

DRM_TYPE_CLEARKEY

Added in API level 31 
public static final int DRM_TYPE_CLEARKEY

Clear key DRM type.

Constant Value: 6 (0x00000006)

DRM_TYPE_NONE

Added in API level 31 
public static final int DRM_TYPE_NONE

DRM is not used.

Constant Value: 0 (0x00000000)

DRM_TYPE_OTHER

Added in API level 31 
public static final int DRM_TYPE_OTHER

Other DRM type.

Constant Value: 1 (0x00000001)

DRM_TYPE_PLAY_READY

Added in API level 31 
public static final int DRM_TYPE_PLAY_READY

Play ready DRM type.

Constant Value: 2 (0x00000002)

DRM_TYPE_WIDEVINE_L1

Added in API level 31 
public static final int DRM_TYPE_WIDEVINE_L1

Widevine L1 DRM type.

Constant Value: 3 (0x00000003)

DRM_TYPE_WIDEVINE_L3

Added in API level 31 
public static final int DRM_TYPE_WIDEVINE_L3

Widevine L3 DRM type.

Constant Value: 4 (0x00000004)

DRM_TYPE_WV_L3_FALLBACK

Added in API level 31 
public static final int DRM_TYPE_WV_L3_FALLBACK

Widevine L3 fallback DRM type.

Constant Value: 5 (0x00000005)

PLAYBACK_TYPE_LIVE

Added in API level 31 
public static final int PLAYBACK_TYPE_LIVE

Live playback type.

Constant Value: 2 (0x00000002)

PLAYBACK_TYPE_OTHER

Added in API level 31 
public static final int PLAYBACK_TYPE_OTHER

Other playback type.

Constant Value: 3 (0x00000003)

PLAYBACK_TYPE_UNKNOWN

Added in API level 31 
public static final int PLAYBACK_TYPE_UNKNOWN

Unknown playback type.

Constant Value: 0 (0x00000000)

PLAYBACK_TYPE_VOD

Added in API level 31 
public static final int PLAYBACK_TYPE_VOD

VOD (Video on Demand) playback type.

Constant Value: 1 (0x00000001)

STREAM_SOURCE_DEVICE

Added in API level 31 
public static final int STREAM_SOURCE_DEVICE

Stream from device.

Constant Value: 2 (0x00000002)

STREAM_SOURCE_MIXED

Added in API level 31 
public static final int STREAM_SOURCE_MIXED

Stream from more than one sources.

Constant Value: 3 (0x00000003)

STREAM_SOURCE_NETWORK

Added in API level 31 
public static final int STREAM_SOURCE_NETWORK

Stream from network.

Constant Value: 1 (0x00000001)

STREAM_SOURCE_UNKNOWN

Added in API level 31 
public static final int STREAM_SOURCE_UNKNOWN

Unknown stream source.

Constant Value: 0 (0x00000000)

STREAM_TYPE_DASH

Added in API level 31 
public static final int STREAM_TYPE_DASH

DASH (Dynamic Adaptive Streaming over HTTP) stream type.

Constant Value: 3 (0x00000003)

STREAM_TYPE_HLS

Added in API level 31 
public static final int STREAM_TYPE_HLS

HLS (HTTP Live Streaming) stream type.

Constant Value: 4 (0x00000004)

STREAM_TYPE_OTHER

Added in API level 31 
public static final int STREAM_TYPE_OTHER

Other stream type.

Constant Value: 1 (0x00000001)

STREAM_TYPE_PROGRESSIVE

Added in API level 31 
public static final int STREAM_TYPE_PROGRESSIVE

Progressive stream type.

Constant Value: 2 (0x00000002)

STREAM_TYPE_SS

Added in API level 31 
public static final int STREAM_TYPE_SS

SS (HTTP Smooth Streaming) stream type.

Constant Value: 5 (0x00000005)

STREAM_TYPE_UNKNOWN

Added in API level 31 
public static final int STREAM_TYPE_UNKNOWN

Unknown stream type.

Constant Value: 0 (0x00000000)

Fields

CREATOR

Added in API level 31 
public static final Creator<PlaybackMetrics> CREATOR

Public methods

describeContents

Added in API level 31 
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

Added in API level 31 
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 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
o Object: This value may be null.
Returns
boolean true if this object is the same as the obj argument; false otherwise.

getAudioUnderrunCount

Added in API level 31 
public int getAudioUnderrunCount ()

Gets audio underrun count.

Returns
int the audio underrun count, or -1 if unknown. Value is between -1 and Integer.MAX_VALUE inclusive

getContentType

Added in API level 31 
public int getContentType ()

Gets content type.

Returns
int Value is CONTENT_TYPE_UNKNOWN, CONTENT_TYPE_MAIN, CONTENT_TYPE_AD, or CONTENT_TYPE_OTHER

getDrmSessionId

Added in API level 31 
public byte[] getDrmSessionId ()

Gets DRM session ID.

Returns
byte[] This value cannot be null.

getDrmType

Added in API level 31 
public int getDrmType ()

Gets DRM type.

Returns
int Value is DRM_TYPE_NONE, DRM_TYPE_OTHER, DRM_TYPE_PLAY_READY, DRM_TYPE_WIDEVINE_L1, DRM_TYPE_WIDEVINE_L3, DRM_TYPE_WV_L3_FALLBACK, or DRM_TYPE_CLEARKEY

getExperimentIds

Added in API level 31 
public long[] getExperimentIds ()

Gets experiment IDs.

Returns
long[] This value cannot be null.

getLocalBytesRead

Added in API level 31 
public long getLocalBytesRead ()

Gets number of local bytes read.

Returns
long Value is -1 or greater

getMediaDurationMillis

Added in API level 31 
public long getMediaDurationMillis ()

Gets the media duration in milliseconds.

Media duration is the length of the media.

Returns
long the media duration in milliseconds, or -1 if unknown. Value is -1 or greater

getMetricsBundle

Added in API level 31 
public Bundle getMetricsBundle ()

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

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

Returns
Bundle This value cannot be null.

getNetworkBytesRead

Added in API level 31 
public long getNetworkBytesRead ()

Gets number of network bytes read.

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

getNetworkTransferDurationMillis

Added in API level 31 
public long getNetworkTransferDurationMillis ()

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.

Returns
long Value is -1 or greater

getPlaybackType

Added in API level 31 
public int getPlaybackType ()

Gets playback type.

Returns
int Value is PLAYBACK_TYPE_UNKNOWN, PLAYBACK_TYPE_VOD, PLAYBACK_TYPE_LIVE, or PLAYBACK_TYPE_OTHER

getPlayerName

Added in API level 31 
public String getPlayerName ()

Gets player name.

Returns
String This value may be null.

getPlayerVersion

Added in API level 31 
public String getPlayerVersion ()

Gets player version.

Returns
String This value may be null.

getStreamSource

Added in API level 31 
public int getStreamSource ()

Gets stream source type.

Returns
int Value is STREAM_SOURCE_UNKNOWN, STREAM_SOURCE_NETWORK, STREAM_SOURCE_DEVICE, or STREAM_SOURCE_MIXED

getStreamType

Added in API level 31 
public int getStreamType ()

Gets stream type.

Returns
int Value is STREAM_TYPE_UNKNOWN, STREAM_TYPE_OTHER, STREAM_TYPE_PROGRESSIVE, STREAM_TYPE_DASH, STREAM_TYPE_HLS, or STREAM_TYPE_SS

getVideoFramesDropped

Added in API level 31 
public int getVideoFramesDropped ()

Gets video frames dropped.

Returns
int the video frames dropped, or -1 if unknown. Value is between -1 and Integer.MAX_VALUE inclusive

getVideoFramesPlayed

Added in API level 31 
public int getVideoFramesPlayed ()

Gets video frames played.

Returns
int the video frames played, or -1 if unknown. Value is between -1 and Integer.MAX_VALUE inclusive

hashCode

Added in API level 31 
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 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.

Returns
int a hash code value for this object.

toString

Added in API level 31 
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 31 
public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES