Interface TrackList<TTrack>

List of tracks.

interface TrackList<TTrack extends Track> {
    length: number;
    addEventListener<TType extends keyof TrackListEventMap>(
        type: TType | readonly TType[],
        listener: EventListener<TrackListEventMap[TType]>,
    ): void;
    item(index: number): TTrack;
    removeEventListener<TType extends keyof TrackListEventMap>(
        type: TType | readonly TType[],
        listener: EventListener<TrackListEventMap[TType]>,
    ): void;
    readonly [index: number]: TTrack;
}

Type Parameters

TTrack extends Track

Hierarchy (View Summary)

ReadonlyArray<TTrack>
EventDispatcher<TrackListEventMap>
- TrackList
  - MediaTrackList
  - TextTracksList

Indexable

readonly [index: number]: TTrack
Index signature to get the track at the requested index in the list.

Index

Properties

Methods

addEventListener item removeEventListener

Properties

`Readonly`length

length: number

The number of tracks in the list.

Methods

addEventListener

addEventListener<TType extends keyof TrackListEventMap>(
type: TType | readonly TType[],
listener: EventListener<TrackListEventMap[TType]>,
): void
Add the given listener for the given event type(s).
Type Parameters
- TType extends keyof TrackListEventMap
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<TrackListEventMap[TType]>
  The callback which is executed when the event occurs.
Returns void
Inherited from EventDispatcher.addEventListener

item

item(index: number): TTrack
Return the track at the requested index in the list.
Parameters
- index: number
  A number representing the index of a track in the list.
Returns TTrack
The track with index index in the list.

removeEventListener

removeEventListener<TType extends keyof TrackListEventMap>(
type: TType | readonly TType[],
listener: EventListener<TrackListEventMap[TType]>,
): void
Remove the given listener for the given event type(s).
Type Parameters
- TType extends keyof TrackListEventMap
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<TrackListEventMap[TType]>
  The callback which will be removed.
Returns void
Inherited from EventDispatcher.removeEventListener