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
ReferenceGuidesClick-to-Call
ReferenceGuidesClick-to-Call
  • Core
    • Overview
  • SignalWire Client
    • Overview
    • Notifications
    • Client
      • Address Namespace
      • Chat Namespace
      • Conversation Namespace
        • connect
        • dial
        • disconnect
        • getSubscriberInfo
        • offline
        • online
        • updateToken
    • Utility functions
  • Video
    • Overview
    • LocalOverlay
    • RoomSession
    • RoomSessionDevice
    • RoomSessionPlayback
    • RoomSessionRecording
    • RoomSessionScreenShare
    • RoomSessionStream
    • RoomDevice
    • RoomScreenShare
  • Chat
    • Overview
    • Client
    • ChatMember
    • ChatMemberEntity
    • ChatMessage
    • ChatMessageEntity
  • PubSub
    • Overview
    • Client
    • PubSubMessage
  • WebRTC
    • Overview
  • Overview
  • Overview
  • Notifications
  • Client
  • Address Namespace
  • Chat Namespace
  • Conversation Namespace
  • connect
  • dial
  • disconnect
  • getSubscriberInfo
  • offline
  • online
  • updateToken
  • Utility functions
  • Overview
  • LocalOverlay
  • RoomSession
  • Events
  • addCamera
  • addDevice
  • addMicrophone
  • audioMute
  • audioUnmute
  • createScreenShareObject
  • deaf
  • deleteMemberMeta
  • deleteMeta
  • demote
  • destroy
  • getLayouts
  • getMemberMeta
  • getMembers
  • getMeta
  • getPlaybacks
  • getRecordings
  • getStreams
  • hangupAll
  • hideVideoMuted
  • join
  • leave
  • lock
  • off
  • on
  • once
  • play
  • promote
  • removeAllListeners
  • removeAllMembers
  • removeMember
  • sendDigits
  • setHideVideoMuted
  • setInputSensitivity
  • setInputVolume
  • setLayout
  • setLocalStream
  • setMemberMeta
  • setMemberPosition
  • setMeta
  • setOutputVolume
  • setPositions
  • setPrioritizeHandraise
  • setRaisedHand
  • showVideoMuted
  • startRecording
  • startScreenShare
  • startStream
  • undeaf
  • unlock
  • updateCamera
  • updateMemberMeta
  • updateMeta
  • updateMicrophone
  • updateSpeaker
  • videoMute
  • videoUnmute
  • RoomSessionDevice
  • audioMute
  • audioUnmute
  • join
  • leave
  • setInputSensitivity
  • setInputVolume
  • setMicrophoneVolume
  • updateCamera
  • updateMicrophone
  • videoMute
  • videoUnmute
  • RoomSessionPlayback
  • RoomSessionRecording
  • RoomSessionScreenShare
  • audioMute
  • audioUnmute
  • join
  • leave
  • setInputSensitivity
  • setInputVolume
  • setMicrophoneVolume
  • updateCamera
  • updateMicrophone
  • videoMute
  • videoUnmute
  • RoomSessionStream
  • RoomDevice
  • RoomScreenShare
  • Overview
  • Client
  • Events
  • disconnect
  • getAllowedChannels
  • getMembers
  • getMemberState
  • getMessages
  • off
  • on
  • once
  • publish
  • removeAllListeners
  • setMemberState
  • subscribe
  • unsubscribe
  • updateToken
  • ChatMember
  • ChatMemberEntity
  • ChatMessage
  • ChatMessageEntity
  • Overview
  • Client
  • Events
  • disconnect
  • getAllowedChannels
  • off
  • on
  • once
  • publish
  • removeAllListeners
  • subscribe
  • unsubscribe
  • updateToken
  • PubSubMessage
  • Overview
  • checkCameraPermissions
  • checkMicrophonePermissions
  • checkPermissions
  • checkSpeakerPermissions
  • createCameraDeviceWatcher
  • createDeviceWatcher
  • createMicrophoneAnalyzer
  • createMicrophoneDeviceWatcher
  • createSpeakerDeviceWatcher
  • enumerateDevices
  • getCameraDevices
  • getCameraDevicesWithPermissions
  • getDevices
  • getDevicesWithPermissions
  • getDisplayMedia
  • getMicrophoneDevices
  • getMicrophoneDevicesWithPermissions
  • getSpeakerDevices
  • getSpeakerDevicesWithPermissions
  • getSupportedConstraints
  • getUserMedia
  • requestPermissions
  • setMediaElementSinkId
  • stopStream
  • stopTrack
  • supportsGetDisplayMedia
  • supportsGetUserMedia
  • supportsMediaDevices
  • supportsMediaOutput
Log inSign up
Support
On this page
  • offline
SignalWire ClientClientMethods

offline

|View as Markdown|Open in Claude|

offline

  • offline(): void

Set the client to be offline so it doesn’t receive call invites via WebRTC.

Returns

void

Was this page helpful?
Edit this page
Previous

online

Next
Built with