Added in API level 31

TrackChangeEvent


class TrackChangeEvent : Event, Parcelable
kotlin.Any
   ↳ android.media.metrics.Event
   ↳ android.media.metrics.TrackChangeEvent

Playback track change event.

Summary

Nested classes

A builder for TrackChangeEvent

Constants
static Int

Track change reason for adaptive changes.

static Int

Track change reason for initial state.

static Int

Track change reason for manual changes.

static Int

Other track change reason.

static Int

Unknown track change reason.

static Int

The track is off.

static Int

The track is on.

static Int

Audio track.

static Int

Text track.

static Int

Video track.

Inherited constants
Public methods
Int

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

Gets audio sample rate.

Int

Gets bitrate.

Int

Gets channel count.

String?

Gets codec name.

String?

Gets container MIME type.

Int

Gets video height.

String?

Gets language code.

String?

Gets language region code.

Bundle

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

String?

Gets the MIME type of the video/audio/text samples.

Long

Gets timestamp since the creation of the log session in milliseconds.

Int

Gets track change reason.

Int

Gets track state.

Int

Gets the track type.

Float

Gets video frame rate.

Int

Gets video width.

Int

Returns a hash code value for the object.

String

Returns a string representation of the object.

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<TrackChangeEvent!>

Constants

TRACK_CHANGE_REASON_ADAPTIVE

Added in API level 31
static val TRACK_CHANGE_REASON_ADAPTIVE: Int

Track change reason for adaptive changes.

Value: 4

TRACK_CHANGE_REASON_INITIAL

Added in API level 31
static val TRACK_CHANGE_REASON_INITIAL: Int

Track change reason for initial state.

Value: 2

TRACK_CHANGE_REASON_MANUAL

Added in API level 31
static val TRACK_CHANGE_REASON_MANUAL: Int

Track change reason for manual changes.

Value: 3

TRACK_CHANGE_REASON_OTHER

Added in API level 31
static val TRACK_CHANGE_REASON_OTHER: Int

Other track change reason.

Value: 1

TRACK_CHANGE_REASON_UNKNOWN

Added in API level 31
static val TRACK_CHANGE_REASON_UNKNOWN: Int

Unknown track change reason.

Value: 0

TRACK_STATE_OFF

Added in API level 31
static val TRACK_STATE_OFF: Int

The track is off.

Value: 0

TRACK_STATE_ON

Added in API level 31
static val TRACK_STATE_ON: Int

The track is on.

Value: 1

TRACK_TYPE_AUDIO

Added in API level 31
static val TRACK_TYPE_AUDIO: Int

Audio track.

Value: 0

TRACK_TYPE_TEXT

Added in API level 31
static val TRACK_TYPE_TEXT: Int

Text track.

Value: 2

TRACK_TYPE_VIDEO

Added in API level 31
static val TRACK_TYPE_VIDEO: Int

Video track.

Value: 1

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

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.

getAudioSampleRate

Added in API level 31
fun getAudioSampleRate(): Int

Gets audio sample rate.

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

getBitrate

Added in API level 31
fun getBitrate(): Int

Gets bitrate.

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

getChannelCount

Added in API level 31
fun getChannelCount(): Int

Gets channel count.

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

getCodecName

Added in API level 31
fun getCodecName(): String?

Gets codec name.

Return
String? This value may be null.

getContainerMimeType

Added in API level 31
fun getContainerMimeType(): String?

Gets container MIME type.

Return
String? This value may be null.

getHeight

Added in API level 31
fun getHeight(): Int

Gets video height.

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

getLanguage

Added in API level 31
fun getLanguage(): String?

Gets language code.

Return
String? a two-letter ISO 639-1 language code.
This value may be null.

getLanguageRegion

Added in API level 31
fun getLanguageRegion(): String?

Gets language region code.

Return
String? an IETF BCP 47 optional language region subtag based on a two-letter country code.
This value may be null.

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.

getSampleMimeType

Added in API level 31
fun getSampleMimeType(): String?

Gets the MIME type of the video/audio/text samples.

Return
String? This value may be null.

getTimeSinceCreatedMillis

Added in API level 31
fun getTimeSinceCreatedMillis(): Long

Gets timestamp since the creation of the log session in milliseconds.

Return
Long the timestamp since the creation in milliseconds, or -1 if unknown.
Value is -1 or greater

getTrackChangeReason

Added in API level 31
fun getTrackChangeReason(): Int

Gets track change reason.

Return
Int Value is one of the following:

getTrackState

Added in API level 31
fun getTrackState(): Int

Gets track state.

Return
Int Value is one of the following:

getTrackType

Added in API level 31
fun getTrackType(): Int

Gets the track type.

The track type must be one of TRACK_TYPE_AUDIO, TRACK_TYPE_VIDEO, TRACK_TYPE_TEXT.

Return
Int Value is one of the following:

getVideoFrameRate

Added in API level 31
fun getVideoFrameRate(): Float

Gets video frame rate.

Return
Float the video frame rate, or -1 if unknown.
Value is between -1.0f and java.lang.Float#MAX_VALUE inclusive

getWidth

Added in API level 31
fun getWidth(): Int

Gets video width.

Return
Int the video width, 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:

Properties

CREATOR

Added in API level 31
static val CREATOR: Parcelable.Creator<TrackChangeEvent!>