MobileRTCMeetingSettings Class Reference

A class to modify the configurations of the meeting. More...

#include <MobileRTCMeetingSettings.h>

Inherits NSObject.

Instance Methods
(BOOL)	- autoConnectInternetAudio
	Queries if the user joins meeting with audio device.
(void)	- setAutoConnectInternetAudio:
	Sets to auto-connect the audio when the user joins the meeting.
(BOOL)	- muteAudioWhenJoinMeeting
	Queries if the user's audio is muted when they join the meeting.
(void)	- setMuteAudioWhenJoinMeeting:
	Sets to mute the user's audio when they join the meeting.
(BOOL)	- muteVideoWhenJoinMeeting
	Queries if the user's video is muted when they join the meeting.
(void)	- setMuteVideoWhenJoinMeeting:
	Sets to mute the user's video when they join the meeting.
(BOOL)	- faceBeautyEnabled
	Queries if Touch up my appearance is enabled.
(void)	- setFaceBeautyEnabled:
	Enables or disables Touch up my appearance.
(BOOL)	- isMirrorEffectEnabled
	Determines if mirror effect is enabled.
(void)	- enableMirrorEffect:
	Enables or disables mirror effect.
(BOOL)	- driveModeDisabled
	Queries if driving mode is disabled.
(void)	- disableDriveMode:
	Sets to disable the Driving mode in the meeting.
(BOOL)	- galleryViewDisabled
	Queries if Gallery View is disabled.
(void)	- disableGalleryView:
	Sets to disable the Gallery View in the meeting.
(void)	- disableCloudWhiteboard:
	Enables or disables the new Zoom Whiteboard feature (different from Classic Whiteboard). This feature is enabled by default.
(BOOL)	- callInDisabled
	Queries if it is disabled to call in.
(void)	- disableCallIn:
	Sets to disable the incoming calls.
(BOOL)	- callOutDisabled
	Queries if it is disabled to call out.
(void)	- disableCallOut:
	Sets to disable the outgoing calls.
(BOOL)	- minimizeMeetingDisabled
	Queries if it is disabled to Minimize Meeting.
(void)	- disableMinimizeMeeting:
	Sets to disable the Minimize Meeting.
(BOOL)	- freeMeetingUpgradeTipsDisabled
	Queries if it is disabled free meeting upgrade tips.
(void)	- disableFreeMeetingUpgradeTips:
	Sets to disable free meeting upgrade tips.
(BOOL)	- speakerOffWhenInMeeting
	Queries meeting setting of speaker off when present meeting.
(void)	- setSpeakerOffWhenInMeeting:
	Sets speaker off. The default value is NO. Set to NO when not used.
(BOOL)	- showMyMeetingElapseTime
	Queries show meeting elapse time.
(void)	- enableShowMyMeetingElapseTime:
	Enables or disables showing meeting elapse time.
(BOOL)	- micOriginalInputEnabled
	Queries if mic original input is enabled.
(void)	- enableMicOriginalInput:
	Enables or disables mic original input.
(BOOL)	- reactionsOnMeetingUIHidden
	Queries if reactions on MeetingUI is hidden.
(void)	- hideReactionsOnMeetingUI:
	Sets the visibility of reaction on meeting UI. The default is displaying.
(BOOL)	- showVideoPreviewWhenJoinMeetingDisabled
	Queries if it is disabled to show video preview when joining meeting.
(void)	- disableShowVideoPreviewWhenJoinMeeting:
	Sets to disable show video preview when joining meeting.
(BOOL)	- virtualBackgroundDisabled
	Queries if it is disabled for virtual background.
(void)	- disableVirtualBackground:
	Sets to disable virtual background.
(void)	- prePopulateWebinarRegistrationInfo:username:
	Pre-populates webinar registration info.
(void)	- setHideRegisterWebinarInfoWindow:
	Sets the webinar register information dialog to hide or display.
(BOOL)	- hideRegisterWebinarInfoWindow
	Gets whether the webinar register information dialog is hidden or displayed.
(void)	- setHideWebinarNameInputWindow:
	Sets the webinar username input dialog to hide or display. If hide webinar user name input dialog, should handle MobileRTCMeetingServiceDelegate::onWebinarNeedInputScreenName:. inputName: .
(BOOL)	- isHideWebinarNameInputWindow
	Gets whether the webinar username input dialog is hidden or displayed.
(BOOL)	- disableConfidentialWatermark:
	Sets to disable confidential watermark.
(BOOL)	- copyMeetingUrlDisabled
	Queries if it is disabled for copy meeting URL.
(void)	- disableCopyMeetingUrl:
	Sets to disable copy meeting URL in the meeting info view.
(MobileRTCMeetError)	- setReactionSkinTone:
	Sets emoji reaction skin tone.
