For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
GuidesReferenceClick-to-Call
GuidesReferenceClick-to-Call
  • Core
    • Overview
  • Entities
    • SignalWire
    • Address
    • Participant
    • ClientPreferences
    • SelfCapabilities
    • SelfParticipant
    • User
    • WebRTCCall
      • AddressHistory<TAddress>
      • AudioConstraintsEvent
      • AuthenticateContext
      • Call
      • CallAddress
      • CallCapabilitiesState
      • CallDiagnosticSummary
      • CallError
      • CallNetworkIssue
      • CallNetworkMetrics
      • CallOptions
      • CallParticipant
      • CallSelfParticipant
      • CallState
      • ConstraintFallbackEvent
      • CredentialNoRefreshHandlerWarning
      • CredentialProvider
      • CredentialRefreshFallbackWarning
      • DebugOptions
      • DeviceController
      • DeviceRecoveryEvent
      • DiagnosticEvent
      • DialOptions
      • Directory
      • JSONRPCErrorResponse
      • JSONRPCRequest<TParams>
      • JSONRPCSuccessResponse<TResult>
      • LayoutLayer
      • MediaDirections
      • MediaOptions
      • MediaParamsEvent
      • MemberCapabilities
      • NodeSocketAdapter
      • OnOffCapability
      • PendingRPCOptions
      • PermissionResult
      • PlatformCapabilities
      • PreflightOptions
      • PreflightResult
      • RecoveryEvent
      • SATClaims
      • SDKCredential
      • SDKLogger
      • SelectDeviceOptions
      • SessionDiagnostics
      • SessionState
      • SignalWireOptions
      • Storage
      • StoredDevicePreference
      • TextMessage<TAddress>
      • TransferOptions
      • WebRTCApiProvider
      • WebRTCMediaDevices
  • Web Components
    • Overview
    • sw-audio-level
    • sw-call-controls
    • sw-call-dialpad
    • sw-call-media
    • sw-call-provider
    • sw-call-status
    • sw-call-widget
    • sw-click-to-call
    • sw-device-selector
    • sw-directory
    • sw-local-camera
    • sw-participant-controls
    • sw-participants
    • sw-self-media
    • sw-ui-alert
    • sw-ui-background
    • sw-ui-call-layout
    • sw-ui-content-drawer
    • sw-ui-control-bar
    • sw-ui-dialpad
    • sw-ui-dropup
    • sw-ui-icon
    • sw-ui-modal
    • sw-ui-responsive-container
    • sw-ui-split-button
    • sw-ui-transcript-view
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Extended by
  • Properties
  • Methods
  • setMeta()
  • updateMeta()
EntitiesInterfaces

CallState

|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Previous

ConstraintFallbackEvent

Next
Built with

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
Record<string, unknown>Required

Arbitrary metadata bag for the call 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()

1setMeta(meta): Promise<void>

Parameters

meta
Record<string, unknown>Required

Arbitrary metadata bag for the call state.

Returns

Promise<void>


updateMeta()

1updateMeta(meta): Promise<void>

Parameters

meta
Record<string, unknown>Required

Arbitrary metadata bag for the call state.

Returns

Promise<void>