AudioTrack(optionsopt)

A representation of a single AudioTrack. If it is part of an AudioTrackList only one AudioTrack in the list will be enabled at a time.

new AudioTrack(optionsopt)
tracks/audio-track.js, line 12

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 AudioTrack~Kind <optional>
 ''

A valid audio track kind
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.
enabled boolean <optional>

If this track is the one that is currently playing. If this track is part of an AudioTrackList, only one AudioTrack will be enabled.
See:

Extends

Members

enabled :boolean
tracks/audio-track.js, line 45

If this AudioTrack is enabled or not. When setting this will fire AudioTrack#enabledchange if the state of enabled is changed.

Fires:

readonly id :string
tracks/track.js, line 50

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

Overrides:

readonly kind :string
tracks/track.js, line 59

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

Overrides:

label :string
tracks/track.js, line 87

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

Overrides:
Fires:

readonly language :string
tracks/track.js, line 68

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

Overrides:

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:

Type Definitions

Kind
tracks/track-enums.js, line 21

All possible AudioTrackKinds

See:

Events

enabledchange
tracks/audio-track.js, line 65

An event that fires when enabled changes on this track. This allows the AudioTrackList that holds this track to act accordingly.

Note: This is not part of the spec! Native tracks will do this internally without an event.

Type:

labelchange
tracks/track.js, line 103

An event that fires when label changes on this track.

Note: This is not part of the spec!

Type:
Overrides: