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
Track
s in the this Trackist.
Methods
-
An alias of
EventTarget#on
. AllowsEventTarget
to mimic the standard DOM API.- See:
-
addTrack(track)
-
Add a
Track
to theTrackList
Name Type Description track
Track The audio, video, or text track to add to the list.
Fires:
-
This function will add an
event listener
that gets triggered only once and is removed from all events. This is like adding an array ofevent listener
s withEventTarget#on
that callsEventTarget#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.
-
An alias of
EventTarget#trigger
. AllowsEventTarget
to mimic the standard DOM API.- See:
-
Removes an
event listener
for a specific event from an instance ofEventTarget
. This makes it so that theevent 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.
-
Adds an
event listener
to an instance of anEventTarget
. Anevent 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
EventTarget
s -
This function will add an
event listener
that gets triggered only once. After the first trigger it will get removed. This is like adding anevent listener
withEventTarget#on
that callsEventTarget#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.
-
An alias of
EventTarget#off
. AllowsEventTarget
to mimic the standard DOM API.- See:
-
removeTrack(rtrack)
-
Remove a
Track
from theTrackList
Name Type Description rtrack
Track The audio, video, or text track to remove from the list.
Fires:
-
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 noevent listeners
for an event then nothing will happen.If the name of the
Event
that is being triggered is inEventTarget.allowedEvents_
. Trigger will also call theon
+uppercaseEventName
function.Example: 'click' is in
EventTarget.allowedEvents_
, so, trigger will attempt to callonClick
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.