Skip to main content

Hook Options & Returns

UseBroadcastReturn​

Return shape of useBroadcast.

type UseBroadcastReturn = {
broadcast: BroadcastAPI | literal;
error: unknown;
start: object;
status: BroadcastStatus;
stop: object;
}

UseCallLifecycleOptions​

Options shared by the call-lifecycle hooks.

type UseCallLifecycleOptions = {
autoStart?: boolean;
keepAliveMs?: number;
key?: string;
}

UseCallReturn​

Return shape of useCreateCall / useJoinCall.

type UseCallReturn = {
call: CallAPI | literal;
dispose: object;
error: unknown;
start: object;
status: CallStatus;
}

UsePreviewPlayerOptions​

Options accepted by usePreviewPlayer.

type UsePreviewPlayerOptions = {
mcOptions?: MediaControllerOptions;
mscOptions?: MediaStreamControllerOptions;
previewPlayerOptions?: RequestPlayerOptions;
}

UsePreviewPlayerReturn​

Return shape of usePreviewPlayer. Both fields are null until the preview player has finished initialising; consumers should render a loading state while they are.

type UsePreviewPlayerReturn = {
mediaStreamController: MediaStreamControllerAPI | literal;
previewPlayer: PlayerAPI | literal;
}

UseRequestPlayerOptions​

Options accepted by useRequestPlayer. The source, requestPlayerOptions, and eventsMap are pinned at first render — the hook warns in development when any of them change after mount.

type UseRequestPlayerOptions = {
eventsMap?: Partial<PlayerEventsMap<typeOperator>>;
requestPlayerOptions?: RequestPlayerOptions;
source: string | MediaStream | SourceProvider;
}

UseScreensharePlayerOptions​

Options accepted by useScreensharePlayer.

type UseScreensharePlayerOptions = {
screensharePlayerOptions?: RequestPlayerOptions;
}

UseScreensharePlayerReturn​

Return shape of useScreensharePlayer. Exposes the live controller and player (both null until a screenshare is active), the start/stop actions, and the most recent error encountered by either action.

type UseScreensharePlayerReturn = {
error: unknown;
mediaStreamController: MediaStreamControllerAPI | literal;
screensharePlayer: PlayerAPI | literal;
startScreenshare: object;
stopScreenshare: object;
}