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
      • 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$
  • 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
  • Returns
  • Throws
  • See
EntitiesWebRTCCall

toggleIncomingVideo

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

toggleLock

Next
Built with
1toggleIncomingVideo(): Promise<void>

Toggles whether the local peer receives incoming video from the call. When disabled, the remote video stream is discarded; the local participant continues to send video (if not muted).

Not yet implemented in v4. This method is on the API surface and will throw when called.

Returns

Promise<void> — once implemented, resolves after the server has acknowledged the state change.

Throws

Throws unconditionally — implementation pending.

See

  • toggleIncomingAudio — the parallel audio toggle.