Share setting interface. More...

#include <setting_service_interface.h>

Public Member Functions
virtual SDKError	EnableAutoFitToWindowWhenViewSharing (bool bEnable)=0
	Enables or disable to auto-fit the ZOOM window when viewing the shared content.

virtual bool	IsAutoFitToWindowWhenViewSharingEnabled ()=0
	Determines if it is able to auto-fit the ZOOM window when viewing the shared content.

virtual SDKError	EnableTCPConnectionWhenSharing (bool bEnable)=0
	Enables or disable TCP connecting when sharing.

virtual bool	IsTCPConnectionWhenSharing ()=0
	Determines if it is enable use TCP connection when sharing.

virtual bool	IsCurrentOSSupportAccelerateGPUWhenShare ()=0
	Determines if the operating system supports the GPU acceleration when user shares.

virtual SDKError	EnableAccelerateGPUWhenShare (bool bEnable)=0
	Enable/Disable the GPU acceleration when user shares.

virtual SDKError	IsAccelerateGPUWhenShareEnabled (bool &bEnable)=0
	Determines if GPU acceleration is enabled when user shares.

virtual SDKError	EnableGreenBorderWhenShare (bool bEnable)=0
	Sets the visibility of the green border when sharing the application.

virtual bool	IsGreenBorderEnabledWhenShare ()=0
	Determines if the green border is enabled when user shares.

virtual bool	IsLimitFPSEnabledWhenShare ()=0
	Determines if the 'limited sharing fps' feature is enabled when user shares.

virtual SDKError	EnableLimitFPSWhenShare (bool bEnable)=0
	Enable/disable the 'limited sharing fps' feature when uses shares.

virtual LimitFPSValue	GetLimitFPSValueWhenShare ()=0
	Gets the limited sharing fps value when the 'limited sharing fps' feature is enabled.

virtual SDKError	SetLimitFPSValueWhenShare (LimitFPSValue value)=0
	Sets the limited sharing fps value when the 'limited sharing fps' feature is enabled.

virtual SDKError	EnableShowMyAppWindowWhenShare (bool bEnable)=0
	Enable/Disable to show the userself's app window when shares.

virtual bool	IsShowMyAppWindowWhenShareEnabled ()=0
	Determines if it is enable to show the userself's app window when shares.

virtual bool	IsSupportShowMyAppWindowWhenShare ()=0
	Determines if the feature that showing the userself's app window when shares is supported.

virtual bool	IsDoNotDisturbInSharingOn ()=0
	Determines if it is silence system notification when sharing on.

virtual SDKError	EnableDoNotDisturbInSharing (bool bEnable)=0
	Enable/Disable to silence system notification when sharing on.

virtual SDKError	EnableHardwareAcceleratedAnnotation (bool bEnable)=0
	Enable/Disable the GPU acceleration when a user adds annotations on a shared screen or whiteboard.

virtual SDKError	IsAnnotationHardwareAccelerated (bool &bEnable)=0
	Determines if GPU acceleration is enabled when user use annotations on a shared screen or whiteboard.

virtual SDKError	EnableHardwareAcceleratedVideoSharing (bool bEnable)=0
	Enable/Disable the GPU acceleration when user shares video.

virtual SDKError	IsVideoSharingHardwareAccelerated (bool &bEnable)=0
	Determines if GPU acceleration is enabled when a user shares video.

virtual SDKError	EnableShareContentFlashDetection (bool bEnable)=0
	Enable or disable automatic video dimming when sharing flashing content. When enabled, the video is automatically dimmed when the shared content contains flashing elements.

virtual bool	IsShareContentFlashDetectionEnabled ()=0
	Query whether automatic dimming of video when sharing content flashes is enabled.

Detailed Description

Share setting interface.

Definition at line 2829 of file setting_service_interface.h.

Member Function Documentation

◆ EnableAccelerateGPUWhenShare()

virtual SDKError IShareSettingContext::EnableAccelerateGPUWhenShare ( bool bEnable )

pure virtual

Enable/Disable the GPU acceleration when user shares.

Parameters

