new AudioTrack(optionsopt)

[tracks/audio-track.js](https://docs.videojs.com/tracks_audio-track.js.html), [line 12](https://docs.videojs.com/tracks_audio-track.js.html#line12)

Create an instance of this class.

Parameters:
NameTypeAttributesDefaultDescription
optionsObject<optional>
{}

Object of option names and values

Properties
NameTypeAttributesDefaultDescription
kindAudioTrack~Kind<optional>
‘’

A valid audio track kind

idstring<optional>
‘vjstrack‘ + Guid.newGUID()

A unique id for this AudioTrack.

labelstring<optional>
‘’

The menu label for this track.

languagestring<optional>
‘’

A valid two character language code.

enabledboolean<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](https://docs.videojs.com/tracks_audio-track.js.html), [line 45](https://docs.videojs.com/tracks_audio-track.js.html#line45)

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](https://docs.videojs.com/tracks_track.js.html), [line 50](https://docs.videojs.com/tracks_track.js.html#line50)

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

readonly kind :string

[tracks/track.js](https://docs.videojs.com/tracks_track.js.html), [line 59](https://docs.videojs.com/tracks_track.js.html#line59)

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

label :string

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

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

Fires:

readonly language :string

[tracks/track.js](https://docs.videojs.com/tracks_track.js.html), [line 68](https://docs.videojs.com/tracks_track.js.html#line68)

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

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

Kind

[tracks/track-enums.js](https://docs.videojs.com/tracks_track-enums.js.html), [line 21](https://docs.videojs.com/tracks_track-enums.js.html#line21)

All possible AudioTrackKinds

Events

enabledchange

[tracks/audio-track.js](https://docs.videojs.com/tracks_audio-track.js.html), [line 65](https://docs.videojs.com/tracks_audio-track.js.html#line65)

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](https://docs.videojs.com/tracks_track.js.html), [line 103](https://docs.videojs.com/tracks_track.js.html#line103)

An event that fires when label changes on this track.

Note: This is not part of the spec!

Type: