Optional
defaultWhether the text track should be enabled by default.
Optional
formatThe format of the track, represented by a value from the following list:
- 'srt'
- 'ttml'
- 'webvtt'
- 'emsg'
- 'eventstream'
- 'id3'
- 'cea608'
- 'daterange'
''
Optional
Internal
idThe identifier of this text track.
Optional
kindThe kind of the text track, represented by a value from the following list:
- 'subtitles'
: The track provides subtitles, used to display subtitles in a video.
- 'captions'
: The track provides a translation of dialogue and sound effects (suitable for users with a hearing impairment).
- 'descriptions'
: The track provides a textual description of the video (suitable for users with a vision impairment).
- 'chapters'
: The track provides chapter titles (suitable for navigating the media resource).
- 'metadata'
: The track provides content used by scripts and is not visible for users.
- If an unrecognized value is provided, the player will interpret it as 'metadata'
.
'subtitles'
Optional
labelA label for the text track.
- This will be used as an identifier on the player API and in the UI.
The source URL of the text track.
Optional
srclangThe language of the text track.
Optional
Internal
subtitleThe localTime that matches the PTS value that is used to sync the track with the video.
- Available on iOS.
- Format: "HH:mm:mm:SSS"
- Default value is "00:00:00:000"
Optional
Internal
subtitlePTSThe PTS value used to sync the track with the video.
- Available on iOS.
Generated using TypeDoc
Describes the configuration of a side-loaded text track.