Optional
displaySince
4.17.1
The pre-selected pane in the media picker. See displaySurface for details.
Note: This property is supported on Chrome 107 and later, as well as Edge 107 and later.
Optional
electronThe sourceId
when you share the screen through Electron.
Optional
encoderThe video encoder configurations for screen sharing.
You can set the video encoder configurations in either of the following ways:
"1080p_2"
(resolution: 1920 × 1080, frame rate: 30 fps, bitrate: 3000 Kbps).Optional
extensionThe extensionId
when you share the screen with a Chrome extension.
Optional
optimizationSince
4.0.0
Transmission optimization mode. Whether to prioritize video quality or smoothness:
"detail"
: (Default) Prioritizes video quality."motion"
: Prioritizes video smoothness.Note: This method is only supported on Chrome.
Optional
screenDEPRECATED from v4.17.1. Use displaySurface instead.
The type of the source for screen sharing.
Optional
selfSince
4.17.1
Whether to allow the user to share the current tab:
"include"
: (Default) Allows the user to share the current tab."exclude"
: Prevents the user from sharing the current tab.See displaySurface for details.
Note:
- This property is defaulted to
"exclude"
on Chrome 107. For better compatibility with earlier versions, the SDK changes the default value to "include", which ensures that users can still share the current tab after upgrading to Chrome 107.- This property is supported on Chrome 107 and later, as well as Edge 107 and later.
Optional
surfaceSince
4.17.1
Whether to allow the user to dynamically switch between shared tabs:
"include"
: (Default) The user can dynamically switch between shared tabs."exclude"
: The user cannot dynamically switch between shared tabs.See surfaceSwitching for details.
Note: This property is supported on Chrome 107 and later, as well as Edge 107 and later.
Optional
systemSince
4.17.1
Whether to capture system audio:
"include"
: (Default) Captures system audio."exclude"
: Avoids capturing system audioSee systemAudio for details.
Note: This property is supported on Chrome 105 and later (Windows only), as well as Edge 105 and later (Windows only).
Configurations for the video track for screen sharing. Set these configurations when calling [AgoraRTC.createScreenVideoTrack]createScreenVideoTrack.