CallState

Observable state of a call (status, recording, participants, etc.).

Extended by

Call

Properties

id

stringRequired

Call ID this state snapshot describes.

locked

booleanRequired

Whether the call is locked.

locked$

Observable<boolean>Required

Observable of the call’s locked state.

meta$

Observable<Record<string, unknown>>Required

Observable of the call-level metadata bag.

participants

CallParticipant[]Required

Current participants on the call. See CallParticipant.

participants$

Observable<CallParticipant[]>Required

Observable of the current participant list. See CallParticipant.

raiseHandPriority

booleanRequired

Whether raise-hand priority mode is active.

raiseHandPriority$

Observable<boolean>Required

Observable of the raise-hand priority mode state.

recording

booleanRequired

Whether a server-side recording is active.

recording$

Observable<boolean>Required

Observable of the current recording state.

status

CallStatusRequired

Current lifecycle status of the call. See CallStatus.

status$

Observable<CallStatus>Required

Observable of the call’s lifecycle status. See CallStatus.

streaming

booleanRequired

Whether a server-side stream is active.

streaming$

Observable<boolean>Required

Observable of the current streaming state.

Methods

setMeta()

1 setMeta(meta): Promise<void>

Parameters

Returns

Promise<void>

updateMeta()

1 updateMeta(meta): Promise<void>

Parameters

Returns

Promise<void>