HTMLTrackElement

A single track represented in the DOM.

Constructor

new HTMLTrackElement(options)

Create an instance of this class.

Parameters:
NameTypeDefaultDescription
optionsObject{}

Object of option names and values

Properties
NameTypeAttributesDefaultDescription
techTech

A reference to the tech that owns this HTMLTrackElement.

kindTextTrack~Kind<optional>
'subtitles'

A valid text track kind.

modeTextTrack~Mode<optional>
'disabled'

A valid text track mode.

idstring<optional>
'vjs_track_' + Guid.newGUID()

A unique id for this TextTrack.

labelstring<optional>
''

The menu label for this track.

languagestring<optional>
''

A valid two character language code.

srclangstring<optional>
''

A valid two character language code. An alternative, but deprioritized version of options.language

srcstring<optional>

A url to TextTrack cues.

defaultboolean<optional>

If this track should default to on or off.

See

Extends

Members

(protected) allowedEvents_

readyState :HTMLTrackElement~ReadyState

The current ready state of the track element.

Type:
  • HTMLTrackElement~ReadyState

track :TextTrack

The underlying TextTrack object.

(static) ERROR :number

The text track failed to load state.

Type:
  • number

(static) LOADED :number

The text track loaded state.

Type:
  • number

(static) LOADING :number

The text track loading state.

Type:
  • number

(static) NONE :number

The text track not loaded state.

Type:
  • number

Methods

addEventListener()

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

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:
NameTypeDescription
typestring | Array.<string>

An event name or an array of event names.

fnfunction

The function to be called once for each event name.

dispatchEvent()

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

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:
NameTypeDescription
typestring | Array.<string>

An event name or an array of event names.

fnfunction

The function to remove.

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:
NameTypeDescription
typestring | Array.<string>

An event name or an array of event names.

fnfunction

The function to call with EventTargets

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:
NameTypeDescription
typestring | Array.<string>

An event name or an array of event names.

fnfunction

The function to be called once for each event name.

removeEventListener()

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

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:
NameTypeDescription
eventstring | EventTarget~Event | Object

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