Added in API level 21

Summary: Nested Classes | Constants | Inherited Constants | Fields | Methods | Inherited Methods

TvTrackInfo

---

Kotlin |Java

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

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

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.
String	getEncoding() Returns the codec in the form of mime type.
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.
boolean	isAudioDescription() Returns true if the track is an audio description intended for people with visual impairment, false otherwise.
boolean	isEncrypted() Returns true if the track is encrypted, false otherwise.
boolean	isHardOfHearing() Returns true if the track is intended for people with hearing impairment, false otherwise.
boolean	isSpokenSubtitle() Returns true if the track is a spoken subtitle for people with visual impairment, false otherwise.
void	writeToParcel(Parcel dest, int flags) Used to package this object into a Parcel.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

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(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 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.

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: 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

getEncoding

Added in API level 30

public String getEncoding ()

Returns the codec in the form of mime type. If the encoding is unknown or could not be determined, the corresponding value will be null.

For example of broadcast, codec information may be referred to broadcast standard (e.g. Component Descriptor of ETSI EN 300 468). In the case that track type is subtitle, mime type could be defined in broadcast standard (e.g. "text/dvb.subtitle" or "text/dvb.teletext" in ETSI TS 102 812 V1.3.1 section 7.6).

Returns
String

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	Value is TYPE_AUDIO, TYPE_VIDEO, or TYPE_SUBTITLE

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 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.

isAudioDescription

Added in API level 30

public boolean isAudioDescription ()

Returns true if the track is an audio description intended for people with visual impairment, false otherwise. Valid only for TYPE_AUDIO tracks.

For example of broadcast, audio description information may be referred to broadcast standard (e.g. ISO 639 Language Descriptor of ISO/IEC 13818-1, Supplementary Audio Language Descriptor, AC-3 Descriptor, Enhanced AC-3 Descriptor, AAC Descriptor of ETSI EN 300 468).

Returns
boolean

Throws
IllegalStateException	if not called on an audio track

isEncrypted

Added in API level 30

public boolean isEncrypted ()

Returns true if the track is encrypted, false otherwise. If the encryption status is unknown or could not be determined, the corresponding value will be false.

For example: ISO/IEC 13818-1 defines a CA descriptor that can be used to determine the encryption status of some broadcast streams.

Returns
boolean

isHardOfHearing

Added in API level 30

public boolean isHardOfHearing ()

Returns true if the track is intended for people with hearing impairment, false otherwise. Valid only for TYPE_AUDIO and TYPE_SUBTITLE tracks.

For example of broadcast, hard of hearing information may be referred to broadcast standard (e.g. ISO 639 Language Descriptor of ISO/IEC 13818-1, Supplementary Audio Language Descriptor, AC-3 Descriptor, Enhanced AC-3 Descriptor, AAC Descriptor of ETSI EN 300 468).

Returns
boolean

Throws
IllegalStateException	if not called on an audio track or a subtitle track

isSpokenSubtitle

Added in API level 30

public boolean isSpokenSubtitle ()

Returns true if the track is a spoken subtitle for people with visual impairment, false otherwise. Valid only for TYPE_AUDIO tracks.

For example of broadcast, spoken subtitle information may be referred to broadcast standard (e.g. Supplementary Audio Language Descriptor of ETSI EN 300 468).

Returns
boolean

Throws
IllegalStateException	if not called on an audio track

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. This value cannot be null.
flags	int: The flags used for parceling.