Revision as of 03:56, 2 September 2020

Track

Java API: Track
JavaScript API: Track

[Since 9.5.0]

Employment/Purpose

It lets you specify some timed text tracks like captions or subtitles for media components such as Audio or Video.

Example

 <video src="course.mp4" controls="true">
   <track kind="captions" src="transcript.vtt" srclang="en" default="true"/>
   <track kind="subtitles" src="transcript_fr.vtt" srclang="fr"/>
   <track kind="subtitles" src="transcript_de.vtt" srclang="de"/>
   <track kind="subtitles" src="transcript_zh.vtt" srclang="zh"/>
 </video>

 <audio src="music.wav" controls="true">
   <track kind="captions" src="music_lyric.vtt" srclang="en" default="true"/>
   <track kind="subtitles" src="music_lyric_fr.vtt" srclang="fr"/>
   <track kind="subtitles" src="music_lyric_de.vtt" srclang="de"/>
   <track kind="subtitles" src="music_lyric_zh.vtt" srclang="zh"/>
 </audio>

Supported Browsers

It is compatible with HTML5-supported browsers, like IE 10, Edge, Firefox, Opera, Chrome, and Safari.

Tracks don't be supported in Internet Explorer 9.

Properties

Default

Specify if the track should be used by default. It must be used on one track only.

Kind

Specify what kind of track it is. Allowed values are:

Name	Description
subtitles	Closed subtitles.
captions	Closed captions.
descriptions	A textual description about what this video/audio is.
chapters	Chapter titles for users to navigate.
metadata	A track used by scripts.

Label

Specify a user-readable title. Used by browsers to show on the list of available tracks.

Src

The URL of the source file. The file must be in WebVTT format. This attribute is required.

Srclang

Specify what language this track is. It's required if the kind is subtitles. It must be a valid BCP 47 language tag. For instance, fr-FR and en-US are valid.

Supported Events

Name	Event Type
None	None

Inherited Supported Events: XulElement

Supported Children

*NONE

Use Cases

Version	Description	Example Location

Version History

Last Update : 2020/09/02

Version	Date	Content
9.5.0	September 2020	ZK-4648: Audio supports to add tracks ZK-4649: Video supports to add tracks