VideoTrackList

The current list of VideoTrack for a video.

Constructor

new VideoTrackList(tracksopt)

Create an instance of this class.

Parameters:
NameTypeAttributesDefaultDescription
tracksArray.<VideoTrack><optional>
[]

A list of VideoTrack to instantiate the list with.

See

Extends

Members

(protected) allowedEvents_

Events that can be called with on + eventName. See EventHandler.

Properties
NameTypeDescription
TrackList#allowedEvents_Object

length :number

The current number of Tracks in the this Trackist.

Type:
  • number

selectedIndex :number

The current index of the selected VideoTrack`.

Type:
  • number

Methods

addEventListener()

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

addTrack(track)

Add a VideoTrack to the VideoTrackList.

Parameters:
NameTypeDescription
trackVideoTrack

The VideoTrack to add to the list

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:
NameTypeDescription
typestring | Array.<string>

An event name or an array of event names.

fnfunction

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.

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:
NameTypeDescription
typestring | Array.<string>

An event name or an array of event names.

fnfunction

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:
NameTypeDescription
typestring | Array.<string>

An event name or an array of event names.

fnfunction

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:
NameTypeDescription
typestring | Array.<string>

An event name or an array of event names.

fnfunction

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.

removeTrack(rtrack)

Remove a Track from the TrackList

Parameters:
NameTypeDescription
rtrackTrack

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

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:
NameTypeDescription
eventstring | EventTarget~Event | Object

The name of the event, an Event, or an object with a key of type set to an event name.

Events

addtrack

Triggered when a track is added to a track list.

Type:
Properties
NameTypeDescription
trackTrack

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
NameTypeDescription
trackTrack

A reference to track that was removed.