new abstract TrackList(tracks)
Create an instance of this class
Parameters:
| Name | Type | Description |
|---|---|---|
tracks |
Array.<Track> | A list of tracks to initialize the list with. |
Extends
Members
-
length :number
-
The current number of
Tracks in the this Trackist.
Methods
-
addEventListener()
-
An alias of EventTarget#on. Allows
EventTargetto mimic the standard DOM API.- Overrides:
- See:
-
addTrack(track)
-
Add a Track to the
TrackListParameters:
Name Type Description trackTrack The audio, video, or text track to add to the list.
Fires:
-
dispatchEvent()
-
An alias of EventTarget#trigger. Allows
EventTargetto mimic the standard DOM API.- Overrides:
- See:
-
off(type, fn)
-
Removes an
event listenerfor a specific event from an instance ofEventTarget. This makes it so that theevent listenerwill no longer get called when the named event happens.Parameters:
Name Type Description typestring | Array.<string> An event name or an array of event names.
fnEventTarget~EventListener The function to remove.
- Overrides:
-
on(type, fn)
-
Adds an
event listenerto an instance of anEventTarget. Anevent listeneris a function that will get called when an event with a certain name gets triggered.Parameters:
Name Type Description typestring | Array.<string> An event name or an array of event names.
fnEventTarget~EventListener The function to call with
EventTargets- Overrides:
-
one(type, fn)
-
This function will add an
event listenerthat gets triggered only once. After the first trigger it will get removed. This is like adding anevent listenerwith EventTarget#on that calls EventTarget#off on itself.Parameters:
Name Type Description typestring | Array.<string> An event name or an array of event names.
fnEventTarget~EventListener The function to be called once for each event name.
- Overrides:
-
removeEventListener()
-
An alias of EventTarget#off. Allows
EventTargetto mimic the standard DOM API.- Overrides:
- See:
-
removeTrack(rtrack)
-
Remove a Track from the
TrackListParameters:
Name Type Description rtrackTrack 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 listenersthat are waiting for that event, to get called. If there are noevent listenersfor an event then nothing will happen.If the name of the
Eventthat is being triggered is inEventTarget.allowedEvents_. Trigger will also call theon+uppercaseEventNamefunction.Example: 'click' is in
EventTarget.allowedEvents_, so, trigger will attempt to callonClickif it exists.Parameters:
Name Type Description eventstring | EventTarget~Event | Object The name of the event, an
Event, or an object with a key of type set to an event name.- Overrides:
Events
-
addtrack
-
Triggered when a track is added to a track list.
Type:
Properties:
Name Type Description 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:
Name Type Description trackTrack A reference to track that was removed.