ZoomSDKGeneralSetting Class Reference

Inheritance diagram for ZoomSDKGeneralSetting:

Instance Methods
(ZoomSDKError)	- enableMeetingSetting:SettingCmd:
	Enable or disable meeting settings by command. More...
(ZoomSDKError)	- setCustomInviteURL:
	Set custom link for invitation. More...
(ZoomSDKError)	- setCustomFeedbackURL:
	Custom support URL. More...
(void)	- hideSettingComponent:hide:
	Hide setting components. More...
(ZoomSDKError)	- setCustomURL:urlString:
	This method is used to set default URL for setting components. More...
(ZoomSDKError)	- enableSetShareScreen:SettingCmd:
	Enable or disable meeting settings by command. More...
(BOOL)	- isEnableToSettingShare:
	Get the setting item current status. More...
(BOOL)	- isShowLockMeetingTime
	Get the current status of show meeting time. More...
(ZoomSDKError)	- enableToShowMeetingTime:
	Enable or disenable to set show meeting time. More...
(int)	- getLimitFPSValue
	get current FPS value More...
(ZoomSDKError)	- setLimitFPSValue:
	set the value of fps limit More...
(ZoomSDKError)	- setLimitedFPSValue:
(BOOL)	- isEnableToSetLimitFPS
	Enable to set limited fps. More...
(ZoomSDKError)	- setEnableLimitFPS:
	Enable or disenable to set Limit fps value. More...
(BOOL)	- isEnableCopyInviteURL
	Determine if can copy invite url after start meeting. More...
(ZoomSDKError)	- setCopyMeetingInviteURL:
	to set meeting invite url can copy More...
(BOOL)	- isEnableConfirmLeavingMeeting
	Determine if can comfire when leaving meeting. More...
(ZoomSDKError)	- setConfirmLeavingMeeting:
	to set confirm when user leaving meeting More...
(ZoomSDKError)	- setUIAppearance:
	to set the appearebce of ui. More...

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.

enableSetShareScreen:SettingCmd:

- (ZoomSDKError) enableSetShareScreen:		(BOOL)	enable
SettingCmd:		(shareSettingCmd)	shareCmd

Enable or disable meeting settings by command.

Parameters

Enable	YES means to enable, otherwise not.
ShareCmd	is a enumeration to set different share screen

Returns

If the function is success will return ZoomSDKError_Success.othereise 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.othereise fail

getLimitFPSValue

- (int) getLimitFPSValue

get current FPS value

Returns

the fps value

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.

Returns

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

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.

isEnableToSetLimitFPS

- (BOOL) isEnableToSetLimitFPS

Enable to set limited fps.

Returns

Return YES is enable otherwise is not

isEnableToSettingShare:

- (BOOL) isEnableToSettingShare:

(shareSettingCmd)

sharingCmd

Get the setting item current status.

Parameters

SharingCmd

is a enumeration

Returns

If return YES is enable otherwise is not enable

isShowLockMeetingTime

- (BOOL) isShowLockMeetingTime

Get the current status of show meeting time.

Returns

If return Yes is means show meeting time

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, othereise 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.othereise 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.

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.

setEnableLimitFPS:

- (ZoomSDKError) setEnableLimitFPS:

(BOOL)

enable

Enable or disenable to set Limit fps value.

Parameters

enable

Yes means to set otherwise is not

setLimitFPSValue:

- (ZoomSDKError) setLimitFPSValue:		(4.)	4
		(4.4)	NS_DEPRECATED_MAC

set the value of fps limit

Parameters

value

is a number of user to set

setUIAppearance:

- (ZoomSDKError) setUIAppearance:

(ZoomSDKUIAppearance)

appearance

to set the appearebce of ui.

Parameters

appearance

The enum of appearance.

Returns

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

---

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

• ZoomSDKSettingService.h