Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.

TvTrackInfo

public final class TvTrackInfo
extends Object implements Parcelable

java.lang.Object
   ↳ android.media.tv.TvTrackInfo


Encapsulates the format of tracks played in TvInputService.

Summary

Nested classes

class TvTrackInfo.Builder

A builder class for creating TvTrackInfo objects. 

Constants

int TYPE_AUDIO

The type value for audio tracks.

int TYPE_SUBTITLE

The type value for subtitle tracks.

int TYPE_VIDEO

The type value for video tracks.

Inherited constants

Fields

public static final Creator<TvTrackInfo> 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 getAudioChannelCount()

Returns the audio channel count.

int getAudioSampleRate()

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

CharSequence getDescription()

Returns a user readable description for the current track.

Bundle getExtra()

Returns the extra information about the current track.

String getId()

Returns the ID of the track.

String getLanguage()

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

int getType()

Returns the type of the track.

byte getVideoActiveFormatDescription()

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

float getVideoFrameRate()

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

int getVideoHeight()

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

float getVideoPixelAspectRatio()

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

int getVideoWidth()

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

int hashCode()

Returns a hash code value for the object.

void writeToParcel(Parcel dest, int flags)

Used to package this object into a Parcel.

Inherited methods

Constants

TYPE_AUDIO

added in API level 21
public static final int TYPE_AUDIO

The type value for audio tracks.

Constant Value: 0 (0x00000000)

TYPE_SUBTITLE

added in API level 21
public static final int TYPE_SUBTITLE

The type value for subtitle tracks.

Constant Value: 2 (0x00000002)

TYPE_VIDEO

added in API level 21
public static final int TYPE_VIDEO

The type value for video tracks.

Constant Value: 1 (0x00000001)

Fields

CREATOR

added in API level 21
public static final Creator<TvTrackInfo> CREATOR

Public methods

describeContents

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

equals

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

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.

Parameters
o Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getAudioChannelCount

added in API level 21
public int getAudioChannelCount ()

Returns the audio channel count. Valid only for TYPE_AUDIO tracks.

Returns
int

Throws
IllegalStateException if not called on an audio track

getAudioSampleRate

added in API level 21
public int getAudioSampleRate ()

Returns the audio sample rate, in the unit of Hz. Valid only for TYPE_AUDIO tracks.

Returns
int

Throws
IllegalStateException if not called on an audio track

getDescription

added in API level 23
public CharSequence getDescription ()

Returns a user readable description for the current track.

Returns
CharSequence

getExtra

added in API level 21
public Bundle getExtra ()

Returns the extra information about the current track.

Returns
Bundle

getId

added in API level 21
public String getId ()

Returns the ID of the track.

Returns
String

getLanguage

added in API level 21
public String getLanguage ()

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.

Returns
String

getType

added in API level 21
public int getType ()

Returns the type of the track. The type should be one of the followings: TYPE_AUDIO, TYPE_VIDEO and TYPE_SUBTITLE.

Returns
int

getVideoActiveFormatDescription

added in API level 24
public byte getVideoActiveFormatDescription ()

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.

Returns
byte

Throws
IllegalStateException if not called on a video track

getVideoFrameRate

added in API level 21
public float getVideoFrameRate ()

Returns the frame rate of the video, in the unit of fps (frames per second). Valid only for TYPE_VIDEO tracks.

Returns
float

Throws
IllegalStateException if not called on a video track

getVideoHeight

added in API level 21
public int getVideoHeight ()

Returns the height of the video, in the unit of pixels. Valid only for TYPE_VIDEO tracks.

Returns
int

Throws
IllegalStateException if not called on a video track

getVideoPixelAspectRatio

added in API level 23
public float getVideoPixelAspectRatio ()

Returns the pixel aspect ratio (the ratio of a pixel's width to its height) of the video. Valid only for TYPE_VIDEO tracks.

Returns
float

Throws
IllegalStateException if not called on a video track

getVideoWidth

added in API level 21
public int getVideoWidth ()

Returns the width of the video, in the unit of pixels. Valid only for TYPE_VIDEO tracks.

Returns
int

Throws
IllegalStateException if not called on a video track

hashCode

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

Returns
int a hash code value for this object.

writeToParcel

added in API level 21
public void writeToParcel (Parcel dest, 
                int flags)

Used to package this object into a Parcel.

Parameters
dest Parcel: The Parcel to be written.

flags int: The flags used for parceling.