(MobileRTCEmojiReactionSkinTone)	- reactionSkinTone
	Gets reaction skin tone.
(void)	- disableClearWebKitCache:
	Disables the action of clear WebView's cache.
(BOOL)	- isDisabledClearWebKitCache
	Queries if the action of clear WebView's cache is disabled.
(BOOL)	- isHideNoVideoUsersEnabled
	Queries if the option HIDE NON-VIDEO PARTICIPANTS is enabled.
(void)	- setHideNoVideoUsersEnabled:
	Sets whether to enable the option HIDE NON-VIDEO PARTICIPANTS.
(void)	- enableHideSelfView:
	Enables or disables to hide the user's own view. isHidden YES indicates to enable to hide the user's own view.
(BOOL)	- isHideSelfViewEnabled
	Gets the flag to enable or disable to hide the user's own view.
(void)	- hideRequestRecordPrivilegeDialog:
	Sets the visibility of request local recording privilege dialog when attendee requests local recording privilege. Default is displaying.
(BOOL)	- videoCallPictureInPictureEnabled
	Gets the flag of auto enter Picture-in-Picture Mode for video calls.
(void)	- enableGrabShareWithoutReminder:
	Sets whether to close the current sharing of another user without prompt and directly beginning a new sharing content by the closer. Default value: NO (prompt).
(void)	- setHideMeetingInputUserInfoWindow:
	Sets the meeting input user info dialog to hide or display.
(BOOL)	- isHideMeetingInputUserInfoWindow
	Gets whether the meeting input user info dialog is hidden or displayed.
(BOOL)	- isCenterStageModeSupported
	Queries if this device supports CenterStage Mode.
(BOOL)	- enableCenterStageMode:
	Enables or disables CenterStage Mode. This is disabled by default.
(BOOL)	- isEnabledCenterStageMode
	Queries if CenterStage Mode is enabled by MobileRTC.
(MobileRTCSDKError)	- enableEchoCancellation:
	Enables or disables echo cancellation.
(BOOL)	- isEchoCancellationOn
	Determines if echo cancellation is enabled.
(BOOL)	- isSupportEchoCancellation
	Determines if the meeting supports echo cancellation.
(void)	- setHideConfirmStartArchiveDialog:
	Sets the confirm start archive dialog to hide or display.
(BOOL)	- isHideConfirmStartArchiveDialog
	Gets whether the confirm start archive dialog is hidden or displayed.
(void)	- enable5GHighBandWidth:
	Enables or disables canceling the bandwidth limit. If YES is set, the network bandwidth is no longer limited, and better audio and video quality can be obtained. Bandwidth is not limited by default. If it is a WiFi network, the bandwidth is not limited, and this setting is invalid.
(void)	- enableZoomDocs:
	Enables or disables zoom docs features in custom UI. This can only take effect when MobileRTCSDKInitContext::enableCustomizeMeetingUI is true. This is disabled by default. When you enable this feature, you need to handle the MobileRTCMeetingServiceDelegate::onDocsStatusChanged:, and subscribe the docs share with the MobileRTCMeetingService::showDocByParentViewCtroller:.
(void)	- enableShareContentFlashDetection:
	Enables or disables automatic dimming of video when sharing content flashes. When enabled, the video will be automatically dimmed when the shared content contains flashing elements.
(BOOL)	- isShareContentFlashDetectionEnabled
	Queries whether automatic dimming of video when sharing content flashes is enabled.

Properties
BOOL	meetingTitleHidden
	Shows or hides meeting title in the meeting bar.
BOOL	meetingPasswordHidden
	Shows or hides meeting password in the meeting bar.
BOOL	meetingLeaveHidden
	Shows or hides the END/LEAVE MEETING button in the meeting bar.
BOOL	meetingAudioHidden
	Shows or hides AUDIO button in the meeting bar.
BOOL	meetingVideoHidden
	Shows or hides VIDEO button in the meeting bar.
BOOL	meetingInviteHidden
	Shows or hides INVITE button in the meeting bar.
BOOL	meetingInviteUrlHidden
	Shows or hides INVITE link in the meeting info view.
BOOL	meetingChatHidden
	Shows or hides Chat in the meeting bar.
BOOL	meetingParticipantHidden
	Shows or hides PARTICIPANT button in the meeting bar.
BOOL	meetingShareHidden
	Shows or hides SHARE button in the meeting bar.
BOOL	meetingMoreHidden
	Shows or hides MORE button in the meeting bar.
BOOL	topBarHidden
	Shows or hides the bar on the top of view in the meeting.
BOOL	bottomBarHidden
	Shows or hides bar at the bottom of the view in the meeting.
BOOL	disconnectAudioHidden
	Shows or hides disconnect audio button.
BOOL	recordButtonHidden
	Shows or hides record button.
