Class: TextTrackList

Constructor

new TextTrackList()

Source: tracks/text-track-list.js, line 14
See: Spec

Extends

TrackList

Members

(protected) allowedEvents_

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

Properties

Name	Type	Description
`TrackList#allowedEvents_`	Object

Inherited From: TrackList#allowedEvents_
Source: tracks/track-list.js, line 184

length :number

The current number of Tracks in the this Trackist.

Type:

number

Inherited From: TrackList#length
Source: tracks/track-list.js, line 29

Methods

addEventListener()

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

Inherited From: EventTarget#addEventListener
Source: event-target.js, line 199
See: EventTarget#on

addTrack(track)

Add a TextTrack to the TextTrackList

Parameters:

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

Overrides: TrackList#addTrack
Source: tracks/text-track-list.js, line 24

Fires:

TrackList#event:addtrack

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.

Inherited From: EventTarget#any
Source: event-target.js, line 83

dispatchEvent()

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

Inherited From: EventTarget#dispatchEvent
Source: event-target.js, line 217
See: EventTarget#trigger

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.

Inherited From: EventTarget#off
Source: event-target.js, line 48

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 `EventTarget`s

Inherited From: EventTarget#on
Source: event-target.js, line 28

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.

Inherited From: EventTarget#one
Source: event-target.js, line 62

removeEventListener()

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

Inherited From: EventTarget#removeEventListener
Source: event-target.js, line 208
See: EventTarget#off

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.

Overrides: TrackList#removeTrack
Source: tracks/track-list.js, line 112

Fires:

TrackList#event:removetrack

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: