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

PreflightResult

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

RecoveryEvent

Next
Built with

Results of a preflight connectivity test.

Properties

bandwidth
{ downloadKbps: number; uploadKbps: number; } | null

Bandwidth estimation (null if skipMediaTest).

connectivity
objectRequired

ICE/TURN connectivity.

connectivity.rttMs
numberRequired

RTT to media server in ms.

connectivity.stunReachable
booleanRequired

Whether STUN servers are reachable.

connectivity.turnReachable
booleanRequired

Whether TURN servers are reachable.

connectivity.type
"failed" | "direct" | "relay"Required

‘direct’ = host/srflx worked, ‘relay’ = only TURN relay, ‘failed’ = nothing.

devices
objectRequired

Device test results.

devices.audioInput
objectRequired

Audio input portion of the preflight result.

devices.audioInput.device
MediaDeviceInfo | null

Audio input device used for the test, or null if none was available. See MediaDeviceInfo.

devices.audioInput.working
booleanRequired

Whether the audio input device produced a usable signal.

devices.audioOutput
objectRequired

Audio output portion of the preflight result.

devices.audioOutput.available
booleanRequired

Whether an audio output device was available for the test.

devices.audioOutput.device
MediaDeviceInfo | null

Audio output device used for the test, or null if none was available. See MediaDeviceInfo.

devices.videoInput
objectRequired

Video input portion of the preflight result.

devices.videoInput.device
MediaDeviceInfo | null

Video input device used for the test, or null if none was available. See MediaDeviceInfo.

devices.videoInput.working
booleanRequired

Whether the video input device produced a usable signal.

ok
booleanRequired

Overall pass/fail.

signaling
objectRequired

Signaling server reachability.

signaling.reachable
booleanRequired

Whether the signaling endpoint was reachable.

signaling.rttMs
numberRequired

Measured signaling round-trip time in milliseconds.

warnings
readonly string[]Required

Human-readable warnings.