Added in API level 31

Builder

class Builder
kotlin.Any
   ↳ android.media.metrics.PlaybackMetrics.Builder

A builder for PlaybackMetrics

Summary

Public constructors

Creates a new Builder.
Public methods
PlaybackMetrics.Builder

Adds the experiment ID.
PlaybackMetrics

Builds the instance.
PlaybackMetrics.Builder

Sets the audio underrun count.
PlaybackMetrics.Builder

Sets the content type.
PlaybackMetrics.Builder
setDrmSessionId(drmSessionId: ByteArray)

Sets DRM session ID.
PlaybackMetrics.Builder
setDrmType(value: Int)

Sets the DRM type.
PlaybackMetrics.Builder

Sets the number of local bytes read.
PlaybackMetrics.Builder

Sets the media duration in milliseconds.
PlaybackMetrics.Builder
setMetricsBundle(metricsBundle: Bundle)

Sets metrics-related information that is not supported by dedicated methods.
PlaybackMetrics.Builder

Sets the number of network bytes read.
PlaybackMetrics.Builder

Sets the network transfer duration in milliseconds.
PlaybackMetrics.Builder

Sets the playback type.
PlaybackMetrics.Builder

Sets the player name.
PlaybackMetrics.Builder

Sets the player version.
PlaybackMetrics.Builder

Sets the stream source type.
PlaybackMetrics.Builder

Sets the stream type.
PlaybackMetrics.Builder

Sets the video frames dropped.
PlaybackMetrics.Builder

Sets the video frames played.

Public constructors

Builder

Added in API level 31
Builder()

Creates a new Builder.

Public methods

addExperimentId

Added in API level 31
fun addExperimentId(value: Long): PlaybackMetrics.Builder

Adds the experiment ID.

Return
PlaybackMetrics.Builder This value cannot be null.

build

Added in API level 31
fun build(): PlaybackMetrics

Builds the instance. This builder should not be touched after calling this!

Return
PlaybackMetrics This value cannot be null.

setAudioUnderrunCount

Added in API level 31
fun setAudioUnderrunCount(value: Int): PlaybackMetrics.Builder

Sets the audio underrun count.

Parameters
value Int: the audio underrun count. -1 indicates the value is unknown. Value is between -1 and java.lang.Integer#MAX_VALUE inclusive
Return
PlaybackMetrics.Builder This value cannot be null.

setContentType

Added in API level 31
fun setContentType(value: Int): PlaybackMetrics.Builder

Sets the content type.

Parameters
value Int: Value is android.media.metrics.PlaybackMetrics#CONTENT_TYPE_UNKNOWN, android.media.metrics.PlaybackMetrics#CONTENT_TYPE_MAIN, android.media.metrics.PlaybackMetrics#CONTENT_TYPE_AD, or android.media.metrics.PlaybackMetrics#CONTENT_TYPE_OTHER
Return
PlaybackMetrics.Builder This value cannot be null.

setDrmSessionId

Added in API level 31
fun setDrmSessionId(drmSessionId: ByteArray): PlaybackMetrics.Builder

Sets DRM session ID.

Parameters
drmSessionId ByteArray: This value cannot be null.
Return
PlaybackMetrics.Builder This value cannot be null.

setDrmType

Added in API level 31
fun setDrmType(value: Int): PlaybackMetrics.Builder

Sets the DRM type.

Parameters
value Int: Value is android.media.metrics.PlaybackMetrics#DRM_TYPE_NONE, android.media.metrics.PlaybackMetrics#DRM_TYPE_OTHER, android.media.metrics.PlaybackMetrics#DRM_TYPE_PLAY_READY, android.media.metrics.PlaybackMetrics#DRM_TYPE_WIDEVINE_L1, android.media.metrics.PlaybackMetrics#DRM_TYPE_WIDEVINE_L3, android.media.metrics.PlaybackMetrics#DRM_TYPE_WV_L3_FALLBACK, or android.media.metrics.PlaybackMetrics#DRM_TYPE_CLEARKEY
Return
PlaybackMetrics.Builder This value cannot be null.

setLocalBytesRead

Added in API level 31
fun setLocalBytesRead(value: Long): PlaybackMetrics.Builder

Sets the number of local bytes read.

Parameters
value Long: the number of local bytes read. -1 indicates the value is unknown. Value is -1 or greater
Return
PlaybackMetrics.Builder This value cannot be null.

setMediaDurationMillis

