Constructor
new hlsLiveStreamHandler(client, player, media)
Instantiates a new HLS Live Stream Handler object
Parameters:
| Name | Type | Description |
|---|---|---|
client |
channel | Parent Client Management Object |
player |
player | Parent Canopy Player Object |
media |
Object | De-hydrated media object from server |
- Source:
Extends
Members
client
Parent Client Management Object
- Overrides:
- Source:
player
Parent Canopy Player Object
- Overrides:
- Source:
type
Media Handler Source Type
- Overrides:
- Source:
Methods
buildPlayer()
Builds video player element
- Overrides:
- Source:
defineListeners()
Defines input-related event listeners
- Overrides:
- Source:
destroyPlayer()
Destroys video player element
- Overrides:
- Source:
end()
Handles media end
- Overrides:
- Source:
getRatio() → {Number}
Calculates Aspect Ratio of media
- Overrides:
- Source:
Returns:
Media Aspect Ratio as Floating Point number
- Type
- Number
getTimestamp() → {Number}
Gets current timestamp from video
- Overrides:
- Source:
Returns:
Media Timestamp in seconds
- Type
- Number
ingestMedia(media) → {Boolean}
Ingests media object from server
Parameters:
| Name | Type | Description |
|---|---|---|
media |
Object | Media object from the server |
- Overrides:
- Source:
Returns:
True upon success
- Type
- Boolean
onBuffer(event)
Called on media buffer
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Event | Event passed down by event handler |
- Overrides:
- Source:
onMetadataLoad(event)
Called once all video metadata has properly been fetched
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Event | Event passed down by event handler |
- Overrides:
- Source:
onPause(event)
Called on media pause
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Event | Event passed down by event handler |
- Overrides:
- Source:
onSeek(event)
Called on media seek
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Event | Event passed down by event handler |
- Overrides:
- Source:
onVolumeChange(event)
Called on media volume change
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Event | Event passed down by event handler |
- Overrides:
- Source:
pause()
Pauses video
- Overrides:
- Source:
play()
Plays video
- Overrides:
- Source:
reload()
Reloads media player
- Overrides:
- Source:
setPlayerLock(lock)
Toggles player control lockout
Parameters:
| Name | Type | Description |
|---|---|---|
lock |
Boolean | Whether or not to lock-out user control of video |
- Overrides:
- Source:
setVideoTitle(title)
Sets player title
Parameters:
| Name | Type | Description |
|---|---|---|
title |
String | Title to set |
- Overrides:
- Source:
start()
Starts video playback
- Overrides:
- Source:
startMedia(media)
Ingests media nd starts playback
Parameters:
| Name | Type | Description |
|---|---|---|
media |
Object | Media object from server |
- Overrides:
- Source:
sync(timestamp)
Syncronizes timestamp based on timestamp received from server
Parameters:
| Name | Type | Description |
|---|---|---|
timestamp |
Number | Current video timestamp in seconds |
- Overrides:
- Source: