Player

Enumerations

Events

Enumeration Members

Enumeration Member	Value
AUDIO_TRACKS_CHANGE	"audioTracksChange"
AUTO_QUALITY_CHANGE	"autoQualityChange"
PLAYHEAD_CHANGE	"playheadChange"
QUALITIES_CHANGE	"qualitiesChange"
READY	"ready"
RESET	"reset"
SEEKING_CHANGE	"seekingChange"
STARTED	"started"
SUBTITLE_TRACKS_CHANGE	"subtitleTracksChange"
TIME_CHANGE	"timeChange"
TIMELINE_CHANGE	"timelineChange"
VOLUME_CHANGE	"volumeChange"

Classes

HlsPlayer

Constructors

new HlsPlayer()

new HlsPlayer(container): HlsPlayer

Parameters

Parameter	Type
container	HTMLDivElement

Returns

HlsPlayer

Properties

Property	Type
container	HTMLDivElement
off	<EventKey>(event: EventKey, listener: HlsPlayerEventMap[EventKey]) => EventEmitter<HlsPlayerEventMap>
on	<EventKey>(event: EventKey, listener: HlsPlayerEventMap[EventKey]) => EventEmitter<HlsPlayerEventMap>
once	<EventKey>(event: EventKey, listener: HlsPlayerEventMap[EventKey]) => EventEmitter<HlsPlayerEventMap>

Accessors

audioTracks

Get Signature

get audioTracks(): AudioTrack[]

Returns

AudioTrack[]

autoQuality

Get Signature

get autoQuality(): boolean

Returns

boolean

currentTime

Get Signature

get currentTime(): number

Returns

number

duration

Get Signature

get duration(): number

Returns

number

live

Get Signature

get live(): boolean

Returns

boolean

playhead

Get Signature

get playhead(): Playhead

Returns

Playhead

qualities

Get Signature

get qualities(): Quality[]

Returns

Quality[]

ready

Get Signature

get ready(): boolean

Returns

boolean

seekableStart

Get Signature

get seekableStart(): number

Returns

number

seeking

Get Signature

get seeking(): boolean

Returns

boolean

started

Get Signature

get started(): boolean

Returns

boolean

subtitleTracks

Get Signature

get subtitleTracks(): SubtitleTrack[]

Returns

SubtitleTrack[]

timeline

Get Signature

get timeline(): TimelineItem[]

Returns

TimelineItem[]

unstable_hlsjsVersion

Get Signature

get unstable_hlsjsVersion(): string

Returns

string

volume

Get Signature

get volume(): number

Returns

number

Methods

destroy()

destroy(): void

Returns

void

load()

load(url): void

Parameters

Parameter	Type
url	string

Returns

void

playOrPause()

playOrPause(): void

Returns

void

seekTo()

seekTo(time): void

Parameters

Parameter	Type
time	number

Returns

void

setAudioTrack()

setAudioTrack(id): void

Parameters

Parameter	Type
id	number

Returns

void

setQuality()

setQuality(height): void

Parameters

Parameter	Type
height	null | number

Returns

void

setSubtitleTrack()

setSubtitleTrack(id): void

Parameters

Parameter	Type
id	null | number

Returns

void

setVolume()

setVolume(volume): void

Parameters

Parameter	Type
volume	number

Returns

void

unload()

unload(): void

Returns

void

Interfaces

AudioTrack

Properties

Property	Type
active	boolean
id	number
label	string
track	MediaPlaylist

---

Quality

Properties

Property	Type
active	boolean
height	number
levels	Level[]

---

SubtitleTrack

Properties

Property	Type
active	boolean
id	number
label	string
track	MediaPlaylist

Type Aliases

HlsPlayerEventMap

type HlsPlayerEventMap: object & object;

Type declaration

Name	Type
audioTracksChange	() => void
autoQualityChange	() => void
playheadChange	() => void
qualitiesChange	() => void
ready	() => void
reset	() => void
seekingChange	() => void
started	() => void
subtitleTracksChange	() => void
timeChange	() => void
timelineChange	() => void
volumeChange	() => void

Type declaration

Name	Type
*	(event) => void

---

Playhead

type Playhead: 
  | "idle"
  | "play"
  | "playing"
  | "pause"
  | "ended";