BOOL	thumbnailInShare
	YES to change thumbnail video layout while viewing a share in the meeting. Otherwise, NO.
BOOL	hostLeaveHidden
	Shows or hides LEAVE MEETING item for the host in the pop up view after clicking the end/leave meeting button in the meeting bar.
BOOL	hintHidden
	Shows or hides the hint message in the meeting. The hint message is on the top bar.
BOOL	tipsHidden
	Shows or hides the tips message in the meeting. The tips message is on the bottom of the screen.
BOOL	waitingHUDHidden
	Shows or hides the waiting HUD while starting or joining a meeting.
BOOL	callinRoomSystemHidden
	Shows or hides "Call in Room System" item in Invite H.323/SIP Room System.
BOOL	calloutRoomSystemHidden
	Shows or hides "Call out Room System" item in Invite H.323/SIP Room System.
BOOL	claimHostWithHostKeyHidden
	Shows or hides "Enter Host Key to Claim Host" item in Menu More.
BOOL	closeCaptionHidden
	Shows or hides CLOSED CAPTION in a meeting.
BOOL	qaButtonHidden
	Shows or hides Q&A button in webinar meeting.
BOOL	promoteToPanelistHidden
	Shows or hides "Promote to Panelist" in webinar meeting.
BOOL	changeToAttendeeHidden
	Shows or hides "Change to Attendee" in webinar meeting.
BOOL	proximityMonitoringDisable
	Enables or disables Proximity Sensors Monitoring in a meeting.
BOOL	hideRecoverMeetingDialog
	Enables or disables hiding the recover meeting dialog in Zoom UI mode.
BOOL	hideFeedbackButtonOnCloudWhiteboard
	Hides feedback button on cloud whiteboard.
BOOL	hideShareButtonOnCloudWhiteboard
	Hides share button on cloud whiteboard.
BOOL	hideAboutButtonOnCloudWhiteboard
	About button's visibility on the cloud whiteboard. The default is displaying.

Detailed Description

A class to modify the configurations of the meeting.

Definition at line 12 of file MobileRTCMeetingSettings.h.

Method Documentation

autoConnectInternetAudio

- (BOOL) autoConnectInternetAudio

Queries if the user joins meeting with audio device.

Returns

YES if the audio device is automatically connected. Otherwise, NO.

callInDisabled

- (BOOL) callInDisabled

Queries if it is disabled to call in.

Returns

YES if disabled. Otherwise, NO.

Warning

This function is only available in Zoom UI mode.

callOutDisabled

- (BOOL) callOutDisabled

Queries if it is disabled to call out.

Returns

YES if disabled. Otherwise, NO.

Warning

This function is only available in Zoom UI mode.

copyMeetingUrlDisabled

- (BOOL) copyMeetingUrlDisabled

Queries if it is disabled for copy meeting URL.

Returns

YES if disabled. Otherwise, NO.

Warning

This function is only available in Zoom UI mode.

disableCallIn:

- (void) disableCallIn:

(BOOL)

disabled

Sets to disable the incoming calls.

Parameters

disabled

The option value.

Warning

This function is only available in Zoom UI mode.

disableCallOut:

- (void) disableCallOut:

(BOOL)

disabled

Sets to disable the outgoing calls.

Parameters

disabled

The option value.

Warning

This function is only available in Zoom UI mode.

disableClearWebKitCache:

- (void) disableClearWebKitCache:

(BOOL)

disabled

Disables the action of clear WebView's cache.

Parameters

disabled

YES to disable the clear action. Otherwise, NO.

disableCloudWhiteboard:

- (void) disableCloudWhiteboard:

(BOOL)

disabled

Enables or disables the new Zoom Whiteboard feature (different from Classic Whiteboard). This feature is enabled by default.

Parameters

disabled

YES to disable. Otherwise, NO.

Warning

This function is only available in Zoom UI mode.

Deprecated

Use disableCloudWhiteboard: in MeetingService instead.

disableConfidentialWatermark:

- (BOOL) disableConfidentialWatermark:

(BOOL)

disable

Sets to disable confidential watermark.

Parameters

disable

The option value.

Returns

YES if confidential watermark is disabled. Otherwise, NO.

Warning

This function is only available in Zoom UI mode.

disableCopyMeetingUrl:

- (void) disableCopyMeetingUrl:

(BOOL)

disabled

Sets to disable copy meeting URL in the meeting info view.

Parameters

disabled

The option value.

Warning

This function is only available in Zoom UI mode.

disableDriveMode:

- (void) disableDriveMode:

(BOOL)

disabled

Sets to disable the Driving mode in the meeting.

Parameters

disabled

YES to disable. Otherwise, NO.

Warning

This function is only available in Zoom UI mode.

