IGeneralSettingContext Class Reference

General setting interface. More...

#include <setting_service_interface.h>

Public Member Functions
virtual SDKError	EnableAutoCopyInviteLink (bool bEnable)=0
	Enable or disable to copy invite url automatically when meeting starts.
virtual bool	IsAutoCopyInviteLinkEnabled ()=0
	Determine if it is able to automatically copy invite url when meeting starts is enabled.
virtual SDKError	EnableMuteWhenLockScreen (bool bEnable)=0
	Enable or disable to stop user's video and audio when user's display is off or screen save begins.
virtual bool	IsMuteWhenLockScreenEnabled ()=0
	Determine if it is able to stop user's video and audio when user's display is off or screen save begins.
virtual SDKError	EnableDualScreenMode (bool bEnable)=0
	Enable or disable dual screen mode.
virtual bool	IsDualScreenModeEnabled ()=0
	Determine if the dual screen mode is supported.
virtual SDKError	TurnOffAeroModeInSharing (bool bTurnoff)=0
	Enable or disable the aero mode when sharing the screen.
virtual bool	IsAeroModeInSharingTurnOff ()=0
	Determine if the aero mode is turned off when sharing the screen.
virtual SDKError	EnableAutoFullScreenVideoWhenJoinMeeting (bool bEnable)=0
	Enable or disable to enter the full screen video mode automatically when join meeting.
virtual bool	IsAutoFullScreenVideoWhenJoinMeetingEnabled ()=0
	Determine if it is able to enter the full screen video mode automatically when join meeting.
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.
virtual bool	IsSplitScreenModeEnabled ()=0
	Determine if the split screen mode is enabled.
virtual SDKError	EnableDisplayReminderWindowWhenExit (bool bEnable)=0
	Enable/Disable reminder window when user exits the meeting. Available only for normal attendees (non-host).
virtual bool	IsDisplayReminderWindowWhenExitEnabled ()=0
	Determine if reminder window is enabled when user exits the meeting.
virtual SDKError	EnableShowMyMeetingElapseTime (bool bEnable)=0
	Enable/Disable to show the elapsed time of the meeting.
virtual bool	IsShowMyMeetingElapseTimeEnabled ()=0
	Determine if showing elapsed time of the meeting is enabled.
virtual SDKError	SetReactionSkinTone (ReactionSkinToneType skinTone)=0
	Set the emoji reaction skin tone type.
virtual ReactionSkinToneType	GetReactionSkinTone ()=0
	Get the emoji reaction skin tone type.
virtual bool	IsSupportSetUITheme ()=0
	Determine if support set UI theme.
virtual SDKError	SetUITheme (ZoomSDKUITheme theme)=0
	Set the UI skin theme type.
virtual ZoomSDKUITheme	GetUITheme ()=0
	Get the UI skin theme type.
virtual bool	IsSupportSetUIAppearance ()=0
	Determine if support set UI appearance.
virtual SDKError	SetUIAppearance (ZoomSDKUIAppearance appearance)=0
	Set the UI appearance type.
virtual ZoomSDKUIAppearance	GetUIAppearance ()=0
	Get the UI appearance type.

Detailed Description

General setting interface.

Definition at line 515 of file setting_service_interface.h.

Member Function Documentation

EnableAutoCopyInviteLink()

virtual SDKError IGeneralSettingContext::EnableAutoCopyInviteLink ( bool bEnable )

pure virtual

Enable or disable to copy invite url automatically when meeting starts.

Parameters

bEnable

true means to copy invite url automatically.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

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 means to enter the full screen video mode.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

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 means to enable reminder window.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

EnableDualScreenMode()

virtual SDKError IGeneralSettingContext::EnableDualScreenMode ( bool bEnable )

pure virtual

Enable or disable dual screen mode.

Parameters

bEnable

true means to set to enable the dual screen mode.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

EnableMuteWhenLockScreen()

virtual SDKError IGeneralSettingContext::EnableMuteWhenLockScreen ( bool bEnable )

pure virtual

Enable or disable to stop user's video and audio when user's display is off or screen save begins.

