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
      • 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
    • 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
  • Returns
  • Examples
  • See
EntitiesSelfParticipant

startScreenShare

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

stopScreenShare

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

Starts sharing the local screen.

Returns

Promise<void>

Examples

1await selfParticipant.startScreenShare();

See

  • screenShareStatus$ — reactive state.
  • stopScreenShare — end the share.
  • Gated by SelfCapabilities.screenshare.