TvTrackInfo
class TvTrackInfo : Parcelable
| kotlin.Any | |
| ↳ | android.media.tv.TvTrackInfo |
Encapsulates the format of tracks played in TvInputService.
Summary
| Nested classes | |
|---|---|
|
A builder class for creating |
|
| 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 | |
| Boolean | |
| Int |
Returns the audio channel count. |
| Int |
Returns the audio sample rate, in the unit of Hz. |
| CharSequence! |
Returns a user readable description for the current track. |
| String? |
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! |
Returns the language information encoded by either ISO 639-1 or ISO 639-2/T. |
| Int |
getType()Returns the type of the track. |
| Byte |
Returns the Active Format Description (AFD) code of the video. |
| Float |
Returns the frame rate of the video, in the unit of fps (frames per second). |
| Int |
Returns the height of the video, in the unit of pixels. |
| 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 |
hashCode() |
| Boolean |
Returns |
| Boolean |
Returns |
| Boolean |
Returns |
| Boolean |
Returns |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Used to package this object into a |
| Properties | |
|---|---|
| static Parcelable.Creator<TvTrackInfo!> | |
Constants
TYPE_AUDIO
static val TYPE_AUDIO: Int
The type value for audio tracks.
Value: 0TYPE_SUBTITLE
static val TYPE_SUBTITLE: Int
The type value for subtitle tracks.
Value: 2TYPE_VIDEO
static val TYPE_VIDEO: Int
The type value for video tracks.
Value: 1Public methods
describeContents
fun describeContents(): Int
| 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 |
equals
fun equals(other: Any?): Boolean
| Parameters | |
|---|---|
obj |
the reference object with which to compare. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getAudioChannelCount
fun getAudioChannelCount(): Int
Returns the audio channel count. Valid only for TYPE_AUDIO tracks.
| Exceptions | |
|---|---|
java.lang.IllegalStateException |
if not called on an audio track |
getAudioSampleRate
fun getAudioSampleRate(): Int
Returns the audio sample rate, in the unit of Hz. Valid only for TYPE_AUDIO tracks.
| Exceptions | |
|---|---|
java.lang.IllegalStateException |
if not called on an audio track |
getDescription
fun getDescription(): CharSequence!
Returns a user readable description for the current track.
getEncoding
fun getEncoding(): String?
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).
getExtra
fun getExtra(): Bundle!
Returns the extra information about the current track.
getLanguage
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.
getType
fun getType(): Int
Returns the type of the track. The type should be one of the followings: TYPE_AUDIO, TYPE_VIDEO and TYPE_SUBTITLE.
| Return | |
|---|---|
Int |
Value is android.media.tv.TvTrackInfo#TYPE_AUDIO, android.media.tv.TvTrackInfo#TYPE_VIDEO, or android.media.tv.TvTrackInfo#TYPE_SUBTITLE |
getVideoActiveFormatDescription
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.
| Exceptions | |
|---|---|
java.lang.IllegalStateException |
if not called on a video track |
getVideoFrameRate
fun getVideoFrameRate(): Float
Returns the frame rate of the video, in the unit of fps (frames per second). Valid only for TYPE_VIDEO tracks.
| Exceptions | |
|---|---|
java.lang.IllegalStateException |
if not called on a video track |
getVideoHeight
fun getVideoHeight(): Int
Returns the height of the video, in the unit of pixels. Valid only for TYPE_VIDEO tracks.
| Exceptions | |
|---|---|
java.lang.IllegalStateException |
if not called on a video track |
getVideoPixelAspectRatio
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.
| Exceptions | |
|---|---|
java.lang.IllegalStateException |
if not called on a video track |
getVideoWidth
fun getVideoWidth(): Int
Returns the width of the video, in the unit of pixels. Valid only for TYPE_VIDEO tracks.
| Exceptions | |
|---|---|
java.lang.IllegalStateException |
if not called on a video track |
isAudioDescription
fun isAudioDescription(): Boolean
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).
| Exceptions | |
|---|---|
java.lang.IllegalStateException |
if not called on an audio track |
isEncrypted
fun isEncrypted(): Boolean
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.
isHardOfHearing
fun isHardOfHearing(): Boolean
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).
| Exceptions | |
|---|---|
java.lang.IllegalStateException |
if not called on an audio track or a subtitle track |
isSpokenSubtitle
fun isSpokenSubtitle(): Boolean
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).
| Exceptions | |
|---|---|
java.lang.IllegalStateException |
if not called on an audio track |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
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. |