Interface for configuring share screen settings. More...

#include <ZoomSDKSettingService.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isDoNotDisturbInSharingOn
	Determines if it is able to silence system notifications when sharing desktop.

(ZoomSDKError)	- enableDoNotDisturbInSharing:
	Enables or disable silence system notifications when sharing desktop.

(BOOL)	- isGreenBorderOn
	Determines if it is able to show green border when sharing.

(ZoomSDKError)	- enableGreenBorder:
	Enables or disable show green border when sharing.

(BOOL)	- isShareSelectedWndOnlyOn
	Determines if it is able to share selected app window only.

(ZoomSDKError)	- enableShareSelectedWndOnly:
	Enables or disable share selected app window only.

(BOOL)	- isTCPConnectionOn
	Determines if it is able to using tcp connection for screen sharing.

(ZoomSDKError)	- enableTCPConnection:
	Enables or disable use tcp connection for screen sharing.

(ZoomSDKError)	- setScreenCaptureMode:
	Sets screen capture mode.

(ZoomSDKScreenCaptureMode)	- getScreenCaptureMode
	Gets screen capture mode.

(ZoomSDKError)	- enableSetShareScreen:SettingCmd:
	Enables or disable meeting settings by command.

(BOOL)	- isEnableToSettingShare:
	Gets the setting item current status.

(int)	- getLimitFPSValue
	Get current FPS value.

(ZoomSDKError)	- setLimitedFPSValue:
	Set the value of fps limit.

(BOOL)	- isEnableToSetLimitFPS
	Enables to set limited fps.

(ZoomSDKError)	- setEnableLimitFPS:
	Enables or disenable to set Limit fps value.

(BOOL)	- isSupportShowZoomWindowWhenShare
	Determines if support show zoom meeting window when share.

(ZoomSDKError)	- setShowZoomWindowWhenShare:
	Sets enable show zoom meeting window when share.

(BOOL)	- isShowZoomWindowWhenShare
	Determines if show zoom meeting window when share.

(BOOL)	- isShareDesktopEnabled
	Determines if enable share desktop.

(ZoomSDKError)	- setShareOptionWhenShareApplication:
	Sets the share option when share appliaction.

(ZoomSDKSettingShareScreenShareOption)	- getShareOptionWhenShareApplication
	Gets the option of share application.

(ZoomSDKError)	- setShareOptionwWhenShareInMeeting:
	Sets the share option when share in meeting.

(ZoomSDKSettingShareScreenShareOption)	- getShareOptionwWhenShareInMeeting
	Gets the option of share in meeting.

(ZoomSDKError)	- setShareOptionwWhenShareInDirectShare:
	Sets the share option when share in direct share.

(ZoomSDKSettingShareScreenShareOption)	- getShareOptionwWhenShareInDirectShare
	Gets the option of share in direct share.

(ZoomSDKError)	- enableHardwareAcceleratedVideoSharing:
	Enable or Disable the GPU acceleration when a user shares video.

(BOOL)	- isVideoSharingHardwareAccelerated
	Determines if GPU acceleration is enabled when a user shares video.

(ZoomSDKError)	- enableZoomDocs:
	Enables or disable Zoom Docs features in custom UI. This is disabled by default.

(ZoomSDKError)	- enableShareContentFlashDetection:
	Enable or disable automatic dimming when sharing flashing content.

(BOOL)	- isShareContentFlashDetectionEnabled
	Determines if automatic dimming of video when sharing content flashes is enabled.

Detailed Description

Interface for configuring share screen settings.

Definition at line 1891 of file ZoomSDKSettingService.h.

Method Documentation

◆ enableDoNotDisturbInSharing:

- (ZoomSDKError) enableDoNotDisturbInSharing: (BOOL) enable

Enables or disable silence system notifications when sharing desktop.

Parameters

enable YES if enabled, NO if disabled.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ enableGreenBorder:

- (ZoomSDKError) enableGreenBorder: (BOOL) enable

Enables or disable show green border when sharing.

Parameters

