EntitiesInterfaces

ScreenShareOptions

View as MarkdownOpen in Claude

Options for starting a screen share. Passed to startScreenShare.

Properties

audio
booleanDefaults to false

Request the shared surface’s audio. Whether audio can actually be captured depends on the browser, the OS, and the surface the user picks — Chrome offers it for tabs and windows, and a share the user grants without audio yields a video-only stream. This is the surface’s audio, not the microphone: the share never carries the local mic.

Examples

await call.self.startScreenShare({ audio: true });