atmoky Engage Server SDK is now available! Check out the documentation to learn more.
API Reference
Interfaces
ScreenShareCaptureOptions

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)
Type
boolean | AudioCaptureOptions

controller

optional
a CaptureController object instance containing methods that can be used to further manipulate the capture session if included.
Type
unknown

resolution

optional
capture resolution, defaults to full HD

selfBrowserSurface

optional
specifies whether the browser should allow the user to select the current tab for capture
Type
undefined | undefined

suppressLocalAudioPlayback

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.
Type
boolean

surfaceSwitching

optional
specifies whether the browser should display a control to allow the user to dynamically switch the shared tab during screen-sharing.
Type
undefined | undefined

systemAudio

optional
specifies whether the browser should include the system audio among the possible audio sources offered to the user
Type
undefined | undefined

atmoky Logo

© 2024 atmoky, GmbH.
All rights reserved.

We use cookies to measure and improve your browsing experience, and serve personalized ads or content.