ZoomSDKGeneralSetting Class Reference

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

#include <ZoomSDKSettingService.h>

Inherits NSObject.

Instance Methods
(ZoomSDKError)	- enableMeetingSetting:SettingCmd:
	Enables or disable meeting settings by command.
(ZoomSDKError)	- setCustomInviteURL:
	Sets custom link for invitation.
(ZoomSDKError)	- setCustomFeedbackURL:
	Custom support URL.
(void)	- hideSettingComponent:hide:
	Hides setting components.
(ZoomSDKError)	- setCustomURL:urlString:
	Sets default URL for setting components.
(BOOL)	- isShowLockMeetingTime
	Gets the current status of show meeting time.
(ZoomSDKError)	- enableToShowMeetingTime:
	Enables or disenable to set show meeting time.
(BOOL)	- isEnableCopyInviteURL
	Determines if can copy invite url after start meeting.
(ZoomSDKError)	- setCopyMeetingInviteURL:
	To set meeting invite url can copy.
(BOOL)	- isEnableConfirmLeavingMeeting
	Determines 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
	Gets the UI appearance type.
(BOOL)	- isSupportSetUITheme
	Determines if support set ui theme.
(ZoomSDKError)	- setUITheme:
	Sets the theme of ui.
(ZoomSDKUITheme)	- getUITheme
	Query the theme of ui.
(ZoomSDKError)	- setMuteVideoAndAudioWhenLockScreen:
	Stops my video and audio when my display is off or screen saver begins.
(BOOL)	- isMutedVideoAndAudioWhenLockScreen
	Determines if mute video and aodio when lock screen.
(ZoomSDKError)	- setReactionSkinTone:
	Sets the reaction's skintone.
(ZoomSDKEmojiReactionSkinTone)	- getReactionSkinTone
	Gets the reaction's skintone.
(ZoomSDKError)	- hideAutoCopyInviteLinkCheckBox:
	Hides checkbox of automatically copy invite link when meeting start.
(ZoomSDKError)	- enableMuteOnEntry:allowUnmuteBySelf:
	Mute attendees when they join the meeting.
(ZoomSDKWallpaperController *)	- getWallpaperController
	Gets 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

Enables or disable meeting settings by command.

Parameters

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

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

enableMuteOnEntry:allowUnmuteBySelf:

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

Mute attendees when they join the meeting.

Parameters

bEnable	YES if attendees join the meeting is muted, NO otherwise.
allow	YES if attendee can unmute self, NO otherwise.

Returns

If the function is success returns ZoomSDKError_Success. Otherwise, this function returns an error.

enableToShowMeetingTime:

- (ZoomSDKError) enableToShowMeetingTime:

(BOOL)

enable

Enables or disenable to set show meeting time.

Parameters

enable

YES means show meeting time otherwise is hidden

Returns

If the function is success returns ZoomSDKError_Success. Otherwise, this function returns an error.

getReactionSkinTone

- (ZoomSDKEmojiReactionSkinTone) getReactionSkinTone

Gets the reaction's skintone.

Returns

The current's value reaction skintone.

getUIAppearance

- (ZoomSDKUIAppearance) getUIAppearance

Gets the UI appearance type.

Returns

The UI appearance type.

getUITheme

- (ZoomSDKUITheme) getUITheme

Query the theme of ui.

Returns

The theme of ui.

getWallpaperController

- (ZoomSDKWallpaperController *) getWallpaperController

Gets the object of set wallpaper controller.

Returns

If the function succeeds, it returns a ZoomSDKWallpaperController object. Otherwise, this function fails and returns nil.

hideAutoCopyInviteLinkCheckBox:

- (ZoomSDKError) hideAutoCopyInviteLinkCheckBox:

(BOOL)

hide

Hides checkbox of automatically copy invite link when meeting start.

Parameters

hide	YES to hide the checkbox, NO otherwise.

Returns

If the function is success returns ZoomSDKError_Success. Otherwise, this function returns an error.

hideSettingComponent:hide:

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

Hides setting components.

Parameters

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

isEnableConfirmLeavingMeeting

- (BOOL) isEnableConfirmLeavingMeeting

Determines if can comfire when leaving meeting.

Returns

YES if enabled. Otherwise, NO.

isEnableCopyInviteURL

- (BOOL) isEnableCopyInviteURL

Determines if can copy invite url after start meeting.

Returns

YES if enabled. Otherwise, NO.

isMutedVideoAndAudioWhenLockScreen

- (BOOL) isMutedVideoAndAudioWhenLockScreen

Determines if mute video and aodio when lock screen.

Returns

YES if enabled. Otherwise, NO.

isShowLockMeetingTime

- (BOOL) isShowLockMeetingTime

Gets the current status of show meeting time.

Returns

Yes is means show meeting time. Otherwise, NO.

isSupportSetUITheme

- (BOOL) isSupportSetUITheme

Determines if support set ui theme.

Returns

If support, it returns YES. Otherwise, NO.

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 returns ZoomSDKError_Success. Otherwise, this function returns an error.

setCopyMeetingInviteURL:

- (ZoomSDKError) setCopyMeetingInviteURL:

(BOOL)

enable

To set meeting invite url can copy.

Parameters

enable

YES if can copy, NO otherwise.

Returns

If the function is success returns ZoomSDKError_Success. Otherwise, this function returns an error.

setCustomFeedbackURL:

- (ZoomSDKError) setCustomFeedbackURL:

(NSString *)

feedbackURL

Custom support URL.

Parameters

feedbackURL

Support URL.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Deprecated

This method is no longer used.

setCustomInviteURL:

- (ZoomSDKError) setCustomInviteURL:

(NSString *)

inviteURL

Sets custom link for invitation.

Parameters

inviteURL

The URL for invitation by which user can join meeting.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

setCustomURL:urlString:

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

Sets default URL for setting components.

Parameters

urlType

A enum specify the url you want to modify.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

setMuteVideoAndAudioWhenLockScreen:

- (ZoomSDKError) setMuteVideoAndAudioWhenLockScreen:

(BOOL)

enable

Stops 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, NO otherwise.

Returns

If the function is success returns ZoomSDKError_Success. Otherwise, this function returns an error.

setReactionSkinTone:

- (ZoomSDKError) setReactionSkinTone:

(ZoomSDKEmojiReactionSkinTone)

skinTone

Sets the reaction's skintone.

Parameters

skinTone

The enum of skintone.

Returns

If the function is success returns ZoomSDKError_Success. Otherwise, this function returns an error.

setUIAppearance:

- (ZoomSDKError) setUIAppearance:

(ZoomSDKUIAppearance)

appearance

To set the appearance of ui.

Parameters

appearance

The enum of appearance.

Returns

If the function is success returns ZoomSDKError_Success. Otherwise, this function returns an error.

setUITheme:

- (ZoomSDKError) setUITheme:

(ZoomSDKUITheme)

theme

Sets the theme of ui.

Parameters

theme

The enum of theme.

Returns

If the function is success returns ZoomSDKError_Success. Otherwise, this function returns an error.