cast.framework.messages. Track
Describes track metadata information.
Constructor
Track
new Track(trackId, trackType)
Parameter |
|
|---|---|
|
trackId |
number Unique identifier for the track. |
|
trackType |
cast.framework.messages.TrackType The type of track. Value must not be null. |
Properties
customData
(non-null Object or undefined)
Custom data set by the receiver application.
isInband
(boolean or undefined)
Indicate track is in-band and not side-loaded track. Relevant only for text tracks.
language
(string or undefined)
Language tag as per RFC 5646 (If subtype is “SUBTITLES” it is mandatory).
name
(string or undefined)
A descriptive, human-readable name for the track. For example "Spanish".
roles
(non-null Array of string or undefined)
The role(s) of the track. The following values for each media type are recognized, with value explanations described in ISO/IEC 23009-1, labeled "DASH role scheme":
- VIDEO: caption, subtitle, main, alternate, supplementary, sign, emergency
- AUDIO: main, alternate, supplementary, commentary, dub, emergency
- TEXT: main, alternate, subtitle, supplementary, commentary, dub, description, forced_subtitle
subtype
(string or undefined)
For text tracks, the type of text track.
trackContentId
(string or undefined)
It can be the URL of the track or any other identifier that allows the receiver to find the content (when the track is not inband or included in the manifest). For example it can be the URL of a vtt file.
trackContentType
(string, non-null cast.framework.messages.CaptionMimeType, or undefined)
It represents the MIME type of the track content. For example if the track is a vtt file it will be ‘text/vtt’. This field is needed for out of band tracks, so it is usually provided if a trackContentId has also been provided. It is not mandatory if the receiver has a way to identify the content from the trackContentId, but recommended. The track content type, if provided, must be consistent with the track type.
trackId
number
Unique identifier of the track within the context of a MediaInformation object.
type
non-null cast.framework.messages.TrackType
The type of track.