disableFreeMeetingUpgradeTips:

- (void) disableFreeMeetingUpgradeTips:

(BOOL)

disabled

Sets to disable free meeting upgrade tips.

Parameters

disabled

The option value.

disableGalleryView:

- (void) disableGalleryView:

(BOOL)

disabled

Sets to disable the Gallery View in the meeting.

Parameters

disabled

YES to disable. Otherwise, NO.

Warning

This function is only available in Zoom UI mode.

disableMinimizeMeeting:

- (void) disableMinimizeMeeting:

(BOOL)

disabled

Sets to disable the Minimize Meeting.

Parameters

disabled

The option value.

Warning

This function is only available in Zoom UI mode.

disableShowVideoPreviewWhenJoinMeeting:

- (void) disableShowVideoPreviewWhenJoinMeeting:

(BOOL)

disabled

Sets to disable show video preview when joining meeting.

Parameters

disabled

The option value.

Warning

This function is only available in Zoom UI mode.

disableVirtualBackground:

- (void) disableVirtualBackground:

(BOOL)

disabled

Sets to disable virtual background.

Parameters

disabled

The option value.

driveModeDisabled

- (BOOL) driveModeDisabled

Queries if driving mode is disabled.

Returns

YES if disabled. Otherwise, NO.

Warning

This function is only available in Zoom UI mode.

enable5GHighBandWidth:

- (void) enable5GHighBandWidth:

(BOOL)

enable

Enables or disables canceling the bandwidth limit. If YES is set, the network bandwidth is no longer limited, and better audio and video quality can be obtained. Bandwidth is not limited by default. If it is a WiFi network, the bandwidth is not limited, and this setting is invalid.

Parameters

enable

YES to enable. Otherwise, NO.

enableCenterStageMode:

- (BOOL) enableCenterStageMode:

(BOOL)

enable

Enables or disables CenterStage Mode. This is disabled by default.

Parameters

enable

YES to enable. Otherwise, NO.

Returns

YES if the function succeeds. Otherwise, NO.

enableEchoCancellation:

- (MobileRTCSDKError) enableEchoCancellation:

(BOOL)

enable

Enables or disables echo cancellation.

Parameters

enable

YES to enable. Otherwise, NO.

Returns

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

enableGrabShareWithoutReminder:

- (void) enableGrabShareWithoutReminder:

(BOOL)

enable

Sets whether to close the current sharing of another user without prompt and directly beginning a new sharing content by the closer. Default value: NO (prompt).

Parameters

enable

YES to indicate no prompt. Otherwise, NO.

enableHideSelfView:

- (void) enableHideSelfView:

(BOOL)

isHidden

Enables or disables to hide the user's own view. isHidden YES indicates to enable to hide the user's own view.

Parameters

isHidden

YES to enable to hide the user's own view. Otherwise, NO.

enableMicOriginalInput:

- (void) enableMicOriginalInput:

(BOOL)

enable

Enables or disables mic original input.

Parameters

enable

YES to enable mic original input. Otherwise, NO.

enableMirrorEffect:

- (void) enableMirrorEffect:

(BOOL)

enable

Enables or disables mirror effect.

Parameters

enable

YES to enable. Otherwise, NO to disable.

enableShareContentFlashDetection:

- (void) enableShareContentFlashDetection:

(BOOL)

enable

Enables or disables automatic dimming of video when sharing content flashes. When enabled, the video will be automatically dimmed when the shared content contains flashing elements.

Parameters

enable

YES to enable automatic dimming. Otherwise, NO.

enableShowMyMeetingElapseTime:

- (void) enableShowMyMeetingElapseTime:

(BOOL)

enable

Enables or disables showing meeting elapse time.

Parameters

enable

YES to show meeting elapse time. Otherwise, NO.

Warning

This function is only available in Zoom UI mode.

enableZoomDocs:

- (void) enableZoomDocs:

(BOOL)

enable

Enables or disables zoom docs features in custom UI. This can only take effect when MobileRTCSDKInitContext::enableCustomizeMeetingUI is true. This is disabled by default. When you enable this feature, you need to handle the MobileRTCMeetingServiceDelegate::onDocsStatusChanged:, and subscribe the docs share with the MobileRTCMeetingService::showDocByParentViewCtroller:.

Parameters

enable

YES to enable. Otherwise, NO.

faceBeautyEnabled

- (BOOL) faceBeautyEnabled

Queries if Touch up my appearance is enabled.

Returns

YES if enabled. Otherwise, NO.

freeMeetingUpgradeTipsDisabled

- (BOOL) freeMeetingUpgradeTipsDisabled

Queries if it is disabled free meeting upgrade tips.

Returns

YES if disabled. Otherwise, NO.

galleryViewDisabled

- (BOOL) galleryViewDisabled

Queries if Gallery View is disabled.

Returns

YES if disabled. Otherwise, NO.

Warning

This function is only available in Zoom UI mode.

hideReactionsOnMeetingUI:

- (void) hideReactionsOnMeetingUI:

(BOOL)

hidden

Sets the visibility of reaction on meeting UI. The default is displaying.

Parameters

hidden

YES to hide reaction emotion. Otherwise, NO.

Warning

This function is only available in Zoom UI mode.

hideRegisterWebinarInfoWindow

- (BOOL) hideRegisterWebinarInfoWindow

Gets whether the webinar register information dialog is hidden or displayed.

Returns

YES if hidden. Otherwise, NO.

hideRequestRecordPrivilegeDialog:

- (void) hideRequestRecordPrivilegeDialog:

(BOOL)

bHide

Sets the visibility of request local recording privilege dialog when attendee requests local recording privilege. Default is displaying.

Parameters

bHide

YES to hide the dialog. Otherwise, NO.

isCenterStageModeSupported

- (BOOL) isCenterStageModeSupported

Queries if this device supports CenterStage Mode.

Returns

YES if supported. Otherwise, NO.

Warning

Only iPad of OS version above 14.5 can use this feature.

isDisabledClearWebKitCache

- (BOOL) isDisabledClearWebKitCache

Queries if the action of clear WebView's cache is disabled.

Returns

YES if the action of clear WebView's cache is disabled. Otherwise, NO.

isEchoCancellationOn

- (BOOL) isEchoCancellationOn

Determines if echo cancellation is enabled.

Returns

YES if enabled. Otherwise, NO.

isEnabledCenterStageMode

- (BOOL) isEnabledCenterStageMode

Queries if CenterStage Mode is enabled by MobileRTC.

Returns

YES if enabled. Otherwise, NO.

isHideConfirmStartArchiveDialog

- (BOOL) isHideConfirmStartArchiveDialog

Gets whether the confirm start archive dialog is hidden or displayed.

Returns

YES if hidden. Otherwise, NO.

isHideMeetingInputUserInfoWindow

- (BOOL) isHideMeetingInputUserInfoWindow

Gets whether the meeting input user info dialog is hidden or displayed.

Returns

YES if hidden. Otherwise, NO.

isHideNoVideoUsersEnabled

- (BOOL) isHideNoVideoUsersEnabled

Queries if the option HIDE NON-VIDEO PARTICIPANTS is enabled.

Returns

YES if enabled. Otherwise, NO.

isHideSelfViewEnabled

- (BOOL) isHideSelfViewEnabled

Gets the flag to enable or disable to hide the user's own view.

Returns

YES if hide self view. Otherwise, NO.

isHideWebinarNameInputWindow

- (BOOL) isHideWebinarNameInputWindow

Gets whether the webinar username input dialog is hidden or displayed.

Returns

YES if hidden. Otherwise, NO.

isMirrorEffectEnabled

- (BOOL) isMirrorEffectEnabled

Determines if mirror effect is enabled.

Returns

YES if enabled. Otherwise, NO.

isShareContentFlashDetectionEnabled

- (BOOL) isShareContentFlashDetectionEnabled

Queries whether automatic dimming of video when sharing content flashes is enabled.

Returns

YES if the feature is enabled. Otherwise, NO.

isSupportEchoCancellation

- (BOOL) isSupportEchoCancellation

Determines if the meeting supports echo cancellation.

Returns

YES if supported. Otherwise, NO. Only use this feature when enabled original sound called: "enableMicOriginalInput:".

micOriginalInputEnabled

- (BOOL) micOriginalInputEnabled

Queries if mic original input is enabled.

Returns

YES if mic original input is enabled. Otherwise, NO.

minimizeMeetingDisabled

- (BOOL) minimizeMeetingDisabled

Queries if it is disabled to Minimize Meeting.

Returns

YES if disabled. Otherwise, NO.

Warning

This function is only available in Zoom UI mode.

muteAudioWhenJoinMeeting

- (BOOL) muteAudioWhenJoinMeeting

Queries if the user's audio is muted when they join the meeting.

Returns

YES if muted. Otherwise, NO.

muteVideoWhenJoinMeeting

- (BOOL) muteVideoWhenJoinMeeting

Queries if the user's video is muted when they join the meeting.

Returns

YES if muted. Otherwise, NO.

prePopulateWebinarRegistrationInfo:username:

- (void) prePopulateWebinarRegistrationInfo:		(nonnull NSString *)	email
username:		(nonnull NSString *)	username

Pre-populates webinar registration info.

Parameters

email	The registration email address.
username	The registration username.

reactionSkinTone

- (MobileRTCEmojiReactionSkinTone) reactionSkinTone

Gets reaction skin tone.

Returns

