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
      • 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
    • 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
  • Examples
EntitiesClientPreferences

autoMuteVideoOnHidden

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

checkConnectionOnVisible

Next
Built with
1get autoMuteVideoOnHidden(): boolean
2set autoMuteVideoOnHidden(value: boolean)

Whether to auto-mute video when the tab becomes hidden.

Parameters

value
booleanRequired

If true, auto-mutes video when the tab or window becomes hidden.

Examples

1// Read
2console.log(client.preferences.autoMuteVideoOnHidden);
3
4// Write
5client.preferences.autoMuteVideoOnHidden = true;