Class: AudioTrack

Constructor#

new AudioTrack(optionsopt)#

Create an instance of this class.

Parameters:

Name Type Attributes Default Description

options

Object

{}

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.

Source: tracks/audio-track.js, line 12
See: Spec

Extends#

Track

Members#

(protected) allowedEvents_#

An object containing event names as keys and booleans as values.

NOTE: If an event name is set to a true value here EventTarget#trigger will have extra functionality. See that function for more information.

Properties

Name	Type	Description
`EventTarget.prototype.allowedEvents_`

Overrides: Track#allowedEvents_
Source: event-target.js, line 190

enabled :boolean#

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

Type:

boolean

Source: tracks/audio-track.js, line 45

Fires:

VideoTrack#event:selectedchange

(readonly) id :string#

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

Type:

string

Overrides: Track#id
Source: tracks/track.js, line 50

(readonly) kind :string#

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

Type:

string

Overrides: Track#kind
Source: tracks/track.js, line 59

label :string#

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

Type:

string

Overrides: Track#label
Source: tracks/track.js, line 87

Fires:

Track#event:labelchange

(readonly) language :string#

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

Type:

string

Overrides: Track#language
Source: tracks/track.js, line 68

Methods#

addEventListener()#

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

Overrides: Track#addEventListener
Source: event-target.js, line 199
See: EventTarget#on

any(type, fn)#

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: Track#any
Source: event-target.js, line 83

dispatchEvent()#

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

Overrides: Track#dispatchEvent
Source: event-target.js, line 217
See: EventTarget#trigger

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`	function	The function to remove.

Overrides: Track#off
Source: event-target.js, line 48

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`	function	The function to call with `EventTarget`s

Overrides: Track#on
Source: event-target.js, line 28

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`	function	The function to be called once for each event name.

Overrides: Track#one
Source: event-target.js, line 62

removeEventListener()#

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

Overrides: Track#removeEventListener
Source: event-target.js, line 208
See: EventTarget#off

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.

Overrides: Track#trigger
Source: event-target.js, line 108

Type Definitions#

Kind#

All possible AudioTrackKinds

Source: tracks/track-enums.js, line 21
See: https://html.spec.whatwg.org/multipage/embedded-content.html#dom-audiotrack-kind

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:

Event

Source: tracks/audio-track.js, line 65

labelchange#

An event that fires when label changes on this track.

Note: This is not part of the spec!

Type:

Event

Overrides: Track#event:labelchange
Source: tracks/track.js, line 103