bEnable true indicates to enable the acceleration. false not.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnableAutoFitToWindowWhenViewSharing()

virtual SDKError IShareSettingContext::EnableAutoFitToWindowWhenViewSharing ( bool bEnable )

pure virtual

Enables or disable to auto-fit the ZOOM window when viewing the shared content.

Parameters

bEnable true indicates to resize automatically.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnableDoNotDisturbInSharing()

virtual SDKError IShareSettingContext::EnableDoNotDisturbInSharing ( bool bEnable )

pure virtual

Enable/Disable to silence system notification when sharing on.

Parameters

bEnable true indicates to silence system notification when sharing on. false not.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnableGreenBorderWhenShare()

virtual SDKError IShareSettingContext::EnableGreenBorderWhenShare ( bool bEnable )

pure virtual

Sets the visibility of the green border when sharing the application.

Parameters

bShow true indicates to display the frame. false hide.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnableHardwareAcceleratedAnnotation()

virtual SDKError IShareSettingContext::EnableHardwareAcceleratedAnnotation ( bool bEnable )

pure virtual

Enable/Disable the GPU acceleration when a user adds annotations on a shared screen or whiteboard.

Parameters

bEnable true indicates to enable acceleration.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnableHardwareAcceleratedVideoSharing()

virtual SDKError IShareSettingContext::EnableHardwareAcceleratedVideoSharing ( bool bEnable )

pure virtual

Enable/Disable the GPU acceleration when user shares video.

Parameters

bEnable true indicates to enable the acceleration.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnableLimitFPSWhenShare()

virtual SDKError IShareSettingContext::EnableLimitFPSWhenShare ( bool bEnable )

pure virtual

Enable/disable the 'limited sharing fps' feature when uses shares.

Parameters

bEnable true indicates to enable the litmited fps feature. false hide.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnableShareContentFlashDetection()

virtual SDKError IShareSettingContext::EnableShareContentFlashDetection ( bool bEnable )

pure virtual

Enable or disable automatic video dimming when sharing flashing content. When enabled, the video is automatically dimmed when the shared content contains flashing elements.

Parameters

enable true to enable automatic dimming, false to disable.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnableShowMyAppWindowWhenShare()

virtual SDKError IShareSettingContext::EnableShowMyAppWindowWhenShare ( bool bEnable )

pure virtual

Enable/Disable to show the userself's app window when shares.

Parameters

bEnable true indicates to enable to show the window. false not.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnableTCPConnectionWhenSharing()

virtual SDKError IShareSettingContext::EnableTCPConnectionWhenSharing ( bool bEnable )

pure virtual

Enables or disable TCP connecting when sharing.

Parameters

bEnable true indicates to use TCP connecting when sharing.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ GetLimitFPSValueWhenShare()

virtual LimitFPSValue IShareSettingContext::GetLimitFPSValueWhenShare ( )

pure virtual

Gets the limited sharing fps value when the 'limited sharing fps' feature is enabled.

◆ IsAccelerateGPUWhenShareEnabled()

virtual SDKError IShareSettingContext::IsAccelerateGPUWhenShareEnabled ( bool & bEnable )

pure virtual

Determines if GPU acceleration is enabled when user shares.

Parameters

[out]

true indicates the GPU acceleration is enabled. false not. It validates only when the return value is SDKERR_SUCCESS.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ IsAnnotationHardwareAccelerated()

virtual SDKError IShareSettingContext::IsAnnotationHardwareAccelerated ( bool & bEnable )

pure virtual

Determines if GPU acceleration is enabled when user use annotations on a shared screen or whiteboard.

Parameters

[out]

true indicates the GPU acceleration is enabled. It validates only when the return value is SDKERR_SUCCESS.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ IsAutoFitToWindowWhenViewSharingEnabled()

virtual bool IShareSettingContext::IsAutoFitToWindowWhenViewSharingEnabled ( )

pure virtual

Determines if it is able to auto-fit the ZOOM window when viewing the shared content.

Returns: true indicates to resize automatically.

◆ IsCurrentOSSupportAccelerateGPUWhenShare()

