new HTMLTrackElement(options)

[tracks/html-track-element.js](https://docs.videojs.com/tracks_html-track-element.js.html), [line 24](https://docs.videojs.com/tracks_html-track-element.js.html#line24)

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>
‘vjstrack‘ + 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 vesion of options.language

srcstring<optional>

A url to TextTrack cues.

defaultboolean<optional>

If this track should default to on or off.

See:

Extends

Members

readyState :HTMLTrackElement~ReadyState

[tracks/html-track-element.js](https://docs.videojs.com/tracks_html-track-element.js.html), [line 75](https://docs.videojs.com/tracks_html-track-element.js.html#line75)

The current ready state of the track element.

track :TextTrack

[tracks/html-track-element.js](https://docs.videojs.com/tracks_html-track-element.js.html), [line 87](https://docs.videojs.com/tracks_html-track-element.js.html#line87)

The underlying TextTrack object.

Methods

addEventListener()

[event-target.js](https://docs.videojs.com/event-target.js.html), [line 75](https://docs.videojs.com/event-target.js.html#line75)

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

dispatchEvent()

[event-target.js](https://docs.videojs.com/event-target.js.html), [line 175](https://docs.videojs.com/event-target.js.html#line175)

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

off(type, fn)

[event-target.js](https://docs.videojs.com/event-target.js.html), [line 88](https://docs.videojs.com/event-target.js.html#line88)

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.

fnEventTarget~EventListener

The function to remove.

on(type, fn)

[event-target.js](https://docs.videojs.com/event-target.js.html), [line 58](https://docs.videojs.com/event-target.js.html#line58)

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.

fnEventTarget~EventListener

The function to call with EventTargets

one(type, fn)

[event-target.js](https://docs.videojs.com/event-target.js.html), [line 112](https://docs.videojs.com/event-target.js.html#line112)

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.

fnEventTarget~EventListener

The function to be called once for each event name.

removeEventListener()

[event-target.js](https://docs.videojs.com/event-target.js.html), [line 99](https://docs.videojs.com/event-target.js.html#line99)

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

trigger(event)

[event-target.js](https://docs.videojs.com/event-target.js.html), [line 148](https://docs.videojs.com/event-target.js.html#line148)

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.

Type Definitions

NONE

[tracks/html-track-element.js](https://docs.videojs.com/tracks_html-track-element.js.html), [line 13](https://docs.videojs.com/tracks_html-track-element.js.html#line13)