HTMLTrackElement(options)

A single track represented in the DOM.

new HTMLTrackElement(options)
tracks/html-track-element.js, line 14

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 HTMLTrackElement.
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.
See:

Extends

Members

static ERROR :number
tracks/html-track-element.js, line 142

The text track failed to load state.

static LOADED :number
tracks/html-track-element.js, line 134

The text track loaded state.

static LOADING :number
tracks/html-track-element.js, line 126

The text track loading state.

static NONE :number
tracks/html-track-element.js, line 118

The text track not loaded state.

readyState :HTMLTrackElement~ReadyState
tracks/html-track-element.js, line 65

The current ready state of the track element.

track :TextTrack
tracks/html-track-element.js, line 77

The underlying TextTrack object.

Methods

addEventListener()
event-target.js, line 199

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

Overrides:
See:

any(type, fn)
event-target.js, line 83

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:

dispatchEvent()
event-target.js, line 217

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

Overrides:
See:

off(type, fn)
event-target.js, line 48

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:

on(type, fn)
event-target.js, line 28

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 EventTargets
Overrides:

one(type, fn)
event-target.js, line 62

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:

removeEventListener()
event-target.js, line 208

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

Overrides:
See:

trigger(event)
event-target.js, line 108

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:
Name Type Description
event string | EventTarget~Event | Object

The name of the event, an Event, or an object with a key of type set to an event name.
Overrides: