General setting interface. More...

#include <setting_service_interface.h>

Public Member Functions
virtual SDKError	EnableDualScreenMode (bool bEnable)=0
	Enable or disable dual screen mode. More...

virtual bool	IsDualScreenModeEnabled ()=0
	Determine if the dual screen mode is supported. More...

virtual SDKError	TurnOffAeroModeInSharing (bool bTurnoff)=0
	Enable or disable the aero mode when sharing the screen. More...

virtual bool	IsAeroModeInSharingTurnOff ()=0
	Determine if the aero mode is turned off when sharing the screen. More...

virtual SDKError	EnableAutoFitToWindowWhenViewSharing (bool bEnable)=0
	Enable or disable to auto-fit the ZOOM window when viewing the shared content. More...

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

virtual SDKError	EnableAutoFullScreenVideoWhenJoinMeeting (bool bEnable)=0
	Enable or disable to enter the full screen video mode automatically when join meeting. More...

virtual bool	IsAutoFullScreenVideoWhenJoinMeetingEnabled ()=0
	Determine if it is able to enter the full screen video mode automatically when join meeting. More...

virtual SDKError	EnableAutoFullScreenVideoWhenViewShare (bool bEnable)=0
	Enable or disable to enter the full screen video mode automatically when viewing the sharing. More...

virtual bool	IsAutoFullScreenVideoWhenViewShareEnabled ()=0
	Determine if it is enable to enter the full screen video mode automatically when viewing the sharing. More...

virtual SDKError	EnableSplitScreenMode (bool bEnable)=0
	Enable or disable to use the split screen mode, which enables the attendees to view the lectures or the gallery. More...

virtual bool	IsSplitScreenModeEnabled ()=0
	Determine if the split screen mode is enabled. More...

virtual SDKError	EnableDisplayReminderWindowWhenExit (bool bEnable)=0
	Enable/Disable reminder window when user exits the meeting. Available only for normal attendees (non-host). More...

virtual bool	IsDisplayReminderWindowWhenExitEnabled ()=0
	Determine if reminder window is enabled when user exits the meeting. More...

virtual SDKError	EnableShowMyMeetingElapseTime (bool bEnable)=0
	Enable/Disable to show the elapsed time of the meeting. More...

virtual bool	IsShowMyMeetingElapseTimeEnabled ()=0
	Determine if showing elapsed time of the meeting is enabled. More...

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

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

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

virtual SDKError	EnableRemoteControlAllApplications (bool bEnable)=0
	Enable/disable remote control of all applications. More...

virtual bool	IsRemoteControlAllApplicationsEnabled ()=0
	Determine if remote control of all applications is enabled. More...

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

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

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

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

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. More...

Detailed Description

General setting interface.

Member Function Documentation

◆ EnableAccelerateGPUWhenShare()

virtual SDKError IGeneralSettingContext::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 IGeneralSettingContext::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.

◆ EnableAutoFullScreenVideoWhenJoinMeeting()

virtual SDKError IGeneralSettingContext::EnableAutoFullScreenVideoWhenJoinMeeting ( bool bEnable )

pure virtual

Enable or disable to enter the full screen video mode automatically when join meeting.

Parameters

bEnable TRUE indicates to enter the full screen video mode.

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

◆ EnableAutoFullScreenVideoWhenViewShare()

virtual SDKError IGeneralSettingContext::EnableAutoFullScreenVideoWhenViewShare ( bool bEnable )

pure virtual

Enable or disable to enter the full screen video mode automatically when viewing the sharing.

Parameters

bEnable TRUE indicates to enter the full screen video mode.

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

◆ EnableDisplayReminderWindowWhenExit()

virtual SDKError IGeneralSettingContext::EnableDisplayReminderWindowWhenExit ( bool bEnable )

pure virtual

Enable/Disable reminder window when user exits the meeting. Available only for normal attendees (non-host).

Parameters

bEnable TRUE indicates to enable reminder window.

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

◆ EnableDualScreenMode()

virtual SDKError IGeneralSettingContext::EnableDualScreenMode ( bool bEnable )

pure virtual

Enable or disable dual screen mode.

Parameters

bEnable TRUE indicates to set to enable the dual screen mode.

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

◆ EnableGreenBorderWhenShare()

virtual SDKError IGeneralSettingContext::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.

◆ EnableLimitFPSWhenShare()

virtual SDKError IGeneralSettingContext::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.

◆ EnableRemoteControlAllApplications()

virtual SDKError IGeneralSettingContext::EnableRemoteControlAllApplications ( bool bEnable )

pure virtual

Enable/disable remote control of all applications.

Parameters

bEnable TRUE indicates to enable the remote control. FALSE not.

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

◆ EnableShowMyMeetingElapseTime()

virtual SDKError IGeneralSettingContext::EnableShowMyMeetingElapseTime ( bool bEnable )

pure virtual

Enable/Disable to show the elapsed time of the meeting.

Parameters

bEnable TRUE indicates to show the elapsed time. FALSE not.

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

◆ EnableSplitScreenMode()

virtual SDKError IGeneralSettingContext::EnableSplitScreenMode ( bool bEnable )

pure virtual

Enable or disable to use the split screen mode, which enables the attendees to view the lectures or the gallery.

Parameters

bEnable TRUE indicates to enter the split screen mode.

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

