macOS SDK API Reference
Loading...
Searching...
No Matches
ZoomSDKShareScreenSetting Class Reference

#import <ZoomSDKSettingService.h>

Inherits NSObject.

Instance Methods

(BOOL) - isDoNotDisturbInSharingOn
 Determine if it is able to silence system notifications when sharing desktop.
 
(ZoomSDKError- enableDoNotDisturbInSharing:
 Enable or disable silence system notifications when sharing desktop.
 
(BOOL) - isGreenBorderOn
 Determine if it is able to show green border when sharing.
 
(ZoomSDKError- enableGreenBorder:
 Enable or disable show green border when sharing.
 
(BOOL) - isShareSelectedWndOnlyOn
 Determine if it is able to share selected app window only.
 
(ZoomSDKError- enableShareSelectedWndOnly:
 Enable or disable share selected app window only.
 
(BOOL) - isTCPConnectionOn
 Determine if it is able to using tcp connection for screen sharing.
 
(ZoomSDKError- enableTCPConnecton:
 Enable or disable use tcp connection for screen sharing.
 
(ZoomSDKError- setScreenCaptureMode:
 Set screen capture mode.
 
(ZoomSDKScreenCaptureMode- getScreenCaptureMode
 Get screen capture mode.
 
(ZoomSDKError- enableSetShareScreen:SettingCmd:
 Enable or disable meeting settings by command.
 
(BOOL) - isEnableToSettingShare:
 Get the setting item current status.
 
(int) - getLimitFPSValue
 get current FPS value.
 
(ZoomSDKError- setLimitedFPSValue:
 set the value of fps limit.
 
(BOOL) - isEnableToSetLimitFPS
 Enable to set limited fps.
 
(ZoomSDKError- setEnableLimitFPS:
 Enable or disenable to set Limit fps value.
 
(BOOL) - isSupportShowZoomWindowWhenShare
 Determine if support show zoom meeting window when share.
 
(ZoomSDKError- setShowZoomWindowWhenShare:
 Set enable show zoom meeting window when share.
 
(BOOL) - isShowZoomWindowWhenShare
 Determine if show zoom meeting window when share.
 
(BOOL) - isShareDesktopEnabled
 Determine if enable share desktop.
 
(ZoomSDKError- setShareOptionWhenShareApplication:
 Set the share option when share appliaction.
 
(ZoomSDKSettingShareScreenShareOption- getShareOptionWhenShareApplication
 Get the option of share application.
 
(ZoomSDKError- setShareOptionwWhenShareInMeeting:
 Set the share option when share in meeting.
 
(ZoomSDKSettingShareScreenShareOption- getShareOptionwWhenShareInMeeting
 Get the option of share in meeting.
 
(ZoomSDKError- setShareOptionwWhenShareInDirectShare:
 Set the share option when share in direct share.
 
(ZoomSDKSettingShareScreenShareOption- getShareOptionwWhenShareInDirectShare
 Get the option of share in direct share.
 
(ZoomSDKError- enableHardwareAcceleratedVideoSharing:
 Enable/Disable the GPU acceleration when a user shares video.
 
(BOOL) - isVideoSharingHardwareAccelerated
 Determine if GPU acceleration is enabled when a user shares video.
 

Detailed Description

Definition at line 1462 of file ZoomSDKSettingService.h.

Method Documentation

◆ enableDoNotDisturbInSharing:

- (ZoomSDKError) enableDoNotDisturbInSharing: (BOOL)  enable

Enable or disable silence system notifications when sharing desktop.

Parameters
enableYES means enabled, NO disabled.
Returns
If the function succeeds, it will return ZoomSDKError_success, otherwise not.

◆ enableGreenBorder:

- (ZoomSDKError) enableGreenBorder: (BOOL)  enable

Enable or disable show green border when sharing.

Parameters
enableYES means enabled, NO disabled.
Returns
If the function succeeds, it will return ZoomSDKError_success, otherwise not.

◆ enableHardwareAcceleratedVideoSharing:

- (ZoomSDKError) enableHardwareAcceleratedVideoSharing: (BOOL)  bEnable

Enable/Disable the GPU acceleration when a user shares video.

Parameters
bEnableYES indicates to enable the acceleration. NO indicates to not enable acceleration.
Returns
If the function is success will return ZoomSDKError_Success, othereise fail.

◆ enableSetShareScreen:SettingCmd:

- (ZoomSDKError) enableSetShareScreen: (BOOL)  enable
SettingCmd: (shareSettingCmd shareCmd 

Enable or disable meeting settings by command.

Parameters
enableYES means to enable, otherwise not.
shareCmdis a enumeration to set different share screen.
Returns
If the function is success will return ZoomSDKError_Success,othereise fail.

◆ enableShareSelectedWndOnly:

- (ZoomSDKError) enableShareSelectedWndOnly: (BOOL)  enable

Enable or disable share selected app window only.

Parameters
enableYES means enabled, NO disabled.
Returns
If the function succeeds, it will return ZoomSDKError_success, otherwise not.

◆ enableTCPConnecton:

- (ZoomSDKError) enableTCPConnecton: (BOOL)  enable

Enable or disable use tcp connection for screen sharing.

Parameters
enableYES means enabled, NO disabled.
Returns
If the function succeeds, it will return ZoomSDKError_success, otherwise not.

◆ getLimitFPSValue

- (int) getLimitFPSValue

get current FPS value.

Returns
the fps value.

◆ getScreenCaptureMode

- (ZoomSDKScreenCaptureMode) getScreenCaptureMode

Get screen capture mode.

Returns
If the function succeeds will return the current screen capture mode.

◆ getShareOptionWhenShareApplication

- (ZoomSDKSettingShareScreenShareOption) getShareOptionWhenShareApplication

Get the option of share application.

Returns
The value is a enumeration of share option.

◆ getShareOptionwWhenShareInDirectShare

- (ZoomSDKSettingShareScreenShareOption) getShareOptionwWhenShareInDirectShare

Get the option of share in direct share.

Returns
The value is a enumeration of share option.

◆ getShareOptionwWhenShareInMeeting

- (ZoomSDKSettingShareScreenShareOption) getShareOptionwWhenShareInMeeting

Get the option of share in meeting.

Returns
The value is a enumeration of share option.

◆ isDoNotDisturbInSharingOn

- (BOOL) isDoNotDisturbInSharingOn

Determine if it is able to silence system notifications when sharing desktop.

Returns
YES means enabled, otherwise not.

◆ isEnableToSetLimitFPS

- (BOOL) isEnableToSetLimitFPS

Enable to set limited fps.

Returns
Return YES is enable otherwise is not.

◆ isEnableToSettingShare:

- (BOOL) isEnableToSettingShare: (shareSettingCmd sharingCmd

Get the setting item current status.

Parameters
sharingCmdis a enumeration.
Returns
If return YES is enable otherwise is not enable.

◆ isGreenBorderOn

- (BOOL) isGreenBorderOn

Determine if it is able to show green border when sharing.

Returns
YES means enabled, otherwise not.

◆ isShareDesktopEnabled

- (BOOL) isShareDesktopEnabled

Determine if enable share desktop.

Returns
YES means enable,otherwise not.

◆ isShareSelectedWndOnlyOn

- (BOOL) isShareSelectedWndOnlyOn

Determine if it is able to share selected app window only.

Returns
YES means enabled, otherwise not.

◆ isShowZoomWindowWhenShare

- (BOOL) isShowZoomWindowWhenShare

Determine if show zoom meeting window when share.

Returns
YES means show,otherwise not.

◆ isSupportShowZoomWindowWhenShare

- (BOOL) isSupportShowZoomWindowWhenShare

Determine if support show zoom meeting window when share.

Returns
YES means support,otherwise not.

◆ isTCPConnectionOn

- (BOOL) isTCPConnectionOn

Determine if it is able to using tcp connection for screen sharing.

Returns
YES means disabled, otherwise not.

◆ isVideoSharingHardwareAccelerated

- (BOOL) isVideoSharingHardwareAccelerated

Determine if GPU acceleration is enabled when a user shares video.

Returns
YES indicates the GPU acceleration is enabled.NO indicates the GPU acceleration is not.

◆ setEnableLimitFPS:

- (ZoomSDKError) setEnableLimitFPS: (BOOL)  enable

Enable or disenable to set Limit fps value.

Parameters
enableYes means to set otherwise is not.

◆ setLimitedFPSValue:

- (ZoomSDKError) setLimitedFPSValue: (ZoomSDKFPSValue value

set the value of fps limit.

Parameters
valueis a number of user to set.

◆ setScreenCaptureMode:

- (ZoomSDKError) setScreenCaptureMode: (ZoomSDKScreenCaptureMode mode

Set screen capture mode.

Parameters
modeThe mode to be set.
Returns
If the function succeeds, it will return ZoomSDKError_success, otherwise not.

◆ setShareOptionWhenShareApplication:

- (ZoomSDKError) setShareOptionWhenShareApplication: (ZoomSDKSettingShareScreenShareOption shareOption

Set the share option when share appliaction.

Parameters
shareOptionIt is a enumeration of share option.
Returns
If the function is success will return ZoomSDKError_Success, othereise fail.

◆ setShareOptionwWhenShareInDirectShare:

- (ZoomSDKError) setShareOptionwWhenShareInDirectShare: (ZoomSDKSettingShareScreenShareOption shareOption

Set the share option when share in direct share.

Parameters
shareOptionIt is a enumeration of share option.
Returns
If the function is success will return ZoomSDKError_Success, othereise fail.

◆ setShareOptionwWhenShareInMeeting:

- (ZoomSDKError) setShareOptionwWhenShareInMeeting: (ZoomSDKSettingShareScreenShareOption shareOption

Set the share option when share in meeting.

Parameters
shareOptionIt is a enumeration of share option.
Returns
If the function is success will return ZoomSDKError_Success, othereise fail.

◆ setShowZoomWindowWhenShare:

- (ZoomSDKError) setShowZoomWindowWhenShare: (BOOL)  show

Set enable show zoom meeting window when share.

Parameters
showYES means show,otherwise not.
Returns
If the function is success will return ZoomSDKError_Success, othereise fail.