IShareSettingContext Class Reference

Share setting interface. More...

#include <setting_service_interface.h>

Public Member Functions
virtual SDKError	EnableAutoFitToWindowWhenViewSharing (bool bEnable)=0
	Enable or disable to auto-fit the ZOOM window when viewing the shared content.
virtual bool	IsAutoFitToWindowWhenViewSharingEnabled ()=0
	Determine if it is able to auto-fit the ZOOM window when viewing the shared content.
virtual SDKError	EnableTCPConnectionWhenSharing (bool bEnable)=0
	Enable or disable TCP connecting when sharing.
virtual bool	IsTCPConnectionWhenSharing ()=0
	Determine if it is enable use TCP connection when sharing.
virtual bool	IsCurrentOSSupportAccelerateGPUWhenShare ()=0
	Determine 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
	Determine if GPU acceleration is enabled when user shares.
virtual SDKError	EnableGreenBorderWhenShare (bool bEnable)=0
	Set the visibility of the green border when sharing the application.
virtual bool	IsGreenBorderEnabledWhenShare ()=0
	Determine if the green border is enabled when user shares.
virtual bool	IsLimitFPSEnabledWhenShare ()=0
	Determine 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
	Get the limited sharing fps value when the 'limited sharing fps' feature is enabled.
virtual SDKError	SetLimitFPSValueWhenShare (LimitFPSValue value)=0
	Set 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
	Determine if it is enable to show the userself's app window when shares.
virtual bool	IsSupportShowMyAppWindowWhenShare ()=0
	Determine if the feature that showing the userself's app window when shares is supported.
virtual bool	IsDoNotDisturbInSharingOn ()=0
	Determine 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
	Determine 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
	Determine if GPU acceleration is enabled when a user shares video.

Detailed Description

Share setting interface.

Definition at line 2147 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 failed. To get extended error information, see SDKError enum.

EnableAutoFitToWindowWhenViewSharing()

virtual SDKError IShareSettingContext::EnableAutoFitToWindowWhenViewSharing ( bool bEnable )

pure virtual

Enable 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 failed. To get extended error information, see SDKError enum.

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 failed. To get extended error information, see SDKError enum.

EnableGreenBorderWhenShare()

virtual SDKError IShareSettingContext::EnableGreenBorderWhenShare ( bool bEnable )

pure virtual

Set 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 failed. To get extended error information, see SDKError enum.

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. FALSE indicates to not enable acceleration.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

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. FALSE indicates to not enable acceleration.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise it fails. To get extended error information, see SDKError enum.

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 failed. To get extended error information, see SDKError enum.

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 failed. To get extended error information, see SDKError enum.

EnableTCPConnectionWhenSharing()

virtual SDKError IShareSettingContext::EnableTCPConnectionWhenSharing ( bool bEnable )

pure virtual

Enable 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 failed. To get extended error information, see SDKError enum.

GetLimitFPSValueWhenShare()

virtual LimitFPSValue IShareSettingContext::GetLimitFPSValueWhenShare ( )

pure virtual

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

IsAccelerateGPUWhenShareEnabled()

virtual SDKError IShareSettingContext::IsAccelerateGPUWhenShareEnabled ( bool & bEnable )

pure virtual

Determine 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 failed. To get extended error information, see SDKError enum.

IsAnnotationHardwareAccelerated()

virtual SDKError IShareSettingContext::IsAnnotationHardwareAccelerated ( bool & bEnable )

pure virtual

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

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 it fails. To get extended error information, see SDKError enum.

IsAutoFitToWindowWhenViewSharingEnabled()

virtual bool IShareSettingContext::IsAutoFitToWindowWhenViewSharingEnabled ( )

pure virtual

Determine 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

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

Returns

TRUE indicates support. FALSE not.

IsDoNotDisturbInSharingOn()

virtual bool IShareSettingContext::IsDoNotDisturbInSharingOn ( )

pure virtual

Determine 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

Determine if the green border is enabled when user shares.

Returns

TRUE indicates support. FALSE not.

IsLimitFPSEnabledWhenShare()

virtual bool IShareSettingContext::IsLimitFPSEnabledWhenShare ( )

pure virtual

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

Returns

TRUE indicates support. FALSE not.

IsShowMyAppWindowWhenShareEnabled()

virtual bool IShareSettingContext::IsShowMyAppWindowWhenShareEnabled ( )

pure virtual

Determine 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

Determine 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

Determine 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

Determine 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 it fails. To get extended error information, see SDKError enum.

SetLimitFPSValueWhenShare()

virtual SDKError IShareSettingContext::SetLimitFPSValueWhenShare ( LimitFPSValue value )

pure virtual

Set 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 failed. To get extended error information, see SDKError enum.