For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
LogoLogoSignalWire Docs
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
  • Overview
  • 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
  • activity$
  • channels$
  • coverUrl$
  • createdAt
  • defaultChannel
  • destroy
  • destroyed$
  • displayName$
  • history
  • id
  • locked$
  • name
  • previewUrl$
  • resourceId$
  • sendText
  • textMessage
  • type$
  • Participant
  • addressId$
  • audioMuted$
  • autoGain$
  • deaf$
  • denoise$
  • destroy
  • destroyed$
  • echoCancellation$
  • end
  • handraised$
  • inputSensitivity$
  • inputVolume$
  • isAudience
  • isTalking$
  • lowbitrate$
  • meta$
  • mute
  • muteVideo
  • name$
  • nodeId$
  • noiseSuppression$
  • outputVolume$
  • position$
  • remove
  • setAudioInputSensitivity
  • setAudioInputVolume
  • setAudioOutputVolume
  • setMeta
  • setPosition
  • toggleAudioInputAutoGain
  • toggleDeaf
  • toggleEchoCancellation
  • toggleHandraise
  • toggleLowbitrate
  • toggleMute
  • toggleMuteVideo
  • toggleNoiseSuppression
  • type$
  • unmute
  • unmuteVideo
  • updateMeta
  • userId$
  • videoMuted$
  • visible$
  • ClientPreferences
  • autoMuteVideoOnHidden
  • checkConnectionOnVisible
  • connectionTimeout
  • defaultAudioConstraints
  • defaultVideoConstraints
  • degradationBitrateThreshold
  • degradationRecoveryThreshold
  • deviceDebounceTime
  • devicePollingInterval
  • disableUdpIceServers
  • enableAutoDegradation
  • enableNetworkChangeDetection
  • enableRelayFallback
  • enableSavePreferences
  • enableServerHangupInterception
  • iceCandidateTimeout
  • iceDisconnectedGracePeriod
  • iceGatheringTimeout
  • iceRestartTimeout
  • iceServers
  • inputAudioConstraints
  • inputVideoConstraints
  • keyframeBurstWindow
  • keyframeCooldown
  • keyframeMaxBurst
  • maxRecoveryAttempts
  • persistDeviceSelection
  • preferredAudioCodecs
  • preferredAudioInput
  • preferredAudioOutput
  • preferredVideoCodecs
  • preferredVideoInput
  • receiveAudio
  • receiveVideo
  • reconnectCallsTimeout
  • reconnectDelayMax
  • reconnectDelayMin
  • recoveryCooldown
  • recoveryDebounceTime
  • refreshDevicesOnVisible
  • reinviteDebounceTime
  • reinviteMaxAttempts
  • reinviteTimeout
  • relayHost
  • relayOnly
  • statsBaselineSamples
  • statsHistorySize
  • statsJitterSpikeMultiplier
  • statsNoPacketThreshold
  • statsPacketLossThreshold
  • statsPollingInterval
  • statsRttSpikeMultiplier
  • stereoAudio
  • syncDevicesToActiveCalls
  • userVariables
  • SelfCapabilities
  • destroy
  • destroyed$
  • device$
  • end$
  • lock$
  • member$
  • screenshare$
  • self$
  • sendDigit$
  • setLayout$
  • state$
  • vmutedHide$
  • SelfParticipant
  • addAdditionalDevice
  • addAudioInputDevice
  • addInputDevices
  • addressId$
  • addVideoInputDevice
  • audioMuted$
  • autoGain$
  • deaf$
  • denoise$
  • destroy
  • destroyed$
  • disableStudioAudio
  • echoCancellation$
  • enableStudioAudio
  • end
  • handraised$
  • inputSensitivity$
  • inputVolume$
  • isAudience
  • isTalking$
  • lowbitrate$
  • meta$
  • mute
  • muteVideo
  • name$
  • nodeId$
  • noiseSuppression$
  • outputVolume$
  • position$
  • remove
  • removeAdditionalDevice
  • screenShareStatus$
  • selectAudioInputDevice
  • selectAudioOutputDevice
  • selectVideoInputDevice
  • setAudioInputDeviceConstraints
  • setAudioInputSensitivity
  • setAudioInputVolume
  • setAudioOutputVolume
  • setInputDevicesConstraints
  • setMeta
  • setPosition
  • setVideoInputDeviceConstraints
  • startScreenShare
  • stopScreenShare
  • studioAudio$
  • toggleAudioInputAutoGain
  • toggleDeaf
  • toggleEchoCancellation
  • toggleHandraise
  • toggleLowbitrate
  • toggleMute
  • toggleMuteVideo
  • toggleNoiseSuppression
  • type$
  • unmute
  • unmuteVideo
  • updateMeta
  • userId$
  • videoMuted$
  • visible$
  • User
  • destroy
  • destroyed$
  • WebRTCCall
  • address$
  • answer
  • answered$
  • answerMediaOptions
  • bandwidthConstrained$
  • callEvent$
  • callStates$
  • callUpdated$
  • capabilities$
  • destroy
  • destroyed$
  • direction
  • disablePushToTalk
  • enablePushToTalk
  • errors$
  • execute
  • executeMethod
  • from
  • fromName
  • hangup
  • isNetworkHealthy$
  • layout$
  • layoutEvent$
  • layoutLayers$
  • layouts$
  • layoutUpdates$
  • localAudioLevel$
  • localMicrophoneGain$
  • localSpeaking$
  • localStream$
  • locked$
  • mediaDirections$
  • mediaParamsUpdated$
  • memberJoined$
  • memberLeft$
  • memberTalking$
  • memberUpdated$
  • meta$
  • networkIssues$
  • networkMetrics$
  • nodeId$
  • notifyModifyFailed
  • participants$
  • participantsId$
  • qualityLevel$
  • qualityScore$
  • raiseHandPriority$
  • recording$
  • recoveryEvent$
  • recoveryState$
  • reject
  • remoteAudioLevel$
  • remoteStream$
  • requestIceRestart
  • requestKeyframe
  • rtcPeerConnection
  • self$
  • selfId$
  • sendDigits
  • setAutoGainControl
  • setEchoCancellation
  • setLayout
  • setLocalMicrophoneGain
  • setMeta
  • setNoiseSuppression
  • setPushToTalkActive
  • signalingEvent$
  • startRecording
  • startStreaming
  • status$
  • streaming$
  • subscribe
  • toggleHold
  • toggleIncomingAudio
  • toggleIncomingVideo
  • toggleLock
  • toName
  • transfer
  • updateMeta
  • userVariables$
  • webrtcMessages$
  • embeddableCall
  • getLogger
  • isSelfParticipant
  • setDebugOptions
  • setLogger
  • setLogLevel
  • EmbedTokenCredentialProvider
  • authenticate
  • refresh
  • StaticCredentialProvider
  • authenticate
  • CallCreateError
  • CollectionFetchError
  • DeviceTokenError
  • DPoPInitError
  • InvalidCredentialsError
  • MediaTrackError
  • MessageParseError
  • OverconstrainedFallbackError
  • PreflightError
  • RecoveryError
  • TokenRefreshError
  • UnexpectedError
  • VertoPongError
  • 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
  • CallDirection
  • CallErrorKind
  • CallStatus
  • Capability
  • CredentialRefreshFallbackReason
  • ExecuteMethod
  • JSONRPCResponse<TResult>
  • LogLevel
  • MediaDirection
  • QualityLevel
  • RecoveryState
  • ResilienceCallStatus
  • ScreenShareStatus
  • SDKWarning
  • UserPresence
  • VideoPosition
  • WebSocketAdapter
  • 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
Log inSign up
Support
On this page
  • Properties
EntitiesInterfaces

MediaParamsEvent

|View as Markdown|Open in Claude|

Event emitted when server-pushed media params are applied.

Properties

audio
MediaTrackConstraints

Audio constraints pushed by the server, if any. See MediaTrackConstraints.

timestamp
numberRequired

Timestamp when the event occurred (epoch ms).

video
MediaTrackConstraints

Video constraints pushed by the server, if any. See MediaTrackConstraints.

Was this page helpful?
Edit this page
Previous

MemberCapabilities

Next
Built with