SignalWire DocsPublic interface for an active WebRTC call.
Provides access to media streams, participants, layout, signaling events, and control actions (hangup, mute, transfer, etc.).
Address associated with the remote party of the call. See CallAddress.
Observable of the address associated with this call. See CallAddress.
Observable that emits true while the call is bandwidth-constrained.
Set of capabilities currently granted to the local participant on this call. See Capability.
Observable of the local participant’s current capability set on this call. See Capability.
Whether this call is inbound or outbound. See CallDirection.
Observable stream of errors raised on this call. See CallError.
URI of the calling party.
Display name of the calling party.
Whether the connection currently meets quality thresholds.
Observable of the call’s current network-health state.
Name of the currently active video layout.
Observable of the currently active layout name.
Position and state of each layer in the active layout. See LayoutLayer.
Observable of the active layout’s layer positions. See LayoutLayer.
List of layout names available on this call.
Observable of the list of available layout names.
Sync getter — returns null before the stream is created. See MediaStream.
Observable that emits only non-null MediaStreams (waits until the stream exists). See MediaStream.
Send/receive direction for each media track. See MediaDirections.
Observable of the per-track media direction state. See MediaDirections.
Observable that emits when media parameters are renegotiated. See MediaParamsEvent.
Recent network issues detected during the call. See CallNetworkIssue.
Observable stream of detected network issues. See CallNetworkIssue.
Recent network-metric samples for the call. See CallNetworkMetrics.
Observable of periodic network-metric samples. See CallNetworkMetrics.
Observable of the categorical call-quality level. See QualityLevel.
Observable of the numeric call-quality score (0–5).
Observable stream of call-recovery events. See RecoveryEvent.
Observable of the current recovery state. See RecoveryState.
Remote MediaStream for the call, or null if not yet available. See MediaStream.
Observable that emits only non-null MediaStreams (waits until the stream exists). See MediaStream.
Underlying RTCPeerConnection, or undefined if not yet established.
Local participant on the call, or null before join. See CallSelfParticipant.
Observable of the local participant, or null before join. See CallSelfParticipant.
Observable stream of raw signaling events.
URI of the called party.
Display name of the called party.
Map of arbitrary user-defined variables associated with the call.
Observable of the call’s user-variables bag.
Unique identifier for this call.
Whether the call is locked to new participants.
Observable of the call’s locked state.
Arbitrary metadata bag associated with the call or member.
Observable of the call-level metadata bag.
Current set of participants in the call. See CallParticipant.
Observable of the current participant list. See CallParticipant.
Whether raise-hand priority mode is active.
Observable of the raise-hand priority mode state.
Whether a server-side recording is currently in progress.
Observable of the current recording state.
Lifecycle status of the call. See CallStatus.
Observable of the call’s lifecycle status. See CallStatus.
Whether a server-side stream is currently active.
Observable of the current streaming state.
Per-call options for this operation (media constraints, RPC timeouts, or transfer target depending on context). See MediaOptions.
void
Outgoing JSON-RPC request to send. See JSONRPCRequest.
Per-call options for this operation (media constraints, RPC timeouts, or transfer target depending on context). See PendingRPCOptions.
Promise<T>
Target identifier (member ID or destination URI) for the operation.
RPC method name to execute on the server.
Method-specific arguments to pass with the RPC.
Promise<T>
Promise<void>
void
Promise<void>
void
DTMF digit string to send.
Promise<void>
Name of the currently active video layout.
Map of member IDs to layout positions. See VideoPosition.
Promise<void>
Arbitrary metadata bag associated with the call or member.
Promise<void>
Promise<void>
Promise<void>
Name of the event to subscribe to.
Observable<Record<string, unknown>>
Promise<void>
Promise<void>
Promise<void>
Promise<void>
Per-call options for this operation (media constraints, RPC timeouts, or transfer target depending on context). See TransferOptions.
Promise<void>
Arbitrary metadata bag associated with the call or member.
Promise<void>