The skin tone for emoji reaction.

Warning

This function is only available in Zoom UI mode.

reactionsOnMeetingUIHidden

- (BOOL) reactionsOnMeetingUIHidden

Queries if reactions on MeetingUI is hidden.

Returns

YES if reactions on MeetingUI is hidden. Otherwise, NO.

Warning

This function is only available in Zoom UI mode.

setAutoConnectInternetAudio:

- (void) setAutoConnectInternetAudio:

(BOOL)

connected

Sets to auto-connect the audio when the user joins the meeting.

Parameters

connected

The option value.

setFaceBeautyEnabled:

- (void) setFaceBeautyEnabled:

(BOOL)

enable

Enables or disables Touch up my appearance.

Parameters

enable

YES to enable. Otherwise, NO.

setHideConfirmStartArchiveDialog:

- (void) setHideConfirmStartArchiveDialog:

(BOOL)

hide

Sets the confirm start archive dialog to hide or display.

Parameters

hide	YES to hide the dialog. Otherwise, NO.

Warning

If hide confirm start archive dialog when joining meeting, should handle the 'MobileRTCArchiveConfrimHandle'.

setHideMeetingInputUserInfoWindow:

- (void) setHideMeetingInputUserInfoWindow:

(BOOL)

hide

Sets the meeting input user info dialog to hide or display.

Parameters

hide	YES to hide the dialog. Otherwise, NO.

setHideNoVideoUsersEnabled:

- (void) setHideNoVideoUsersEnabled:

(BOOL)

enabled

Sets whether to enable the option HIDE NON-VIDEO PARTICIPANTS.

Parameters

enabled

YES to enable. Otherwise, NO.

setHideRegisterWebinarInfoWindow:

- (void) setHideRegisterWebinarInfoWindow:

(BOOL)

hide

Sets the webinar register information dialog to hide or display.

Parameters

hide	YES to hide the dialog. Otherwise, NO.

setHideWebinarNameInputWindow:

- (void) setHideWebinarNameInputWindow:

(BOOL)

hide

Sets the webinar username input dialog to hide or display. If hide webinar user name input dialog, should handle MobileRTCMeetingServiceDelegate::onWebinarNeedInputScreenName:. inputName: .

Parameters

hide	YES to hide the dialog. Otherwise, NO.

setMuteAudioWhenJoinMeeting:

- (void) setMuteAudioWhenJoinMeeting:

(BOOL)

muted

Sets to mute the user's audio when they join the meeting.

Parameters

muted

YES to mute the audio. Otherwise, NO.

setMuteVideoWhenJoinMeeting:

- (void) setMuteVideoWhenJoinMeeting:

(BOOL)

muted

Sets to mute the user's video when they join the meeting.

Parameters

muted

YES to mute the video. Otherwise, NO.

setReactionSkinTone:

- (MobileRTCMeetError) setReactionSkinTone:

(MobileRTCEmojiReactionSkinTone)

skinTone

Sets emoji reaction skin tone.

Parameters

skinTone

The reaction skin tone.

Returns

If the function succeeds, it will return MobileRTCMeetError_Success. Otherwise the function fails.

Warning

This function is only available in Zoom UI mode.

setSpeakerOffWhenInMeeting:

- (void) setSpeakerOffWhenInMeeting:

(BOOL)

speakerOff

Sets speaker off. The default value is NO. Set to NO when not used.

Parameters

speakerOff

YES to set speaker off. Otherwise, NO.

Warning

This function is only available in Zoom UI mode.

showMyMeetingElapseTime

- (BOOL) showMyMeetingElapseTime

Queries show meeting elapse time.

Returns

YES if show meeting elapse time. Otherwise, NO.

Warning

This function is only available in Zoom UI mode.

showVideoPreviewWhenJoinMeetingDisabled

- (BOOL) showVideoPreviewWhenJoinMeetingDisabled

Queries if it is disabled to show video preview when joining meeting.

Returns

YES if disabled. Otherwise, NO.

Warning

This function is only available in Zoom UI mode.

speakerOffWhenInMeeting

- (BOOL) speakerOffWhenInMeeting

Queries meeting setting of speaker off when present meeting.

Returns

YES if speaker is off. Otherwise, NO.

Warning

This function is only available in Zoom UI mode.

videoCallPictureInPictureEnabled

- (BOOL) videoCallPictureInPictureEnabled

Gets the flag of auto enter Picture-in-Picture Mode for video calls.

Returns

YES if auto enter Picture-in-Picture Mode. Otherwise, NO.

virtualBackgroundDisabled

- (BOOL) virtualBackgroundDisabled

Queries if it is disabled for virtual background.

Returns

YES if disabled. Otherwise, NO.

Property Documentation

bottomBarHidden

- (BOOL) bottomBarHidden