Parameters

bEnable

true means to stop.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

EnableShowMyMeetingElapseTime()

virtual SDKError IGeneralSettingContext::EnableShowMyMeetingElapseTime ( bool bEnable )

pure virtual

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

Parameters

bEnable

true means to show the elapsed time. FALSE not.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

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 means to enter the split screen mode.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

GetReactionSkinTone()

virtual ReactionSkinToneType IGeneralSettingContext::GetReactionSkinTone ( )

pure virtual

Get the emoji reaction skin tone type.

Returns

The return value is the emoji reaction skin tone type.

GetUIAppearance()

virtual ZoomSDKUIAppearance IGeneralSettingContext::GetUIAppearance ( )

pure virtual

Get the UI appearance type.

Returns

The return value is the UI appearance type.

GetUITheme()

virtual ZoomSDKUITheme IGeneralSettingContext::GetUITheme ( )

pure virtual

Get the UI skin theme type.

Returns

The return value is the UI skin theme type.

IsAeroModeInSharingTurnOff()

virtual bool IGeneralSettingContext::IsAeroModeInSharingTurnOff ( )

pure virtual

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

Returns

true means to turn off the mode.

IsAutoCopyInviteLinkEnabled()

virtual bool IGeneralSettingContext::IsAutoCopyInviteLinkEnabled ( )

pure virtual

Determine if it is able to automatically copy invite url when meeting starts is enabled.

Returns

true means to enabled.

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 means to enter the full screen video mode.

IsDisplayReminderWindowWhenExitEnabled()

virtual bool IGeneralSettingContext::IsDisplayReminderWindowWhenExitEnabled ( )

pure virtual

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

Returns

true means enabled.

IsDualScreenModeEnabled()

virtual bool IGeneralSettingContext::IsDualScreenModeEnabled ( )

pure virtual

Determine if the dual screen mode is supported.

Returns

true means to enable the dual screen mode.

IsMuteWhenLockScreenEnabled()

virtual bool IGeneralSettingContext::IsMuteWhenLockScreenEnabled ( )

pure virtual

Determine if it is able to stop user's video and audio when user's display is off or screen save begins.

Returns

true means to enabled.

IsShowMyMeetingElapseTimeEnabled()

virtual bool IGeneralSettingContext::IsShowMyMeetingElapseTimeEnabled ( )

pure virtual

Determine if showing elapsed time of the meeting is enabled.

Returns

true means to show.

IsSplitScreenModeEnabled()

virtual bool IGeneralSettingContext::IsSplitScreenModeEnabled ( )

pure virtual

Determine if the split screen mode is enabled.

Returns

true means enabled.

IsSupportSetUIAppearance()

virtual bool IGeneralSettingContext::IsSupportSetUIAppearance ( )

pure virtual

Determine if support set UI appearance.

Returns

true means to support.

IsSupportSetUITheme()

virtual bool IGeneralSettingContext::IsSupportSetUITheme ( )

pure virtual

Determine if support set UI theme.

Returns

true means to support. FALSE not.

SetReactionSkinTone()

virtual SDKError IGeneralSettingContext::SetReactionSkinTone ( ReactionSkinToneType skinTone )

pure virtual

Set the emoji reaction skin tone type.

Parameters

skinTone

Specifies the skin tone type.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

SetUIAppearance()

virtual SDKError IGeneralSettingContext::SetUIAppearance ( ZoomSDKUIAppearance appearance )

pure virtual

Set the UI appearance type.

Parameters

theme

Specifies the UI appearance type.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

SetUITheme()

virtual SDKError IGeneralSettingContext::SetUITheme ( ZoomSDKUITheme theme )

pure virtual

Set the UI skin theme type.

Parameters

theme

Specifies the skin theme type.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

TurnOffAeroModeInSharing()

virtual SDKError IGeneralSettingContext::TurnOffAeroModeInSharing ( bool bTurnoff )

pure virtual

Enable or disable the aero mode when sharing the screen.

Parameters

bTurnoff

true means to turn off the aero mode when sharing the screen.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Note

The function can only be called in windows 7 environment.