ScreenShareCaptureOptions
Options for ScreenShare.
Interface
audio
optional
true to capture audio shared. browser support for audio capturing in screenshare is limited: https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia#browser_compatibility (opens in a new tab)
true to capture audio shared. browser support for audio capturing in screenshare is limited: https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia#browser_compatibility (opens in a new tab)
controller
optional
a CaptureController object instance containing methods that can be used to further manipulate the capture session if included.
a CaptureController object instance containing methods that can be used to further manipulate the capture session if included.
Type
unknownresolution
optional
capture resolution, defaults to full HD
capture resolution, defaults to full HD
Type
VideoResolutionselfBrowserSurface
optional
specifies whether the browser should allow the user to select the current tab for capture
specifies whether the browser should allow the user to select the current tab for capture
Type
undefined | undefinedsuppressLocalAudioPlayback
optional
Experimental option to control whether the audio playing in a tab will continue to be played out of a user's local speakers when the tab is captured.
Experimental option to control whether the audio playing in a tab will continue to be played out of a user's local speakers when the tab is captured.
Type
booleansurfaceSwitching
optional
specifies whether the browser should display a control to allow the user to dynamically switch the shared tab during screen-sharing.
specifies whether the browser should display a control to allow the user to dynamically switch the shared tab during screen-sharing.
Type
undefined | undefinedsystemAudio
optional
specifies whether the browser should include the system audio among the possible audio sources offered to the user
specifies whether the browser should include the system audio among the possible audio sources offered to the user
Type
undefined | undefined