Video SDK for MacOS API Reference
Loading...
Searching...
No Matches
ZMVideoSDKShareSettingHelper Class Reference

Helper class to manage share-related settings. More...

#include <ZMVideoSDKShareSettingHelper.h>

Inherits NSObject.

Instance Methods

(ZMVideoSDKErrors- setScreenCaptureMode:
 Sets screen capture mode.
 
(ZMVideoSDKErrors- getScreenCaptureMode:
 Gets the screen capture mode.
 
(ZMVideoSDKErrors- enableGreenBorder:
 Sets the green border's visibility when sharing the screen.
 
(BOOL) - isGreenBorderEnabled
 Determines if the green border is enabled when user shares the screen.
 

Detailed Description

Helper class to manage share-related settings.

Definition at line 16 of file ZMVideoSDKShareSettingHelper.h.

Method Documentation

◆ enableGreenBorder:

- (ZMVideoSDKErrors) enableGreenBorder: (BOOL) bEnable

Sets the green border's visibility when sharing the screen.

Parameters
bEnableYES to display the green border, NO to hide.
Returns
If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ getScreenCaptureMode:

- (ZMVideoSDKErrors) getScreenCaptureMode: (ZMVideoSDKScreenCaptureMode *) captureMode

Gets the screen capture mode.

Parameters
captureModeThe screen capture mode.
Returns
If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ isGreenBorderEnabled

- (BOOL) isGreenBorderEnabled

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

Returns
YES if the green border is enabled. Otherwise, NO.

◆ setScreenCaptureMode:

- (ZMVideoSDKErrors) setScreenCaptureMode: (ZMVideoSDKScreenCaptureMode) captureMode

Sets screen capture mode.

Parameters
captureModeThe mode to be set.
Returns
If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.