enable YES if enabled, NO if disabled.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ enableHardwareAcceleratedVideoSharing:

- (ZoomSDKError) enableHardwareAcceleratedVideoSharing: (BOOL) bEnable

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

Parameters

bEnable YES indicates to enable the acceleration, NO indicates to not enable acceleration.

Returns: If the function is success returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ enableSetShareScreen:SettingCmd:

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

Enables or disable meeting settings by command.

Parameters

enable	YES to enable, NO otherwise.
shareCmd	Is a enumeration to set different share screen.

Returns: If the function is success returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ enableShareContentFlashDetection:

- (ZoomSDKError) enableShareContentFlashDetection: (BOOL) enable

Enable or disable automatic dimming when sharing flashing content.

Parameters

enable YES to enable automatic dimming, NO to disable it.

Returns: If the function is success returns ZoomSDKError_Success. Otherwise, this function returns an error.

Note: When enabled, the video automatically dimmed when the shared content contains flashing elements.

◆ enableShareSelectedWndOnly:

- (ZoomSDKError) enableShareSelectedWndOnly: (BOOL) enable

Enables or disable share selected app window only.

Parameters

enable YES if enabled, NO if disabled.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ enableTCPConnection:

- (ZoomSDKError) enableTCPConnection: (BOOL) enable

Enables or disable use tcp connection for screen sharing.

Parameters

enable YES if enabled, NO if disabled.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ enableZoomDocs:

- (ZoomSDKError) enableZoomDocs: (BOOL) enable

Enables or disable Zoom Docs features in custom UI. This is disabled by default.

Parameters

enable YES to enable the Zoom Docs feature, NO otherwise.

Returns: If the function succeeds, it returns the ZoomSDKError_Success. Otherwise, this function returns an error.

◆ getLimitFPSValue

- (int) getLimitFPSValue

Get current FPS value.

Returns: The fps value.

◆ getScreenCaptureMode

- (ZoomSDKScreenCaptureMode) getScreenCaptureMode

Gets screen capture mode.

Returns: The current screen capture mode.

◆ getShareOptionWhenShareApplication

- (ZoomSDKSettingShareScreenShareOption) getShareOptionWhenShareApplication

Gets the option of share application.

Returns: The value is a enumeration of share option.

◆ getShareOptionwWhenShareInDirectShare

- (ZoomSDKSettingShareScreenShareOption) getShareOptionwWhenShareInDirectShare

Gets the option of share in direct share.

Returns: The value is a enumeration of share option.

◆ getShareOptionwWhenShareInMeeting

- (ZoomSDKSettingShareScreenShareOption) getShareOptionwWhenShareInMeeting

Gets the option of share in meeting.

Returns: The value is a enumeration of share option.

◆ isDoNotDisturbInSharingOn

- (BOOL) isDoNotDisturbInSharingOn

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

Returns: YES if enabled. Otherwise, NO.

◆ isEnableToSetLimitFPS

- (BOOL) isEnableToSetLimitFPS

Enables to set limited fps.

Returns: Return YES is enable. Otherwise, NO.

◆ isEnableToSettingShare:

- (BOOL) isEnableToSettingShare: (shareSettingCmd) sharingCmd

Gets the setting item current status.

Parameters

sharingCmd Is a enumeration.

Returns: If return YES is enable. Otherwise, NO.

◆ isGreenBorderOn

- (BOOL) isGreenBorderOn

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

Returns: YES if enabled. Otherwise, NO.

◆ isShareContentFlashDetectionEnabled

- (BOOL) isShareContentFlashDetectionEnabled

Determines if automatic dimming of video when sharing content flashes is enabled.

Returns: YES if the feature is enabled, NO otherwise.

◆ isShareDesktopEnabled

- (BOOL) isShareDesktopEnabled

Determines if enable share desktop.

Returns: YES to enable. Otherwise, NO.

◆ isShareSelectedWndOnlyOn

- (BOOL) isShareSelectedWndOnlyOn

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

Returns: YES if enabled. Otherwise, NO.

