TvTrackInfo

class TvTrackInfo : Parcelable
kotlin.Any
   ↳ android.media.tv.TvTrackInfo

Encapsulates the format of tracks played in TvInputService.
Requires API level 21 (Android 5.0, Lollipop)

Summary

Nested classes

A builder class for creating TvTrackInfo objects.

Constants
static Int

The type value for audio tracks.

static Int

The type value for subtitle tracks.

static Int

The type value for video tracks.

Inherited constants
Public methods
Int

Returns a hash code value for the object.

Bundle!

Returns the extra information about the current track.

Float

Returns the frame rate of the video, in the unit of fps (frames per second).

Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.

String!

Returns the ID of the track.

Int

Returns the type of the track.

Int

Returns the audio channel count.

Float

Returns the pixel aspect ratio (the ratio of a pixel's width to its height) of the video.

Int

Returns the width of the video, in the unit of pixels.

Int

Returns the audio sample rate, in the unit of Hz.

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

Used to package this object into a Parcel.

Int

Returns the height of the video, in the unit of pixels.

CharSequence!

Returns a user readable description for the current track.

Byte

Returns the Active Format Description (AFD) code of the video.

Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

String!

Returns the language information encoded by either ISO 639-1 or ISO 639-2/T.

Properties
static Parcelable.Creator<TvTrackInfo!>!

Requires API level 21 (Android 5.0, Lollipop)

Constants

TYPE_AUDIO

added in API level 21
static val TYPE_AUDIO: Int

The type value for audio tracks.
Requires API level 21 (Android 5.0, Lollipop)

Value: 0

TYPE_SUBTITLE

added in API level 21
static val TYPE_SUBTITLE: Int

The type value for subtitle tracks.
Requires API level 21 (Android 5.0, Lollipop)

Value: 2

TYPE_VIDEO

added in API level 21
static val TYPE_VIDEO: Int

The type value for video tracks.
Requires API level 21 (Android 5.0, Lollipop)

Value: 1

Public methods

hashCode

added in API level 21
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(Object) 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 java.lang.Object#equals(java.lang.Object) 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.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.) Requires API level 21 (Android 5.0, Lollipop)

Return
Int: a hash code value for this object.

getExtra

added in API level 21
fun getExtra(): Bundle!

Returns the extra information about the current track.
Requires API level 21 (Android 5.0, Lollipop)

getVideoFrameRate

added in API level 21
fun getVideoFrameRate(): Float

Returns the frame rate of the video, in the unit of fps (frames per second). Valid only for #TYPE_VIDEO tracks.
Requires API level 21 (Android 5.0, Lollipop)

Exceptions
IllegalStateException if not called on a video track

equals

added in API level 21
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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes. Requires API level 21 (Android 5.0, Lollipop)

Parameters
obj Any?: the reference object with which to compare.
Return
Boolean: true if this object is the same as the obj argument; false otherwise.

getId

added in API level 21
fun getId(): String!

Returns the ID of the track.
Requires API level 21 (Android 5.0, Lollipop)

getType

added in API level 21
fun getType(): Int

Returns the type of the track. The type should be one of the followings: #TYPE_AUDIO, #TYPE_VIDEO and #TYPE_SUBTITLE.
Requires API level 21 (Android 5.0, Lollipop)

Return
Int: Value is android.media.tv.TvTrackInfo#TYPE_AUDIO, android.media.tv.TvTrackInfo#TYPE_VIDEO, or android.media.tv.TvTrackInfo#TYPE_SUBTITLE

getAudioChannelCount

added in API level 21
fun getAudioChannelCount(): Int

Returns the audio channel count. Valid only for #TYPE_AUDIO tracks.
Requires API level 21 (Android 5.0, Lollipop)

Exceptions
IllegalStateException if not called on an audio track

getVideoPixelAspectRatio

added in API level 23
fun getVideoPixelAspectRatio(): Float

Returns the pixel aspect ratio (the ratio of a pixel's width to its height) of the video. Valid only for #TYPE_VIDEO tracks.
Requires API level 23 (Android 6.0, Marshmallow)

Exceptions
IllegalStateException if not called on a video track

getVideoWidth

added in API level 21
fun getVideoWidth(): Int

Returns the width of the video, in the unit of pixels. Valid only for #TYPE_VIDEO tracks.
Requires API level 21 (Android 5.0, Lollipop)

Exceptions
IllegalStateException if not called on a video track

getAudioSampleRate

added in API level 21
fun getAudioSampleRate(): Int

Returns the audio sample rate, in the unit of Hz. Valid only for #TYPE_AUDIO tracks.
Requires API level 21 (Android 5.0, Lollipop)

Exceptions
IllegalStateException if not called on an audio track

writeToParcel

added in API level 21
fun writeToParcel(dest: Parcel!, flags: Int): Unit

Used to package this object into a Parcel.
Requires API level 21 (Android 5.0, Lollipop)

Parameters
dest Parcel!: The Parcel to be written.
flags Parcel!: The flags used for parceling.

getVideoHeight

added in API level 21
fun getVideoHeight(): Int

Returns the height of the video, in the unit of pixels. Valid only for #TYPE_VIDEO tracks.
Requires API level 21 (Android 5.0, Lollipop)

Exceptions
IllegalStateException if not called on a video track

getDescription

added in API level 23
fun getDescription(): CharSequence!

Returns a user readable description for the current track.
Requires API level 23 (Android 6.0, Marshmallow)

getVideoActiveFormatDescription

added in API level 24
fun getVideoActiveFormatDescription(): Byte

Returns the Active Format Description (AFD) code of the video. Valid only for #TYPE_VIDEO tracks.

The complete list of values are defined in ETSI TS 101 154 V1.7.1 Annex B, ATSC A/53 Part 4 and SMPTE 2016-1-2007.
Requires API level 24 (Android 7.0, Nougat)

Exceptions
IllegalStateException if not called on a video track

describeContents

added in API level 21
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(Parcel, int), the return value of this method must include the #CONTENTS_FILE_DESCRIPTOR bit. Requires API level 21 (Android 5.0, Lollipop)

Return
Int: a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

getLanguage

added in API level 21
fun getLanguage(): String!

Returns the language information encoded by either ISO 639-1 or ISO 639-2/T. If the language is unknown or could not be determined, the corresponding value will be null.
Requires API level 21 (Android 5.0, Lollipop)

Properties

CREATOR

added in API level 21
static val CREATOR: Parcelable.Creator<TvTrackInfo!>!

Requires API level 21 (Android 5.0, Lollipop)