AudioTrack

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.

Constructor

new AudioTrack(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 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

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

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

Inherited From:

readonly kind :string

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

Inherited From:

readonly label :string

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

Inherited From:

readonly language :string

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

Inherited From:

inner Kind

All possible AudioTrackKinds

See:

Events

enabledchange

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: