Class HlsWebSocket

Controller to pull HLS from a CDN server and sent it to a media element

Hierarchy

HlsWebSocket

Index

Constructors

Properties

client eventListeners mediaSourceController muxer options

Methods

addEventListener attachMedia destroy detachMedia removeEventListener setDelayOptions start trigger isSupported

Constructors

constructor

new HlsWebSocket(options: HlsWebSocketCdnClientOptions): HlsWebSocket
Constructor for HlsWebSocket
Parameters
- options: HlsWebSocketCdnClientOptions
  
  The options
Returns HlsWebSocket
- Defined in hls.ts:74

Properties

`Private` client

client: HlsWebSocketCdnClient

Client

`Private` eventListeners

eventListeners: {
[eventName: string]: ((...args: any[]) => void)[];
}

Event listeners

Type declaration

[eventName: string]: ((...args: any[]) => void)[]

`Private` mediaSourceController

mediaSourceController: MediaSourceController

Media source controller

`Private` muxer

muxer: Mp4Muxer

Muxer

`Private` options

options: HlsWebSocketCdnClientOptions

Options

Methods

addEventListener

addEventListener<K>(eventName: K, handler: HlsWebSocketEventMap[K]): void
Adds event listener
Type Parameters
- K extends keyof HlsWebSocketEventMap
Parameters
- eventName: K
  
  The event name
- handler: HlsWebSocketEventMap[K]
  
  The event handler
Returns void
- Defined in hls.ts:144

attachMedia

attachMedia(mediaElement: HTMLMediaElement): void
Attaches to media element for playback
Parameters
- mediaElement: HTMLMediaElement
  
  The media element
Returns void
- Defined in hls.ts:173

destroy

destroy(): void
Releases all resources

Returns void
- Defined in hls.ts:201

detachMedia

detachMedia(): void
Detaches from the current attached media element

Returns void
- Defined in hls.ts:180

removeEventListener

removeEventListener<K>(eventName: K, handler: HlsWebSocketEventMap[K]): void
Removes event listener
Type Parameters
- K extends keyof HlsWebSocketEventMap
Parameters
- eventName: K
  
  The event name
- handler: HlsWebSocketEventMap[K]
  
  The event handler (the used in addEventListener)
Returns void
- Defined in hls.ts:156

setDelayOptions

setDelayOptions(delay: number, maxDelay?: number): void
Sets delay options
Parameters
- delay: number
  
  The desired delay (seconds)
- Optional maxDelay: number
  
  The max delay (seek if exceeded) (seconds)
Returns void
- Defined in hls.ts:189

start

start(): void
Starts the client

Returns void
- Defined in hls.ts:118

trigger

trigger<K>(eventName: K, ...args: Parameters<HlsWebSocketEventMap[K]>): void
Triggers an event
Type Parameters
- K extends keyof HlsWebSocketEventMap
Parameters
- eventName: K
  
  The event name
- Rest ...args: Parameters<HlsWebSocketEventMap[K]>
  
  The arguments
Returns void
- Defined in hls.ts:127

`Static` isSupported

isSupported(): boolean
Checks if MSE is supported (required for this library to work) If not supported, you may use regular HLS instead

Returns
True if supported

Returns boolean
- Defined in hls.ts:41

Generated using TypeDoc