Video SDK for Windows API Reference
Loading...
Searching...
No Matches
IZoomVideoSDKShareSettingHelper Class Referenceabstract

Helper interface for configuring screen sharing settings. More...

#include <zoom_video_sdk_share_setting_interface.h>

Public Member Functions

virtual ZoomVideoSDKErrors setScreenCaptureMode (ZoomVideoSDKScreenCaptureMode captureMode)=0
 Set screen capture mode.
 
virtual ZoomVideoSDKErrors getScreenCaptureMode (ZoomVideoSDKScreenCaptureMode &captureMode)=0
 Get the screen capture mode.
 
virtual ZoomVideoSDKErrors enableGreenBorder (bool bEnable)=0
 Set the visibility of the green border when sharing the screen.
 
virtual bool isGreenBorderEnabled ()=0
 Determines if the green border is enabled when user shares the screen.
 

Detailed Description

Helper interface for configuring screen sharing settings.

Definition at line 36 of file zoom_video_sdk_share_setting_interface.h.

Member Function Documentation

◆ enableGreenBorder()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareSettingHelper::enableGreenBorder ( bool bEnable)
pure virtual

Set the visibility of the green border when sharing the screen.

Parameters
bEnabletrue indicates to display the green border. Otherwise, false.
Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ getScreenCaptureMode()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareSettingHelper::getScreenCaptureMode ( ZoomVideoSDKScreenCaptureMode & captureMode)
pure virtual

Get the screen capture mode.

Parameters
[out]captureModeThe screen capture mode.
Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ isGreenBorderEnabled()

virtual bool IZoomVideoSDKShareSettingHelper::isGreenBorderEnabled ( )
pure virtual

Determines if the green border is enabled when user shares the screen.

Returns
true if the green border is enabled. Otherwise, false.

◆ setScreenCaptureMode()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareSettingHelper::setScreenCaptureMode ( ZoomVideoSDKScreenCaptureMode captureMode)
pure virtual

Set screen capture mode.

Parameters
captureModeThe mode to be set.
Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.