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.

Inherited From:

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

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

Inherited From:

label :string
tracks/track.js, line 87

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

Inherited From:
Fires:

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

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

Inherited From:

inner 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:
Inherited From: