Skip to main content

Type Aliases

BroadcastStatus​

State of a broadcast managed by useBroadcast.

type BroadcastStatus = idle | starting | live | error | stopped
unknown | unknown | unknown | unknown | unknown

CallStatus​

Connection state of a call managed by useCreateCall / useJoinCall.

type CallStatus = idle | connecting | connected | error | disposed
unknown | unknown | unknown | unknown | unknown

EchoPillarboxStyles​

Style overrides applied by the echo-pillarbox component. blurredVideo is placed behind the main video to create the pillarbox blur effect; mainVideo styles the foreground element that holds the actual playback.

type EchoPillarboxStyles = {
blurredVideo: React.CSSProperties;
mainVideo: React.CSSProperties;
}

PlayerEventsMap​

Mapping from a subset of types.PlayerCompatEvents keys to listener functions whose arguments are inferred from the event payload.

type PlayerEventsMap<T extends typeOperator> = mapped
unknown

StartScreenshareCallback​

Callback invoked once a screenshare's media-stream controller and player are both ready. May be synchronous or async; throwing causes the hook to reset its state and bubble the error.

type StartScreenshareCallback = object | object
unknown | unknown