◆ isShowZoomWindowWhenShare

- (BOOL) isShowZoomWindowWhenShare

Determines if show zoom meeting window when share.

Returns: YES to show. Otherwise, NO.

◆ isSupportShowZoomWindowWhenShare

- (BOOL) isSupportShowZoomWindowWhenShare

Determines if support show zoom meeting window when share.

Returns: YES if support. Otherwise, NO.

◆ isTCPConnectionOn

- (BOOL) isTCPConnectionOn

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

Returns: YES if disabled. Otherwise, NO.

◆ isVideoSharingHardwareAccelerated

- (BOOL) isVideoSharingHardwareAccelerated

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

Returns: YES if the GPU acceleration is enabled. Otherwise, NO.

◆ setEnableLimitFPS:

- (ZoomSDKError) setEnableLimitFPS: (BOOL) enable

Enables or disenable to set Limit fps value.

Parameters

enable Yes means to set otherwise is not.

◆ setLimitedFPSValue:

- (ZoomSDKError) setLimitedFPSValue: (ZoomSDKFPSValue) value

Set the value of fps limit.

Parameters

value Is a number of user to set.

◆ setScreenCaptureMode:

- (ZoomSDKError) setScreenCaptureMode: (ZoomSDKScreenCaptureMode) mode

Sets screen capture mode.

Parameters

mode	The mode to be set.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ setShareOptionWhenShareApplication:

- (ZoomSDKError) setShareOptionWhenShareApplication: (ZoomSDKSettingShareScreenShareOption) shareOption

Sets the share option when share appliaction.

Parameters

shareOption It is a enumeration of share option.

Returns: If the function is success returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ setShareOptionwWhenShareInDirectShare:

- (ZoomSDKError) setShareOptionwWhenShareInDirectShare: (ZoomSDKSettingShareScreenShareOption) shareOption

Sets the share option when share in direct share.

Parameters

shareOption It is a enumeration of share option.

Returns: If the function is success returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ setShareOptionwWhenShareInMeeting:

- (ZoomSDKError) setShareOptionwWhenShareInMeeting: (ZoomSDKSettingShareScreenShareOption) shareOption

Sets the share option when share in meeting.

Parameters

shareOption It is a enumeration of share option.

Returns: If the function is success returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ setShowZoomWindowWhenShare:

- (ZoomSDKError) setShowZoomWindowWhenShare: (BOOL) show

Sets enable show zoom meeting window when share.

Parameters

show	YES to show, NO otherwise.

Returns: If the function is success returns ZoomSDKError_Success. Otherwise, this function returns an error.

Instance Methods

Detailed Description

Method Documentation

◆ enableDoNotDisturbInSharing:

◆ enableGreenBorder:

◆ enableHardwareAcceleratedVideoSharing:

◆ enableSetShareScreen:SettingCmd:

◆ enableShareContentFlashDetection:

◆ enableShareSelectedWndOnly:

◆ enableTCPConnection:

◆ enableZoomDocs:

◆ getLimitFPSValue

◆ getScreenCaptureMode

◆ getShareOptionWhenShareApplication

◆ getShareOptionwWhenShareInDirectShare

◆ getShareOptionwWhenShareInMeeting

◆ isDoNotDisturbInSharingOn

◆ isEnableToSetLimitFPS

◆ isEnableToSettingShare:

◆ isGreenBorderOn

◆ isShareContentFlashDetectionEnabled

◆ isShareDesktopEnabled

◆ isShareSelectedWndOnlyOn

◆ isShowZoomWindowWhenShare

◆ isSupportShowZoomWindowWhenShare

◆ isTCPConnectionOn

◆ isVideoSharingHardwareAccelerated

◆ setEnableLimitFPS:

◆ setLimitedFPSValue:

◆ setScreenCaptureMode:

◆ setShareOptionWhenShareApplication:

◆ setShareOptionwWhenShareInDirectShare:

◆ setShareOptionwWhenShareInMeeting:

◆ setShowZoomWindowWhenShare: