TrackList

Common functionaliy between TextTrackList, AudioTrackList, and VideoTrackList

Constructor

new TrackList(tracks, listopt)

Create an instance of this class

Parameters:
Name Type Attributes Default Description
tracks Array.<Track>

A list of tracks to initialize the list with.

list Object <optional>
null

The child object with inheritance done manually for ie8.

Extends

Members

length :number

The current number of Tracks in the this Trackist.

Methods

addEventListener()

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

Inherited From:
See:

addTrack(track)

Add a Track to the TrackList

Parameters:
Name Type Description
track Track

The audio, video, or text track to add to the list.

Fires:

dispatchEvent()

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

Inherited From:
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 EventTarget~EventListener

The function to remove.

Inherited From:

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 EventTarget~EventListener

The function to call with EventTargets

Inherited From:

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 EventTarget~EventListener

The function to be called once for each event name.

Inherited From:

removeEventListener()

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

Inherited From:
See:

removeTrack(rtrack)

Remove a Track from the TrackList

Parameters:
Name Type Description
rtrack Track

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

Fires:

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.

Inherited From:

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.

change

Triggered when a different track is selected/enabled.

Type:

removetrack

Triggered when a track is removed from track list.

Type:
Properties:
Name Type Description
track Track

A reference to track that was removed.