AudioTrackList(tracksopt)

The current list of AudioTrack for a media file.

new AudioTrackList(tracksopt)

Create an instance of this class.

Parameters:
Name Type Attributes Default Description
tracks Array.<AudioTrack> <optional>
[]

A list of AudioTrack to instantiate the list with.

See:

Extends

Members

length :number

The current number of Tracks in the this Trackist.

Overrides:

Methods

addEventListener()

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

Overrides:
See:

addTrack(track)

Add an AudioTrack to the AudioTrackList.

Parameters:
Name Type Description
track default

The AudioTrack to add to the list

Fires:
Overrides:

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:

dispatchEvent()

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

Overrides:
See:

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:

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 EventTargets

Overrides:

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:

removeEventListener()

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

Overrides:
See:

removeTrack(rtrack)

Remove a Track from the TrackList

Parameters:
Name Type Description
rtrack default

The audio, video, or text track to remove from the list.

Fires:
Overrides:

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:

Events

addtrack

Triggered when a track is added to a track list.

Type:
Properties:
Name Type Description
track Track

A reference to track that was added.

Overrides:

change

Triggered when a different track is selected/enabled.

Type:
Listeners of This Event:
Overrides:

removetrack

Triggered when a track is removed from track list.

Type:
Properties:
Name Type Description
track Track

A reference to track that was removed.

Overrides: