Type

TrackDisposition

Specifies a track's disposition, i.e. information about its intended usage.

type TrackDisposition = {
	default: boolean;
	primary: boolean;
	forced: boolean;
	original: boolean;
	commentary: boolean;
	hearingImpaired: boolean;
	visuallyImpaired: boolean;
};

Used by

• AudioTrackMetadata.disposition
• BaseTrackMetadata.disposition
• InputAudioTrack.disposition
• InputAudioTrack.getDisposition()
• InputTrack.disposition
• InputTrack.getDisposition()
• InputVideoTrack.disposition
• InputVideoTrack.getDisposition()
• SubtitleTrackMetadata.disposition
• VideoTrackMetadata.disposition

Properties

default

default: boolean;

Indicates that this track is eligible for automatic selection by a player. Multiple tracks can be default tracks.

primary

primary: boolean;

Indicates that the track is the primary track among other tracks of its type.

forced

forced: boolean;

Indicates that players should always display this track by default, even if it goes against the user's default preferences. For example, a subtitle track only containing translations of foreign-language audio.

original

original: boolean;

Indicates that this track is in the content's original language.

commentary

commentary: boolean;

Indicates that this track contains commentary.

hearingImpaired

hearingImpaired: boolean;

Indicates that this track is intended for hearing-impaired users.

visuallyImpaired

visuallyImpaired: boolean;

Indicates that this track is intended for visually-impaired users.