virtual bool IShareSettingContext::IsCurrentOSSupportAccelerateGPUWhenShare ( )

pure virtual

Determines if the operating system supports the GPU acceleration when user shares.

Returns: true indicates support.

◆ IsDoNotDisturbInSharingOn()

virtual bool IShareSettingContext::IsDoNotDisturbInSharingOn ( )

pure virtual

Determines if it is silence system notification when sharing on.

Returns: true indicates to silence system notification when sharing on.

◆ IsGreenBorderEnabledWhenShare()

virtual bool IShareSettingContext::IsGreenBorderEnabledWhenShare ( )

pure virtual

Determines if the green border is enabled when user shares.

Returns: true if support. Otherwise, false.

◆ IsLimitFPSEnabledWhenShare()

virtual bool IShareSettingContext::IsLimitFPSEnabledWhenShare ( )

pure virtual

Determines if the 'limited sharing fps' feature is enabled when user shares.

Returns: true indicates support.

◆ IsShareContentFlashDetectionEnabled()

virtual bool IShareSettingContext::IsShareContentFlashDetectionEnabled ( )

pure virtual

Query whether automatic dimming of video when sharing content flashes is enabled.

Returns: true if the feature is enabled, false otherwise.

◆ IsShowMyAppWindowWhenShareEnabled()

virtual bool IShareSettingContext::IsShowMyAppWindowWhenShareEnabled ( )

pure virtual

Determines if it is enable to show the userself's app window when shares.

Returns: true indicates to show the userself's app window when shares.

◆ IsSupportShowMyAppWindowWhenShare()

virtual bool IShareSettingContext::IsSupportShowMyAppWindowWhenShare ( )

pure virtual

Determines if the feature that showing the userself's app window when shares is supported.

Returns: true indicates to support.

◆ IsTCPConnectionWhenSharing()

virtual bool IShareSettingContext::IsTCPConnectionWhenSharing ( )

pure virtual

Determines if it is enable use TCP connection when sharing.

Returns: true indicates to enter the full screen video mode.

◆ IsVideoSharingHardwareAccelerated()

virtual SDKError IShareSettingContext::IsVideoSharingHardwareAccelerated ( bool & bEnable )

pure virtual

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

Parameters

[out]

true indicates the GPU acceleration is enabled. false indicates the GPU acceleration is not. It validates only when the return value is SDKERR_SUCCESS.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ SetLimitFPSValueWhenShare()

virtual SDKError IShareSettingContext::SetLimitFPSValueWhenShare ( LimitFPSValue value )

pure virtual

Sets the limited sharing fps value when the 'limited sharing fps' feature is enabled.

Parameters

value Specifies the limited fps value. It validates only when the 'limited sharing fps' feature is enabled.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Public Member Functions

Detailed Description

Member Function Documentation

◆ EnableAccelerateGPUWhenShare()

◆ EnableAutoFitToWindowWhenViewSharing()

◆ EnableDoNotDisturbInSharing()

◆ EnableGreenBorderWhenShare()

◆ EnableHardwareAcceleratedAnnotation()

◆ EnableHardwareAcceleratedVideoSharing()

◆ EnableLimitFPSWhenShare()

◆ EnableShareContentFlashDetection()

◆ EnableShowMyAppWindowWhenShare()

◆ EnableTCPConnectionWhenSharing()

◆ GetLimitFPSValueWhenShare()

◆ IsAccelerateGPUWhenShareEnabled()

◆ IsAnnotationHardwareAccelerated()

◆ IsAutoFitToWindowWhenViewSharingEnabled()

◆ IsCurrentOSSupportAccelerateGPUWhenShare()

◆ IsDoNotDisturbInSharingOn()

◆ IsGreenBorderEnabledWhenShare()

◆ IsLimitFPSEnabledWhenShare()

◆ IsShareContentFlashDetectionEnabled()

◆ IsShowMyAppWindowWhenShareEnabled()

◆ IsSupportShowMyAppWindowWhenShare()

◆ IsTCPConnectionWhenSharing()

◆ IsVideoSharingHardwareAccelerated()

◆ SetLimitFPSValueWhenShare()