readwritenonatomicassign

Shows or hides bar at the bottom of the view in the meeting.

Warning

The bar at the bottom of the view is available on iPhone.

This function is only available in Zoom UI mode.

Definition at line 91 of file MobileRTCMeetingSettings.h.

callinRoomSystemHidden

- (BOOL) callinRoomSystemHidden

readwritenonatomicassign

Shows or hides "Call in Room System" item in Invite H.323/SIP Room System.

Warning

This function is only available in Zoom UI mode.

Definition at line 140 of file MobileRTCMeetingSettings.h.

calloutRoomSystemHidden

- (BOOL) calloutRoomSystemHidden

readwritenonatomicassign

Shows or hides "Call out Room System" item in Invite H.323/SIP Room System.

Warning

This function is only available in Zoom UI mode.

Definition at line 146 of file MobileRTCMeetingSettings.h.

changeToAttendeeHidden

- (BOOL) changeToAttendeeHidden

readwritenonatomicassign

Shows or hides "Change to Attendee" in webinar meeting.

Warning

Only host or co-host can see the option in webinar meeting's participants.

This function is only available in Zoom UI mode.

Definition at line 178 of file MobileRTCMeetingSettings.h.

claimHostWithHostKeyHidden

- (BOOL) claimHostWithHostKeyHidden

readwritenonatomicassign

Shows or hides "Enter Host Key to Claim Host" item in Menu More.

Warning

This function is only available in Zoom UI mode.

Definition at line 152 of file MobileRTCMeetingSettings.h.

closeCaptionHidden

- (BOOL) closeCaptionHidden

readwritenonatomicassign

Shows or hides CLOSED CAPTION in a meeting.

Warning

This function is only available in Zoom UI mode.

Definition at line 158 of file MobileRTCMeetingSettings.h.

disconnectAudioHidden

- (BOOL) disconnectAudioHidden

readwritenonatomicassign

Shows or hides disconnect audio button.

Warning

This function is only available in Zoom UI mode.

Definition at line 97 of file MobileRTCMeetingSettings.h.

hideAboutButtonOnCloudWhiteboard

- (BOOL) hideAboutButtonOnCloudWhiteboard

readwritenonatomicassign

About button's visibility on the cloud whiteboard. The default is displaying.

Deprecated

Use hideAboutButtonOnCloudWhiteboard: in MeetingService instead.

Definition at line 208 of file MobileRTCMeetingSettings.h.

hideFeedbackButtonOnCloudWhiteboard

- (BOOL) hideFeedbackButtonOnCloudWhiteboard

readwritenonatomicassign

Hides feedback button on cloud whiteboard.

Deprecated

Use hideFeedbackButtonOnCloudWhiteboard: in MeetingService instead.

Definition at line 196 of file MobileRTCMeetingSettings.h.

hideRecoverMeetingDialog

- (BOOL) hideRecoverMeetingDialog

readwritenonatomicassign

Enables or disables hiding the recover meeting dialog in Zoom UI mode.

Warning

This function is only available in Zoom UI mode.

Definition at line 190 of file MobileRTCMeetingSettings.h.

hideShareButtonOnCloudWhiteboard

- (BOOL) hideShareButtonOnCloudWhiteboard

readwritenonatomicassign

Hides share button on cloud whiteboard.

Deprecated

Use hideShareButtonOnCloudWhiteboard: in MeetingService instead.

Definition at line 202 of file MobileRTCMeetingSettings.h.

hintHidden

- (BOOL) hintHidden

readwritenonatomicassign

Shows or hides the hint message in the meeting. The hint message is on the top bar.

Warning

This function is only available in Zoom UI mode.

Definition at line 122 of file MobileRTCMeetingSettings.h.

hostLeaveHidden

- (BOOL) hostLeaveHidden

readwritenonatomicassign

Shows or hides LEAVE MEETING item for the host in the pop up view after clicking the end/leave meeting button in the meeting bar.

Warning

This function is only available in Zoom UI mode.

Definition at line 116 of file MobileRTCMeetingSettings.h.

meetingAudioHidden

- (BOOL) meetingAudioHidden

readwritenonatomicassign

Shows or hides AUDIO button in the meeting bar.

Warning

This function is only available in Zoom UI mode.

Definition at line 36 of file MobileRTCMeetingSettings.h.

meetingChatHidden

- (BOOL) meetingChatHidden

readwritenonatomicassign

Shows or hides Chat in the meeting bar.

Warning

This function is only available in Zoom UI mode.

Definition at line 60 of file MobileRTCMeetingSettings.h.

meetingInviteHidden

- (BOOL) meetingInviteHidden

readwritenonatomicassign

Shows or hides INVITE button in the meeting bar.

Warning

This function is only available in Zoom UI mode.

