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
  • Extends
  • Properties
EntitiesInterfaces

CallOptions

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

CallParticipant

Next
Built with

Configuration options for creating a call.

Extends

  • MediaOptions

Properties

callId
string

Pre-assigned call ID (used for reattach).

displayDirection
string

Direction hint for display purposes.

from
string

Address URI of the caller.

fromName
string

Display name of the caller.

initOffer
string

SDP offer for inbound calls.

nodeId
string

Optional. Hint to the cluster about which node should host this call. Used by reattach to pin to the original node; on fresh dials acts as a steering preference (the server may ignore for placement reasons). Leave undefined for normal load-balanced placement.

preferredAudioCodecs
string[]

Preferred audio codecs for this call (overrides global preferences).

preferredVideoCodecs
string[]

Preferred video codecs for this call (overrides global preferences).

reattach
boolean

Whether this call is being reattached after reconnect.

stereo
boolean

Enable stereo Opus for this call (overrides global preferences).

to
string

Destination URI.

toName
string

Display name of the callee.

userVariables
Record<string, unknown>

Custom user variables sent with the call invite.

Inherited from MediaOptions
audio
boolean

Enable audio input. Defaults to true when not specified.

inputAudioDeviceConstraints
MediaTrackConstraints

Custom constraints for the audio input track. See MediaTrackConstraints.

inputAudioStream
MediaStream

Pre-existing audio stream to use instead of getUserMedia. See MediaStream.

inputVideoDeviceConstraints
MediaTrackConstraints

Custom constraints for the video input track. See MediaTrackConstraints.

inputVideoStream
MediaStream

Pre-existing video stream to use instead of getUserMedia. See MediaStream.

receiveAudio
boolean

Whether to receive remote audio.

receiveVideo
boolean

Whether to receive remote video.

video
boolean

Enable video input. Defaults to false when not specified.