downloadLiveStreamChunk

Download a live stream chunk. User-only.

Parameters

id: string

The identifier of a video chat retrieved from getChat, startVideoChat, or scheduleVideoChat.

channelId: number

Stream channel ID.

scale: number

Stream channel scale.

timestamp: number

Millisecond timestamp of the chunk to download.

quality?: "low" | "medium" | "high"

Video quality.

signal?: AbortSignal

Download abort signal.

Result

AsyncGenerator<Uint8Array, void, unknown>

Syntax

// Required parameters only.
await client.downloadLiveStreamChunk(id, channelId, scale, timestamp);

// Required parameters + optional parameters.
// Any of the optional parameters can be omitted.
await client.downloadLiveStreamChunk(id, channelId, scale, timestamp, {
    quality,
    signal,
});