Definition at line 48 of file MobileRTCMeetingSettings.h.

meetingInviteUrlHidden

- (BOOL) meetingInviteUrlHidden

readwritenonatomicassign

Shows or hides INVITE link in the meeting info view.

Warning

This function is only available in Zoom UI mode.

Definition at line 54 of file MobileRTCMeetingSettings.h.

meetingLeaveHidden

- (BOOL) meetingLeaveHidden

readwritenonatomicassign

Shows or hides the END/LEAVE MEETING button in the meeting bar.

Warning

This function is only available in Zoom UI mode.

Definition at line 30 of file MobileRTCMeetingSettings.h.

meetingMoreHidden

- (BOOL) meetingMoreHidden

readwritenonatomicassign

Shows or hides MORE button in the meeting bar.

Warning

This function is only available in Zoom UI mode.

Definition at line 78 of file MobileRTCMeetingSettings.h.

meetingParticipantHidden

- (BOOL) meetingParticipantHidden

readwritenonatomicassign

Shows or hides PARTICIPANT button in the meeting bar.

Warning

This function is only available in Zoom UI mode.

Definition at line 66 of file MobileRTCMeetingSettings.h.

meetingPasswordHidden

- (BOOL) meetingPasswordHidden

readwritenonatomicassign

Shows or hides meeting password in the meeting bar.

Warning

This function is only available in Zoom UI mode.

Definition at line 24 of file MobileRTCMeetingSettings.h.

meetingShareHidden

- (BOOL) meetingShareHidden

readwritenonatomicassign

Shows or hides SHARE button in the meeting bar.

Warning

This function is only available in Zoom UI mode.

Definition at line 72 of file MobileRTCMeetingSettings.h.

meetingTitleHidden

- (BOOL) meetingTitleHidden

readwritenonatomicassign

Shows or hides meeting title in the meeting bar.

Warning

This function is only available in Zoom UI mode.

Definition at line 18 of file MobileRTCMeetingSettings.h.

meetingVideoHidden

- (BOOL) meetingVideoHidden

readwritenonatomicassign

Shows or hides VIDEO button in the meeting bar.

Warning

This function is only available in Zoom UI mode.

Definition at line 42 of file MobileRTCMeetingSettings.h.

promoteToPanelistHidden

- (BOOL) promoteToPanelistHidden

readwritenonatomicassign

Shows or hides "Promote to Panelist" in webinar meeting.

Warning

Only host or co-host can see the option in webinar meeting's participants.

This function is only available in Zoom UI mode.

Definition at line 171 of file MobileRTCMeetingSettings.h.

proximityMonitoringDisable

- (BOOL) proximityMonitoringDisable

readwritenonatomicassign

Enables or disables Proximity Sensors Monitoring in a meeting.

Warning

This function is only available in Zoom UI mode.

Definition at line 184 of file MobileRTCMeetingSettings.h.

qaButtonHidden

- (BOOL) qaButtonHidden

readwritenonatomicassign

Shows or hides Q&A button in webinar meeting.

Warning

This function is only available in Zoom UI mode.

Definition at line 164 of file MobileRTCMeetingSettings.h.

recordButtonHidden

- (BOOL) recordButtonHidden

readwritenonatomicassign

Shows or hides record button.

Warning

This function is only available in Zoom UI mode.

Definition at line 103 of file MobileRTCMeetingSettings.h.

thumbnailInShare

- (BOOL) thumbnailInShare

readwritenonatomicassign

YES to change thumbnail video layout while viewing a share in the meeting. Otherwise, NO.

Warning

If you set it to YES, the video of attendees will be placed at the right of the landscape (the device screen is oriented horizontally) or the bottom of portrait (the device screen is oriented vertically) apart from the shared content, which means the video will not cover the content. If you set it to NO, it will show only the video of active speaker and the video will be placed in the bottom right of the screen.

This function is only available in Zoom UI mode.

Definition at line 110 of file MobileRTCMeetingSettings.h.

tipsHidden

- (BOOL) tipsHidden

readwritenonatomicassign

Shows or hides the tips message in the meeting. The tips message is on the bottom of the screen.

Warning

This function is only available in Zoom UI mode.

Definition at line 128 of file MobileRTCMeetingSettings.h.

topBarHidden

- (BOOL) topBarHidden

readwritenonatomicassign

Shows or hides the bar on the top of view in the meeting.

Warning

This function is only available in Zoom UI mode.

Definition at line 84 of file MobileRTCMeetingSettings.h.

waitingHUDHidden

- (BOOL) waitingHUDHidden

readwritenonatomicassign

Shows or hides the waiting HUD while starting or joining a meeting.

Warning

This function is only available in Zoom UI mode.

Definition at line 134 of file MobileRTCMeetingSettings.h.