ZoomSDKGeneralSetting Class Reference

General settings interface for controlling meeting behaviors and UI customizations. More...

#include <ZoomSDKSettingService.h>

Inherits NSObject.

Instance Methods
(ZoomSDKError)	- enableMeetingSetting:SettingCmd:
	Enable or disable meeting settings by command.
(ZoomSDKError)	- setCustomInviteURL:
	Set custom link for invitation.
(ZoomSDKError)	- setCustomFeedbackURL:
	Custom support URL.
(void)	- hideSettingComponent:hide:
	Hide setting components.
(ZoomSDKError)	- setCustomURL:urlString:
	This method is used to set default URL for setting components.
(BOOL)	- isShowLockMeetingTime
	Get the current status of show meeting time.
(ZoomSDKError)	- enableToShowMeetingTime:
	Enable or disenable to set show meeting time.
(BOOL)	- isEnableCopyInviteURL
	Determine if can copy invite url after start meeting.
(ZoomSDKError)	- setCopyMeetingInviteURL:
	to set meeting invite url can copy.
(BOOL)	- isEnableConfirmLeavingMeeting
	Determine if can comfire when leaving meeting.
(ZoomSDKError)	- setConfirmLeavingMeeting:
	to set confirm when user leaving meeting.
(ZoomSDKError)	- setUIAppearance:
	To set the appearance of ui.
(ZoomSDKUIAppearance)	- getUIAppearance
	Get the UI appearance type.
(BOOL)	- isSupportSetUITheme
	Determine if support set ui theme.
(ZoomSDKError)	- setUITheme:
	Set the theme of ui.
(ZoomSDKUITheme)	- getUITheme
	Query the theme of ui.
(ZoomSDKError)	- setMuteVideoAndAudioWhenLockScreen:
	Stop my video and audio when my display is off or screen saver begins.
(BOOL)	- isMutedVideoAndAudioWhenLockScreen
	Determine if mute video and aodio when lock screen.
(ZoomSDKError)	- setReactionSkinTone:
	Set the skintone of the reaction.
(ZoomSDKEmojiReactionSkinTone)	- getReactionSkinTone
	Get the skintone of the reaction.
(ZoomSDKError)	- hideAutoCopyInviteLinkCheckBox:
	Hide checkbox of automatically copy invite link when meeting start.
(ZoomSDKError)	- enableMuteOnEntry:allowUnmuteBySelf:
	Mute attendees when they join the meeting.
(ZoomSDKWallpaperController *)	- getWallpaperController
	Get the object of set wallpaper controller.

Detailed Description

General settings interface for controlling meeting behaviors and UI customizations.

Definition at line 1409 of file ZoomSDKSettingService.h.

Method Documentation

enableMeetingSetting:SettingCmd:

- (ZoomSDKError) enableMeetingSetting:		(BOOL)	enable
SettingCmd:		(MeetingSettingCmd)	cmd

Enable or disable meeting settings by command.

Parameters

enable	YES means to enable, otherwise not.
cmd	An enumeration of commands that you can enable or disable them in the meeting.

Returns

If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

enableMuteOnEntry:allowUnmuteBySelf:

- (ZoomSDKError) enableMuteOnEntry:		(BOOL)	bEnable
allowUnmuteBySelf:		(BOOL)	allow

Mute attendees when they join the meeting.

Parameters

bEnable	YES means when attendees join the meeting is muted,otherwise not.
allow	YES means attendee can unmute self,otherwise not.

Returns

If the function is success will return ZoomSDKError_Success, otherwise fail.

enableToShowMeetingTime:

- (ZoomSDKError) enableToShowMeetingTime:

(BOOL)

enable

Enable or disenable to set show meeting time.

Parameters

enable

YES is means show meeting time otherwise is hidden

Returns

If the function is success will return ZoomSDKError_Success. Otherwise fail.

getReactionSkinTone

- (ZoomSDKEmojiReactionSkinTone) getReactionSkinTone

Get the skintone of the reaction.

Returns

The value of the current reaction skintone.

getUIAppearance

- (ZoomSDKUIAppearance) getUIAppearance

Get the UI appearance type.

Returns

The return value is the UI appearance type.

getUITheme

- (ZoomSDKUITheme) getUITheme

Query the theme of ui.

Returns

If the function is success will return the theme of ui.

getWallpaperController

