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
      • applySelectedAudioOutputDevice
      • audioInputDevices$
      • audioInputDisabled$
      • audioOutputDevices$
      • clearDeviceState
      • connect
      • destroy
      • destroyed$
      • deviceInfoToConstraints
      • deviceRecovered$
      • dial
      • directory$
      • disableAudioInput
      • disableDeviceMonitoring
      • disableVideoInput
      • disconnect
      • enableAudioInput
      • enableDeviceMonitoring
      • enableVideoInput
      • enumerateDevices
      • errors$
      • exportDiagnostics
      • getDeviceCapabilities
      • isConnected$
      • isRegistered$
      • isValidDevice
      • platformCapabilities
      • preflight
      • ready$
      • register
      • requestMediaPermissions
      • resetToDefaults
      • selectAudioInputDevice
      • selectAudioOutputDevice
      • selectedAudioInputDevice$
      • selectedAudioInputDeviceConstraints
      • selectedAudioOutputDevice$
      • selectedVideoInputDevice$
      • selectedVideoInputDeviceConstraints
      • selectVideoInputDevice
      • session
      • setStorageManager
      • unregister
      • user$
      • videoInputDevices$
      • videoInputDisabled$
      • warnings$
    • Address
    • Participant
    • ClientPreferences
    • SelfCapabilities
    • SelfParticipant
    • User
    • WebRTCCall
  • 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
  • Parameters
  • Returns
  • Examples
EntitiesSignalWire

preflight

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

ready$

Next
Built with
1preflight(destination, options?): Promise<PreflightResult>

Runs a multi-phase connectivity test against the given destination.

The test checks:

  1. Signaling — WebSocket connected, RTT measurement
  2. Devices — getUserMedia succeeds with selected (or specified) devices
  3. ICE/TURN — gathers ICE candidates to verify STUN/TURN reachability
  4. Media/bandwidth (unless skipMediaTest) — dials the destination, collects getStats() for duration seconds, computes bandwidth estimates

Parameters

destination
stringRequired

A destination to dial for the media test (e.g. '/private/network-test').

options
PreflightOptions

Preflight options (duration, skipMediaTest, device overrides). See PreflightOptions.

Returns

Promise<PreflightResult>

A PreflightResult describing connectivity health.

Examples

1const result = await client.preflight('/private/network-test', { duration: 5 });
2if (!result.ok) console.warn('Connectivity issues:', result.warnings);