Interface MediaTrack

Represents a media track (audio or video) of a media resource.

interface MediaTrack {
    accessibility: AccessibilityRole[];
    activeQuality: undefined | Quality;
    enabled: boolean;
    id: string;
    kind: string;
    label: string;
    language: string;
    qualities: QualityList;
    targetQuality: undefined | Quality | Quality[];
    uid: number;
    addEventListener<TType>(type: TType | readonly TType[], listener: EventListener<MediaTrackEventMap[TType]>): void;
    removeEventListener<TType>(type: TType | readonly TType[], listener: EventListener<MediaTrackEventMap[TType]>): void;
}

Hierarchy (view full)

Properties

accessibility activeQuality enabled id kind label language qualities targetQuality uid

Methods

addEventListener removeEventListener

Properties

Readonlyaccessibility

accessibility: AccessibilityRole[]

The accessibility settings of the track.

Remarks


- For DASH: the accessibility descriptors for the corresponding AdaptationSet.
- For HLS: the CHARACTERISTICS for the corresponding #EXT-X-MEDIA tag.

ReadonlyactiveQuality

activeQuality: undefined | Quality

The active quality of the media track, i.e. the quality that is currently being played.

enabled

enabled: boolean

Whether the track is enabled.

Remarks


- Only one track of the same type (e.g. video) can be enabled at the same time.
- Enabling a track will disable all other tracks of the same type.
- Disabling a track will not enable a different track of the same type.

Readonlyid

id: string

The identifier of the media track.

Remarks


- This identifier can be used to distinguish between related tracks, e.g. tracks in the same list.

Readonlykind

kind: string

The kind of the media track, represented by a value from the following list:
- 'main': The track is the default track for playback
- 'alternative': The track is not the default track for playback

label

label: string

The label of the media track.

Readonlylanguage

language: string

The language of the media track.

Readonlyqualities

qualities: QualityList

The qualities of the media track.

targetQuality

targetQuality: undefined | Quality | Quality[]

One or more desired qualities of the media track.

Remarks


- If desired qualities are present, the Adaptive Bitrate mechanism of the player will limit itself to these qualities.
- If one desired quality is present, the Adaptive Bitrate mechanism of the player will be disabled and the desired quality will be played back.

Readonlyuid

uid: number

A unique identifier of the media track.

Remarks


- This identifier is unique across tracks of a THEOplayer instance and can be used to distinguish between tracks.
- This identifier is a randomly generated number.

Methods

addEventListener

removeEventListener

Settings

Member Visibility

On This Page

Properties
Methods