Extends

• TrackList

Members

inherited protected allowedEvents_

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

Properties:

Name	Type	Description
TrackList#allowedEvents_	Object

inherited lengthnumber

The current number of Tracks in the this Trackist.

Methods

inherited addEventListener()

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

See:

• EventTarget#on

overrides addTrack(track)

Add a TextTrack to the TextTrackList

Name	Type	Description
track	TextTrack	The text track to add to the list.

Fires:

• TrackList#event:addtrack

inherited 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 dispatchEvent()

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

See:

• EventTarget#trigger

inherited 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 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 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 removeEventListener()

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

See:

• EventTarget#off

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

• TrackList#event:removetrack

inherited 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

inherited overrides addtrack

Triggered when a track is added to a track list.

Type:

• Event

Properties:

Name	Type	Description
track	Track	A reference to track that was added.

Listeners of This Event:

• ChaptersButton#update

inherited change

Triggered when a different track is selected/enabled.

Type:

• Event

Listeners of This Event:

• CaptionSettingsMenuItem#handleTracksChange
• ChaptersButton#update
• DescriptionsButton#handleTracksChange
• SubsCapsMenuItem#handleTracksChange
• TextTrackMenuItem#handleTracksChange

inherited removetrack

Triggered when a track is removed from track list.

Type:

• Event

Properties:

Name	Type	Description
track	Track	A reference to track that was removed.

Listeners of This Event:

• ChaptersButton#update