Track

A Track class that contains all of the common functionality for AudioTrack, VideoTrack, and TextTrack.

Note: This class should not be used directly

Constructor

abstract new Track(optionsopt)

Create an instance of this class.

Parameters:
Name Type Attributes Default Description
options Object <optional>
{}

Object of option names and values

Properties
Name Type Attributes Default Description
kind string <optional>
''

A valid kind for the track type you are creating.

id string <optional>
'vjs_track_' + Guid.newGUID()

A unique id for this AudioTrack.

label string <optional>
''

The menu label for this track.

language string <optional>
''

A valid two character language code.

See:

Extends

Members

readonly id :string

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

readonly kind :string

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

readonly label :string

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

readonly language :string

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

Methods

addEventListener()

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

Inherited From:
See:

dispatchEvent()

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

Inherited From:
See:

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 EventTarget~EventListener

The function to remove.

Inherited From:

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 EventTarget~EventListener

The function to call with EventTargets

Inherited From:

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 EventTarget~EventListener

The function to be called once for each event name.

Inherited From:

removeEventListener()

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

Inherited From:
See:

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

Inherited From: