OpenTV Player Web HTML5

Class: TextTrack

TextTrack

A representation of a single TextTrack.

new TextTrack(options)

Create an instance of this class.

Name Type Default Description

options

Object

{}

Object of option names and values

Name	Type	Default	Description
`tech`	Tech		A reference to the tech that owns this TextTrack.
`kind`	TextTrack~Kind	'subtitles'	optional A valid text track kind.
`mode`	TextTrack~Mode	'disabled'	optional A valid text track mode.
`id`	string	'vjs_track_' + Guid.newGUID()	optional 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.

See:

Spec

Extends

Track

Members

activeCuesTextTrackCueList

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

overrides allowedEvents_

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

cuesTextTrackCueList

The text track cue list for this TextTrack.

readonly defaultboolean

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

inherited overrides readonly idstring

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

inherited overrides readonly kindstring

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

inherited overrides labelstring

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

inherited overrides readonly languagestring

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

modestring

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

Methods

addCue(cue)

Add a cue to the internal list of cues.

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

inherited overrides addEventListener()

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

See:

EventTarget#on

inherited overrides dispatchEvent()

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

See:

EventTarget#trigger

inherited overrides 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.

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

inherited overrides 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.

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

inherited overrides 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.

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

removeCue(removeCue)

Remove a cue from our internal list

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

inherited overrides removeEventListener()

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

See:

EventTarget#off

inherited overrides 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.