- (ZoomSDKWallpaperController *) getWallpaperController

Get the object of set wallpaper controller.

Returns

If the function succeeds, it will return a ZoomSDKWallpaperController object, otherwise failed, returns nil.

hideAutoCopyInviteLinkCheckBox:

- (ZoomSDKError) hideAutoCopyInviteLinkCheckBox:

(BOOL)

hide

Hide checkbox of automatically copy invite link when meeting start.

Parameters

hide	YES means hide the checkbox,otherwise not.

Returns

If the function is success will return ZoomSDKError_Success, otherwise fail.

hideSettingComponent:hide:

- (void) hideSettingComponent:		(SettingComponent)	component
hide:		(BOOL)	hide

Hide setting components.

Parameters

component	An enumeration of components for controlling meeting.
hide	YES means to hide, NO to show.

isEnableConfirmLeavingMeeting

- (BOOL) isEnableConfirmLeavingMeeting

Determine if can comfire when leaving meeting.

Returns

YES means enabled, otherwise not.

isEnableCopyInviteURL

- (BOOL) isEnableCopyInviteURL

Determine if can copy invite url after start meeting.

Returns

YES means enabled, otherwise not.

isMutedVideoAndAudioWhenLockScreen

- (BOOL) isMutedVideoAndAudioWhenLockScreen

Determine if mute video and aodio when lock screen.

Returns

YES means enabled, otherwise not.

isShowLockMeetingTime

- (BOOL) isShowLockMeetingTime

Get the current status of show meeting time.

Returns

If return Yes is means show meeting time

isSupportSetUITheme

- (BOOL) isSupportSetUITheme

Determine if support set ui theme.

Returns

If support, it will return YES, otherwise not.

setConfirmLeavingMeeting:

- (ZoomSDKError) setConfirmLeavingMeeting:

(BOOL)

enable

to set confirm when user leaving meeting.

Parameters

enable

Yes means will confirm when user leaving meeting.

Returns

If the function is success will return ZoomSDKError_Success, otherwise fail.

setCopyMeetingInviteURL:

- (ZoomSDKError) setCopyMeetingInviteURL:

(BOOL)

enable

to set meeting invite url can copy.

Parameters

enable

YES means can copy otherwise not.

Returns

If the function is success will return ZoomSDKError_Success. Otherwise fail.

setCustomFeedbackURL:

- (ZoomSDKError) setCustomFeedbackURL:

(NSString *)

feedbackURL

Custom support URL.

Parameters

feedbackURL

support URL.

Returns

If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

Deprecated

This method is no longer used.

setCustomInviteURL:

- (ZoomSDKError) setCustomInviteURL:

(NSString *)

inviteURL

Set custom link for invitation.

Parameters

inviteURL

The URL for invitation by which user can join meeting.

Returns

If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

setCustomURL:urlString:

- (ZoomSDKError) setCustomURL:		(SDKURLType)	urlType
urlString:		(NSString *)	urlString

This method is used to set default URL for setting components.

Parameters

urlType

A enum specify the url you want to modify.

Returns

A ZoomSDKError to tell client whether function call successfully or not.

setMuteVideoAndAudioWhenLockScreen:

- (ZoomSDKError) setMuteVideoAndAudioWhenLockScreen:

(BOOL)

enable

Stop my video and audio when my display is off or screen saver begins.

Parameters

enable

YES is means mute video and aodio when lock screen,otherewise not.

Returns

If the function is success will return ZoomSDKError_Success, otherwise fail.

setReactionSkinTone:

- (ZoomSDKError) setReactionSkinTone:

(ZoomSDKEmojiReactionSkinTone)

skinTone

Set the skintone of the reaction.

Parameters

skinTone

The enum of skintone.

Returns

If the function is success will return ZoomSDKError_Success, otherwise fail.

setUIAppearance:

- (ZoomSDKError) setUIAppearance:

(ZoomSDKUIAppearance)

appearance

To set the appearance of ui.

Parameters

appearance

The enum of appearance.

Returns

If the function is success will return ZoomSDKError_Success, otherwise fail.

setUITheme:

- (ZoomSDKError) setUITheme:

(ZoomSDKUITheme)

theme

Set the theme of ui.

Parameters

theme

The enum of theme.

Returns

If the function is success will return ZoomSDKError_Success, otherwise fail.