Constructor
new VideoTrackList(tracksopt)
Create an instance of this class.
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
tracks | Array.<VideoTrack> | <optional> | [] | A list of |
- See
Extends
Members
(protected) allowedEvents_
Events that can be called with on + eventName. See EventHandler.
| Name | Type | Description |
|---|---|---|
TrackList#allowedEvents_ | Object |
- Overrides
- Source
length :number
The current number of Tracks in the this Trackist.
- number
- Overrides
- Source
selectedIndex :number
The current index of the selected VideoTrack`.
- number
Methods
addEventListener()
An alias of EventTarget#on. Allows EventTarget to mimic the standard DOM API.
- Overrides
- Source
addTrack(track)
Add a VideoTrack to the VideoTrackList.
| Name | Type | Description |
|---|---|---|
track | VideoTrack | The VideoTrack to add to the list |
- 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 | | An event name or an array of event names. |
fn | function | The function to be called once for each event name. |
- Overrides
- Source
dispatchEvent()
An alias of EventTarget#trigger. Allows EventTarget to mimic the standard DOM API.
- Overrides
- Source
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 | | An event name or an array of event names. |
fn | function | The function to remove. |
- Overrides
- Source
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 | | An event name or an array of event names. |
fn | function | The function to call with |
- Overrides
- Source
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 | | An event name or an array of event names. |
fn | function | The function to be called once for each event name. |
- Overrides
- Source
removeEventListener()
An alias of EventTarget#off. Allows EventTarget to mimic the standard DOM API.
- Overrides
- Source
removeTrack(rtrack)
Remove a Track from the TrackList
| Name | Type | Description |
|---|---|---|
rtrack | Track | The audio, video, or text track to remove from the list. |
- Overrides
- Source
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 | | The name of the event, an |
- Overrides
- Source
Events
addtrack
Triggered when a track is added to a track list.
| Name | Type | Description |
|---|---|---|
track | Track | A reference to track that was added. |
- Overrides
- Source
change
Triggered when a different track is selected/enabled.
- Overrides
- Source
removetrack
Triggered when a track is removed from track list.
| Name | Type | Description |
|---|---|---|
track | Track | A reference to track that was removed. |
- Overrides
- Source