Class: TextTrack

Constructor

new TextTrack(options)

Create an instance of this class.

Parameters:

Name Type Default Description

options

Object

{}

Object of option names and values

Properties

Name	Type	Attributes	Default	Description
`tech`	default			A reference to the tech that owns this TextTrack.
`kind`	TextTrack~Kind	<optional>	'subtitles'	A valid text track kind.
`mode`	TextTrack~Mode	<optional>	'disabled'	A valid text track mode.
`id`	string	<optional>	'vjs_track_' + Guid.newGUID()	A unique id for this TextTrack.
`label`	string	<optional>	''	The menu label for this track.
`language`	string	<optional>	''	A valid two character language code.
`srclang`	string	<optional>	''	A valid two character language code. An alternative, but deprioritized version of `options.language`
`src`	string	<optional>		A url to TextTrack cues.
`default`	boolean	<optional>		If this track should default to on or off.

Source: tracks/text-track.js, line 123
See: Spec

Extends

Track

Members

activeCues :TextTrackCueList

The list text track cues that are currently active for this TextTrack.

Type:

TextTrackCueList

Source: tracks/text-track.js, line 304

(protected) allowedEvents_

cuechange - One or more cues in the track have become active or stopped being active.

Overrides: Track#allowedEvents_
Source: tracks/text-track.js, line 446

cues :TextTrackCueList

The text track cue list for this TextTrack.

Type:

TextTrackCueList

Source: tracks/text-track.js, line 287

(readonly) default :boolean

If this track was set to be on or off by default. Cannot be changed after creation.

Type:

boolean

Source: tracks/text-track.js, line 226

(readonly) id :string

The id of this track. Cannot be changed after creation.

Type:

string

Overrides: Track#id
Source: tracks/track.js, line 50

(readonly) kind :string

The kind of track that this is. Cannot be changed after creation.

Type:

string

Overrides: Track#kind
Source: tracks/track.js, line 59

label :string

The label of this track. Cannot be changed after creation.

Type:

string

Overrides: Track#label
Source: tracks/track.js, line 87

Fires:

Track#event:labelchange

(readonly) language :string

The two letter language code for this track. Cannot be changed after creation.

Type:

string

Overrides: Track#language
Source: tracks/track.js, line 68

mode :string

Set the mode of this TextTrack to a valid TextTrack~Mode. Will not be set if setting to an invalid mode.

Type:

string

Source: tracks/text-track.js, line 242

Fires:

TextTrack#event:modechange

Methods

addCue(cue)

Add a cue to the internal list of cues.

Parameters:

Name	Type	Description
`cue`	TextTrack~Cue	The cue to add to our internal list

Source: tracks/text-track.js, line 391

addEventListener()

An alias of EventTarget#on. Allows EventTarget to mimic the standard DOM API.

Overrides: Track#addEventListener
Source: event-target.js, line 199
See: EventTarget#on

any(type, fn)

This function will add an event listener that gets triggered only once and is removed from all events. This is like adding an array of event listeners with EventTarget#on that calls EventTarget#off on all events the first time it is triggered.

Parameters:

Name	Type	Description
`type`	string \| Array.<string>	An event name or an array of event names.
`fn`	function	The function to be called once for each event name.

Overrides: Track#any
Source: event-target.js, line 83

dispatchEvent()

An alias of EventTarget#trigger. Allows EventTarget to mimic the standard DOM API.

Overrides: Track#dispatchEvent
Source: event-target.js, line 217
See: EventTarget#trigger

off(type, fn)

Removes an event listener for a specific event from an instance of EventTarget. This makes it so that the event listener will no longer get called when the named event happens.

Parameters:

Name	Type	Description
`type`	string \| Array.<string>	An event name or an array of event names.
`fn`	function	The function to remove.

Overrides: Track#off
Source: event-target.js, line 48

on(type, fn)

Adds an event listener to an instance of an EventTarget. An event listener is a function that will get called when an event with a certain name gets triggered.

Parameters:

Name	Type	Description
`type`	string \| Array.<string>	An event name or an array of event names.
`fn`	function	The function to call with `EventTarget`s

Overrides: Track#on
Source: event-target.js, line 28

one(type, fn)

This function will add an event listener that gets triggered only once. After the first trigger it will get removed. This is like adding an event listener with EventTarget#on that calls EventTarget#off on itself.

Parameters:

Name	Type	Description
`type`	string \| Array.<string>	An event name or an array of event names.
`fn`	function	The function to be called once for each event name.

Overrides: Track#one
Source: event-target.js, line 62

removeCue(removeCue)

Remove a cue from our internal list

Parameters:

Name	Type	Description
`removeCue`	TextTrack~Cue	The cue to remove from our internal list

Source: tracks/text-track.js, line 427

removeEventListener()

An alias of EventTarget#off. Allows EventTarget to mimic the standard DOM API.

Overrides: Track#removeEventListener
Source: event-target.js, line 208
See: EventTarget#off

trigger(event)

This function causes an event to happen. This will then cause any event listeners that are waiting for that event, to get called. If there are no event listeners for an event then nothing will happen.

If the name of the Event that is being triggered is in EventTarget.allowedEvents_. Trigger will also call the on + uppercaseEventName function.

Example: 'click' is in EventTarget.allowedEvents_, so, trigger will attempt to call onClick if it exists.

Parameters: