Class HlsResource

HLS API — vsdk.hls.

start(roomId, opts) begins HLS and returns an EgressHandle; get(roomId) fetches the room's currently-active stream (with playback URLs); stop(roomId) ends it.

Index

Constructors

Methods

capture delete get getById list start stop

Constructors

constructor

new HlsResource(http: HttpClient): HlsResource
Parameters
- http: HttpClient
Returns HlsResource

Methods

capture

capture(options: CaptureHlsOptions): Promise<CaptureHlsResult>
Capture a thumbnail from the live HLS.
Parameters
- options: CaptureHlsOptions
Returns Promise<CaptureHlsResult>

delete

delete(id: string): Promise<string>
Delete a finished HLS recording.
Parameters
- id: string
Returns Promise<string>

get

get(roomId: string): Promise<HlsStream>
Fetch the room's currently-active HLS stream (with playback URLs). Throws (404) if none is active.
Parameters
- roomId: string
Returns Promise<HlsStream>

getById

getById(id: string): Promise<HlsStream>
Fetch an HLS stream by its id (as opposed to HlsResource.get by room).
Parameters
- id: string
Returns Promise<HlsStream>

list

list(params?: ListHlsParams): Promise<Page<HlsStream>>
List HLS streams (paginated, async-iterable).
Parameters
- params: ListHlsParams = {}
Returns Promise<Page<HlsStream>>

start

start(roomId: string, options?: StartHlsInput): Promise<EgressHandle>
Start HLS for a room. Returns an EgressHandle (raw = the created HLS stream).
Parameters
- roomId: string
- options: StartHlsInput = {}
Returns Promise<EgressHandle>

stop

stop(target: string | EgressHandle): Promise<string>
Stop HLS. Pass a bare roomId or the start EgressHandle.
Parameters
- target: string | EgressHandle
Returns Promise<string>