OpenTV Player Web HTML5

Class: TrackList

TrackList

Common functionaliy between TextTrackList, AudioTrackList, and VideoTrackList

abstractnew TrackList(tracks)

Create an instance of this class

Name Type Description
tracks Array.<Track>

A list of tracks to initialize the list with.

Extends

Members

overrides protected allowedEvents_

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

Properties:
Name Type Description
TrackList#allowedEvents_ Object

lengthnumber

The current number of Tracks in the this Trackist.

Methods

inherited overrides addEventListener()

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

See:

addTrack(track)

Add a Track to the TrackList

Name Type Description
track Track

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

Fires:

inherited 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.

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.

inherited overrides dispatchEvent()

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

See:

inherited overrides 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.

Name Type Description
type string | Array.<string>

An event name or an array of event names.

fn function

The function to remove.

inherited 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.

Name Type Description
type string | Array.<string>

An event name or an array of event names.

fn function

The function to call with EventTargets

inherited 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.

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.

inherited overrides removeEventListener()

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

See:

removeTrack(rtrack)

Remove a Track from the TrackList

Name Type Description
rtrack Track

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

Fires:

inherited 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.

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.

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.

addtrack

Triggered when a track label is changed.

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.