Type Alias StartStreamingParams

type StartStreamingParams = {
    emitData(data: Uint8Array): void;
    immediate?: boolean;
    onClientCount(count: number): void;
}

Index

Properties

Methods

emitData onClientCount

Properties

`Optional`immediate

immediate?: boolean

Whether immediate streaming is active or not. If immediate mode is not active, streaming will fall back to interval mode. Default value = true.

Methods

emitData

emitData(data: Uint8Array): void
Called when data is ready to be streamed. All streaming logic should be done inside this callback.
Parameters
- data: Uint8Array
  The data to be streamed.
Returns void
void.

onClientCount

onClientCount(count: number): void
Called when a new visitor starts watching the stream.
Parameters
- count: number
  The number of clients that are currently watching the stream.
Returns void
void.