Added in API level 31
fun setMediaDurationMillis(value: Long): PlaybackMetrics.Builder

Sets the media duration in milliseconds.

Parameters
value Long: the media duration in milliseconds. -1 indicates the value is unknown. Value is -1 or greater
Return
PlaybackMetrics.Builder This value cannot be null.

setMetricsBundle

Added in API level 31
fun setMetricsBundle(metricsBundle: Bundle): PlaybackMetrics.Builder

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

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

Parameters
metricsBundle Bundle: This value cannot be null.
Return
PlaybackMetrics.Builder This value cannot be null.

setNetworkBytesRead

Added in API level 31
fun setNetworkBytesRead(value: Long): PlaybackMetrics.Builder

Sets the number of network bytes read.

Parameters
value Long: the number of network bytes read. -1 indicates the value is unknown. Value is -1 or greater
Return
PlaybackMetrics.Builder This value cannot be null.

setNetworkTransferDurationMillis

Added in API level 31
fun setNetworkTransferDurationMillis(value: Long): PlaybackMetrics.Builder

Sets the network transfer duration in milliseconds.

Parameters
value Long: the network transfer duration in milliseconds. -1 indicates the value is unknown. Value is -1 or greater
Return
PlaybackMetrics.Builder This value cannot be null.

setPlaybackType

Added in API level 31
fun setPlaybackType(value: Int): PlaybackMetrics.Builder

Sets the playback type.

Parameters
value Int: Value is android.media.metrics.PlaybackMetrics#PLAYBACK_TYPE_UNKNOWN, android.media.metrics.PlaybackMetrics#PLAYBACK_TYPE_VOD, android.media.metrics.PlaybackMetrics#PLAYBACK_TYPE_LIVE, or android.media.metrics.PlaybackMetrics#PLAYBACK_TYPE_OTHER
Return
PlaybackMetrics.Builder This value cannot be null.

setPlayerName

Added in API level 31
fun setPlayerName(value: String): PlaybackMetrics.Builder

Sets the player name.

Parameters
value String: This value cannot be null.
Return
PlaybackMetrics.Builder This value cannot be null.

setPlayerVersion

Added in API level 31
fun setPlayerVersion(value: String): PlaybackMetrics.Builder

Sets the player version.

Parameters
value String: This value cannot be null.
Return
PlaybackMetrics.Builder This value cannot be null.

setStreamSource

Added in API level 31
fun setStreamSource(value: Int): PlaybackMetrics.Builder

Sets the stream source type.

Parameters
value Int: Value is android.media.metrics.PlaybackMetrics#STREAM_SOURCE_UNKNOWN, android.media.metrics.PlaybackMetrics#STREAM_SOURCE_NETWORK, android.media.metrics.PlaybackMetrics#STREAM_SOURCE_DEVICE, or android.media.metrics.PlaybackMetrics#STREAM_SOURCE_MIXED
Return
PlaybackMetrics.Builder This value cannot be null.

setStreamType

Added in API level 31
fun setStreamType(value: Int): PlaybackMetrics.Builder

Sets the stream type.

Parameters
value Int: Value is android.media.metrics.PlaybackMetrics#STREAM_TYPE_UNKNOWN, android.media.metrics.PlaybackMetrics#STREAM_TYPE_OTHER, android.media.metrics.PlaybackMetrics#STREAM_TYPE_PROGRESSIVE, android.media.metrics.PlaybackMetrics#STREAM_TYPE_DASH, android.media.metrics.PlaybackMetrics#STREAM_TYPE_HLS, or android.media.metrics.PlaybackMetrics#STREAM_TYPE_SS
Return
PlaybackMetrics.Builder This value cannot be null.

setVideoFramesDropped

Added in API level 31
fun setVideoFramesDropped(value: Int): PlaybackMetrics.Builder

Sets the video frames dropped.

Parameters
value Int: the video frames dropped. -1 indicates the value is unknown. Value is between -1 and java.lang.Integer#MAX_VALUE inclusive
Return
PlaybackMetrics.Builder This value cannot be null.

setVideoFramesPlayed

Added in API level 31
fun setVideoFramesPlayed(value: Int): PlaybackMetrics.Builder

Sets the video frames played.

Parameters
value Int: the video frames played. -1 indicates the value is unknown. Value is between -1 and java.lang.Integer#MAX_VALUE inclusive
Return
PlaybackMetrics.Builder This value cannot be null.