◆ IsAccelerateGPUWhenShareEnabled()

virtual SDKError IGeneralSettingContext::IsAccelerateGPUWhenShareEnabled ( bool & bEnable )

pure virtual

Determine if GPU acceleration is enabled when user shares.

Parameters

[out]

◆ IsAeroModeInSharingTurnOff()

virtual bool IGeneralSettingContext::IsAeroModeInSharingTurnOff ( )

pure virtual

Determine if the aero mode is turned off when sharing the screen.

Returns: TRUE indicates to turn off the mode.

◆ IsAutoFitToWindowWhenViewSharingEnabled()

virtual bool IGeneralSettingContext::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.

◆ IsAutoFullScreenVideoWhenJoinMeetingEnabled()

virtual bool IGeneralSettingContext::IsAutoFullScreenVideoWhenJoinMeetingEnabled ( )

pure virtual

Determine if it is able to enter the full screen video mode automatically when join meeting.

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

◆ IsAutoFullScreenVideoWhenViewShareEnabled()

virtual bool IGeneralSettingContext::IsAutoFullScreenVideoWhenViewShareEnabled ( )

pure virtual

Determine if it is enable to enter the full screen video mode automatically when viewing the sharing.

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

◆ IsCurrentOSSupportAccelerateGPUWhenShare()

virtual bool IGeneralSettingContext::IsCurrentOSSupportAccelerateGPUWhenShare ( )

pure virtual

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

Returns: TRUE indicates support. FALSE not.

◆ IsDisplayReminderWindowWhenExitEnabled()

virtual bool IGeneralSettingContext::IsDisplayReminderWindowWhenExitEnabled ( )

pure virtual

Determine if reminder window is enabled when user exits the meeting.

Returns: TRUE indicates enabled. FALSE not.

◆ IsDualScreenModeEnabled()

virtual bool IGeneralSettingContext::IsDualScreenModeEnabled ( )

pure virtual

Determine if the dual screen mode is supported.

Returns: TRUE indicates to enable the dual screen mode.

◆ IsGreenBorderEnabledWhenShare()

virtual bool IGeneralSettingContext::IsGreenBorderEnabledWhenShare ( )

pure virtual

Determine if the green border is enabled when user shares.

Returns: TRUE indicates support. FALSE not.

◆ IsLimitFPSEnabledWhenShare()

virtual bool IGeneralSettingContext::IsLimitFPSEnabledWhenShare ( )

pure virtual

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

Returns: TRUE indicates support. FALSE not.

◆ IsRemoteControlAllApplicationsEnabled()

virtual bool IGeneralSettingContext::IsRemoteControlAllApplicationsEnabled ( )

pure virtual

Determine if remote control of all applications is enabled.

Returns: TRUE indicates enabled. FALSE not.

◆ IsShowMyMeetingElapseTimeEnabled()

virtual bool IGeneralSettingContext::IsShowMyMeetingElapseTimeEnabled ( )

pure virtual

Determine if showing elapsed time of the meeting is enabled.

Returns: TRUE indicates to show. FALSE not.

◆ IsSplitScreenModeEnabled()

virtual bool IGeneralSettingContext::IsSplitScreenModeEnabled ( )

pure virtual

Determine if the split screen mode is enabled.

Returns: TRUE indicates enabled. FALSE not.

◆ SetLimitFPSValueWhenShare()

virtual SDKError IGeneralSettingContext::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.

◆ TurnOffAeroModeInSharing()

virtual SDKError IGeneralSettingContext::TurnOffAeroModeInSharing ( bool bTurnoff )

pure virtual

Enable or disable the aero mode when sharing the screen.

Parameters

bTurnoff TRUE indicates to turn off the aero mode when sharing the screen.

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

Remarks: The function can only be called in windows 7 environment.

The documentation for this class was generated from the following file:

h/setting_service_interface.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ EnableAccelerateGPUWhenShare()

◆ EnableAutoFitToWindowWhenViewSharing()

◆ EnableAutoFullScreenVideoWhenJoinMeeting()

◆ EnableAutoFullScreenVideoWhenViewShare()

◆ EnableDisplayReminderWindowWhenExit()

◆ EnableDualScreenMode()

◆ EnableGreenBorderWhenShare()

◆ EnableLimitFPSWhenShare()

◆ EnableRemoteControlAllApplications()

◆ EnableShowMyMeetingElapseTime()

◆ EnableSplitScreenMode()

◆ IsAccelerateGPUWhenShareEnabled()

◆ IsAeroModeInSharingTurnOff()

◆ IsAutoFitToWindowWhenViewSharingEnabled()

◆ IsAutoFullScreenVideoWhenJoinMeetingEnabled()

◆ IsAutoFullScreenVideoWhenViewShareEnabled()

◆ IsCurrentOSSupportAccelerateGPUWhenShare()

◆ IsDisplayReminderWindowWhenExitEnabled()

◆ IsDualScreenModeEnabled()

◆ IsGreenBorderEnabledWhenShare()

◆ IsLimitFPSEnabledWhenShare()

◆ IsRemoteControlAllApplicationsEnabled()

◆ IsShowMyMeetingElapseTimeEnabled()

◆ IsSplitScreenModeEnabled()

◆ SetLimitFPSValueWhenShare()

◆ TurnOffAeroModeInSharing()