MobileRTCMeetingSettings Class Reference

Set to modify the configurations of the meeting. More...

#include <MobileRTCMeetingSettings.h>

Inherits NSObject.

Instance Methods
(BOOL)	- autoConnectInternetAudio
	Query if the user joins meeting with audio device.
(void)	- setAutoConnectInternetAudio:
	Set to auto-connect the audio when user joins meeting.
(BOOL)	- muteAudioWhenJoinMeeting
	Query if user's audio is muted when he joins the meeting.
(void)	- setMuteAudioWhenJoinMeeting:
	Set to mute user's audio when he joins the meeting.
(BOOL)	- muteVideoWhenJoinMeeting
	Query if user's video is muted when he joins the meeting.
(void)	- setMuteVideoWhenJoinMeeting:
	Set to mute user's video when he joins the meeting.
(BOOL)	- faceBeautyEnabled
	Query Touch up my appearance enable or not.
(void)	- setFaceBeautyEnabled:
	Set Touch up my appearance enable or not.
(BOOL)	- isMirrorEffectEnabled
	Determine if mirror effect is enabled.
(void)	- enableMirrorEffect:
	Set to enable/disable mirror effect.
(BOOL)	- driveModeDisabled
	Query if driving mode is disabled.
(void)	- disableDriveMode:
	Set to disable the Driving mode in the meeting.
(BOOL)	- galleryViewDisabled
	Query if Gallery View is disabled.
(void)	- disableGalleryView:
	Set to disable the Gallery View in the meeting.
(void)	- disableCloudWhiteboard:
	Enable or disable the new Zoom Whiteboard feature (different from Classic Whiteboard). This feature enabled by default.
(BOOL)	- callInDisabled
	Query if it is disabled to call in.
(void)	- disableCallIn:
	Set to disable the incoming calls.
(BOOL)	- callOutDisabled
	Query if it is disabled to call out.
(void)	- disableCallOut:
	Set to disable the outgoing calls.
(BOOL)	- minimizeMeetingDisabled
	Query if it is disabled to Minimize Meeting.
(void)	- disableMinimizeMeeting:
	Set to disable the Minimize Meeting.
(BOOL)	- freeMeetingUpgradeTipsDisabled
	Query if it is disabled free meeting upgrade tips.
(void)	- disableFreeMeetingUpgradeTips:
	Set to disable free meeting upgrade tips.
(BOOL)	- speakerOffWhenInMeeting
	Query Meeting setting of speaker off when present meeting.
(void)	- setSpeakerOffWhenInMeeting:
	Set speaker off. Default value is No, Need set to NO when not used.
(BOOL)	- showMyMeetingElapseTime
	Query show meeting elapse time.
(void)	- enableShowMyMeetingElapseTime:
	Enable show meeting elapse time.
(BOOL)	- micOriginalInputEnabled
	Query mic original input enable or not.
(void)	- enableMicOriginalInput:
	Enable mic original input.
(BOOL)	- reactionsOnMeetingUIHidden
	Query reactions on MeetingUI is hidden or not.
(void)	- hideReactionsOnMeetingUI:
	Set the visibility of reaction on meeting UI. Default is displaying.
(BOOL)	- showVideoPreviewWhenJoinMeetingDisabled
	Query if it is disabled to show video preview when join meeting.
(void)	- disableShowVideoPreviewWhenJoinMeeting:
	Set to disable show video preview when join meeting.
(BOOL)	- virtualBackgroundDisabled
	Query if it is disabled for virtual background.
(void)	- disableVirtualBackground:
	Set to disable virtual background.
(void)	- prePopulateWebinarRegistrationInfo:username:
	Pre populate webinar registration info.
(void)	- setHideRegisterWebinarInfoWindow:
	Set the webinar register information dialog to hide or display.
(BOOL)	- hideRegisterWebinarInfoWindow
	Get the webinar register information dialog to hide or display.
(void)	- setHideWebinarNameInputWindow:
	Set the webinar username input dialog to hide or display. if hide webinar user name input dialog, should handle.MobileRTCMeetingServiceDelegate::onWebinarNeedInputScreenName:. inputName: .
(BOOL)	- isHideWebinarNameInputWindow
	Get the webinar username input dialog to hide or display.
(BOOL)	- disableConfidentialWatermark:
	Set to disable confidential watermark.
(BOOL)	- copyMeetingUrlDisabled
	Query if it is disabled for copy meeting url.
(void)	- disableCopyMeetingUrl:
	Set to disable copy meeting url in the meeting info view.
(MobileRTCMeetError)	- setReactionSkinTone:
	Set emoji reaction skin tone.
(MobileRTCEmojiReactionSkinTone)	- reactionSkinTone
	Get reaction skin tone.
(void)	- disableClearWebKitCache:
	Disable the action of clear WebView's cache.
(BOOL)	- isDisabledClearWebKitCache
	Query if the action of clear WebView's cache be disabled.
(BOOL)	- isHideNoVideoUsersEnabled
	Query if the option HIDE NON-VIDEO PARTICIPANTS is enabled.
(void)	- setHideNoVideoUsersEnabled:
	Set whether to enable the option HIDE NON-VIDEO PARTICIPANTS.
(void)	- enableHideSelfView:
	Enable or disable to hide the userself's view. isHidden TRUE indicates to enable to hide the userself's view.
(BOOL)	- isHideSelfViewEnabled
	Get the flag to enable/disable to hide userself's view.
(void)	- hideRequestRecordPrivilegeDialog:
	Set the visibility of request local recording privilege dialog when attendee request local recording privilege. Default is displaying.
(BOOL)	- videoCallPictureInPictureEnabled
	Get the flag of auto enter Picture-in-Picture Mode for video calls.
(void)	- enableGrabShareWithoutReminder:
	Set whether to close the current sharing of another user without prompt and directly beginning a new sharing content by the closer. Default value: FALSE(prompt).
(void)	- setHideMeetingInputUserInfoWindow:
	Set the meeting input user info dialog to hide or display.
(BOOL)	- isHideMeetingInputUserInfoWindow
	Get the meeting input user info dialog to hide or display.
(BOOL)	- isCenterStageModeSupported
	Query if this device supports CenterStage Mode.
(BOOL)	- enableCenterStageMode:
	Enable or disable CenterStage Mode. This is disable by default.
(BOOL)	- isEnabledCenterStageMode
	Query if CenterStage Mode is enable by MobileRTC.
(MobileRTCSDKError)	- enableEchoCancellation:
	Enable echo cancellation.
(BOOL)	- isEchoCancellationOn
	Determine if echo cancellation is enabled or not.
(BOOL)	- isSupportEchoCancellation
	Determine if the meeting supports echo cancellation.
(void)	- setHideConfirmStartArchiveDialog:
	Set the confirm start archive dialog to hide or display.
(BOOL)	- isHideConfirmStartArchiveDialog
	Get the confirm start archive dialog whether hide or display.
(void)	- enable5GHighBandWidth:
	Whether to cancel 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:
	Enable or disable 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:.

Properties
BOOL	meetingTitleHidden
	Show/Hide meeting title in the meeting bar.
BOOL	meetingPasswordHidden
	Show/Hide meeting password in the meeting bar.
BOOL	meetingLeaveHidden
	Show/Hide the END/LEAVE MEETING button in the meeting bar.
BOOL	meetingAudioHidden
	Show/Hide AUDIO button in the meeting bar.
BOOL	meetingVideoHidden
	Show/Hide VIDEO button in the meeting bar.
BOOL	meetingInviteHidden
	Show/Hide INVITE button in the meeting bar.
BOOL	meetingInviteUrlHidden
	Show/Hide INVITE link in the meeting info view.
BOOL	meetingChatHidden
	Show/Hide Chat in the meeting bar.
BOOL	meetingParticipantHidden
	Show/Hide PARTICIPANT button in the meeting bar.
BOOL	meetingShareHidden
	Show/Hide SHARE button in the meeting bar.
BOOL	meetingMoreHidden
	Show/Hide MORE button in the meeting bar.
BOOL	topBarHidden
	Show/Hide the BAR ON THE TOP of view in the meeting.
BOOL	bottomBarHidden
	Show/Hide BAR at the bottom of the view in the meeting.
BOOL	disconnectAudioHidden
	Show/Hide disconnect audio button.
BOOL	recordButtonHidden
	Show/Hide record button.
BOOL	thumbnailInShare
	Change thumbnail video layout while viewing a share in the meeting.
BOOL	hostLeaveHidden
	Show/Hide LEAVE MEETING item for the host in the pop up view after click the end/leave meeting button in the meeting bar.
BOOL	hintHidden
	Show/Hide the hint message in the meeting.
BOOL	waitingHUDHidden
	Show/Hide the waiting HUD while starting/joining a meeting.
BOOL	callinRoomSystemHidden
	Show/Hide "Call in Room System" item in Invite h.323/SIP Room System.
BOOL	calloutRoomSystemHidden
	Show/Hide "Call out Room System" item in Invite h.323/SIP Room System.
BOOL	claimHostWithHostKeyHidden
	Show/Hide "Enter Host Key to Claim Host" item in Menu More.
BOOL	closeCaptionHidden
	Show/Hide CLOSE CAPTION in a meeting.
BOOL	qaButtonHidden
	Show/Hide Q&A button in webinar meeting.
BOOL	promoteToPanelistHidden
	Show/Hide "Promote to Panelist" in webinar meeting.
BOOL	changeToAttendeeHidden
	Show/Hide "Change to Attendee" in webinar meeting.
BOOL	proximityMonitoringDisable
	Enable/Disable Proximity Sensors Monitoring in a meeting.
BOOL	hideRecoverMeetingDialog
	Enable or disable hiding the recover meeting dialog in Zoom UI mode.
BOOL	hideFeedbackButtonOnCloudWhiteboard
	Hide feedback button on cloud whiteboard.
BOOL	hideShareButtonOnCloudWhiteboard
	Hide share button on cloud whiteboard.
BOOL	hideAboutButtonOnCloudWhiteboard
	About button’s visibility on the cloud whiteboard. Default is displaying.

Detailed Description

Set to modify the configurations of the meeting.

Definition at line 15 of file MobileRTCMeetingSettings.h.

Method Documentation

autoConnectInternetAudio

- (BOOL) autoConnectInternetAudio

Query if the user joins meeting with audio device.

Returns

YES means the audio device is automatically connected, otherwise not.

callInDisabled

- (BOOL) callInDisabled

Query if it is disabled to call in.

Returns

YES means disabled, otherwise not.

Warning

The function only in Zoom UI mode.

callOutDisabled

- (BOOL) callOutDisabled

Query if it is disabled to call out.

Returns

YES means disabled, otherwise not.

Warning

The function only in Zoom UI mode.

copyMeetingUrlDisabled

- (BOOL) copyMeetingUrlDisabled

Query if it is disabled for copy meeting url.

Returns

YES means disabled, otherwise not.

Warning

The function only in Zoom UI mode.

disableCallIn:

- (void) disableCallIn:

(BOOL)

disabled

Set to disable the incoming calls.

Parameters

disabled

The option value.

Warning

The function only in Zoom UI mode.

disableCallOut:

- (void) disableCallOut:

(BOOL)

disabled

Set to disable the outgoing calls.

Parameters

disabled

The option value.

Warning

The function only in Zoom UI mode.

disableClearWebKitCache:

- (void) disableClearWebKitCache:

(BOOL)

disabled

Disable the action of clear WebView's cache.

Parameters

disabled

Specify to disable the clear action or not.

disableCloudWhiteboard:

- (void) disableCloudWhiteboard:

(BOOL)

disabled

Enable or disable the new Zoom Whiteboard feature (different from Classic Whiteboard). This feature enabled by default.

Parameters

disabled

YES means disabled, otherwise not.

Warning

The function only in Zoom UI mode.

Deprecated

Use disableCloudWhiteboard: in MeetingService instead.

disableConfidentialWatermark:

- (BOOL) disableConfidentialWatermark:

(BOOL)

disable

Set to disable confidential watermark.

Parameters

disable

The option value.

Returns

YES means confidential watermark is disable, otherwise not.

Warning

The function only in Zoom UI mode.

disableCopyMeetingUrl:

- (void) disableCopyMeetingUrl:

(BOOL)

disabled

Set to disable copy meeting url in the meeting info view.

Parameters

disabled

The option value.

Warning

The function only in Zoom UI mode.

disableDriveMode:

- (void) disableDriveMode:

(BOOL)

disabled

Set to disable the Driving mode in the meeting.

Parameters

disabled

YES means disabled, otherwise not.

Warning

The function only in Zoom UI mode.

disableFreeMeetingUpgradeTips:

- (void) disableFreeMeetingUpgradeTips:

(BOOL)

disabled

Set to disable free meeting upgrade tips.

Parameters

disabled

The option value.

disableGalleryView:

- (void) disableGalleryView:

(BOOL)

disabled

Set to disable the Gallery View in the meeting.

Parameters

disabled

YES means disabled, otherwise not.

Warning

The function only in Zoom UI mode.

disableMinimizeMeeting:

- (void) disableMinimizeMeeting:

(BOOL)

disabled

Set to disable the Minimize Meeting.

Parameters

disabled

The option value.

Warning

The function only in Zoom UI mode.

disableShowVideoPreviewWhenJoinMeeting:

- (void) disableShowVideoPreviewWhenJoinMeeting:

(BOOL)

disabled

Set to disable show video preview when join meeting.

Parameters

disabled

The option value.

Warning

The function only in Zoom UI mode.

disableVirtualBackground:

- (void) disableVirtualBackground:

(BOOL)

disabled

Set to disable virtual background.

Parameters

disabled

The option value.

driveModeDisabled

- (BOOL) driveModeDisabled

Query if driving mode is disabled.

Returns

YES means muted, otherwise not.

Warning

The function only in Zoom UI mode.

enable5GHighBandWidth:

- (void) enable5GHighBandWidth:

(BOOL)

enable

Whether to cancel 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

a boolean flag to set up the behavoir.

enableCenterStageMode:

- (BOOL) enableCenterStageMode:

(BOOL)

enable

Enable or disable CenterStage Mode. This is disable by default.

Parameters

enable

YES means enabled, otherwise not.

Returns

YES means supported, otherwise not.

enableEchoCancellation:

- (MobileRTCSDKError) enableEchoCancellation:

(BOOL)

enable

Enable echo cancellation.

Parameters

enable

true means enabled, false disabled.

Returns

If the function succeeds, the return value is MobileRTCSDKError_Success.

enableGrabShareWithoutReminder:

- (void) enableGrabShareWithoutReminder:

(BOOL)

enable

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

Parameters

enable

YES indicates no prompt. FALSE not.

enableHideSelfView:

- (void) enableHideSelfView:

(BOOL)

isHidden

Enable or disable to hide the userself's view. isHidden TRUE indicates to enable to hide the userself's view.

enableMicOriginalInput:

- (void) enableMicOriginalInput:

(BOOL)

enable

Enable mic original input.

Parameters

enable

YES means enable mic original input, otherwise not.

enableMirrorEffect:

- (void) enableMirrorEffect:

(BOOL)

enable

Set to enable/disable mirror effect.

Parameters

enable

YES means enabled, No disabled.

enableShowMyMeetingElapseTime:

- (void) enableShowMyMeetingElapseTime:

(BOOL)

enable

Enable show meeting elapse time.

Parameters

enable

YES means show meeting elapse time, otherwise not.

Warning

The function only in Zoom UI mode.

enableZoomDocs:

- (void) enableZoomDocs:

(BOOL)

enable

Enable or disable 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

true means enable, otherwise disable.

faceBeautyEnabled

- (BOOL) faceBeautyEnabled

Query Touch up my appearance enable or not.

Returns

Muted YES means enable, otherwise not.

freeMeetingUpgradeTipsDisabled

- (BOOL) freeMeetingUpgradeTipsDisabled

Query if it is disabled free meeting upgrade tips.

Returns

YES means disabled, otherwise not.

galleryViewDisabled

- (BOOL) galleryViewDisabled

Query if Gallery View is disabled.

Returns

YES means muted, otherwise not.

Warning

The function only in Zoom UI mode.

hideReactionsOnMeetingUI:

- (void) hideReactionsOnMeetingUI:

(BOOL)

hidden

Set the visibility of reaction on meeting UI. Default is displaying.

Parameters

hidden

YES means hide reaction emotion.

Warning

The function only in Zoom UI mode.

hideRegisterWebinarInfoWindow

- (BOOL) hideRegisterWebinarInfoWindow

Get the webinar register information dialog to hide or display.

Returns

Boolean value of the setting value.

hideRequestRecordPrivilegeDialog:

- (void) hideRequestRecordPrivilegeDialog:

(BOOL)

bHide

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

Parameters

bHide

YES indicates to display the tab. No not.

isCenterStageModeSupported

- (BOOL) isCenterStageModeSupported

Query if this device supports CenterStage Mode.

Returns

YES means supported, otherwise not.

Warning

Only iPad of os version above 14.5 can using this feature.

isDisabledClearWebKitCache

- (BOOL) isDisabledClearWebKitCache

Query if the action of clear WebView's cache be disabled.

Returns

Action of clear WebView's cache is disabled or not.

isEchoCancellationOn

- (BOOL) isEchoCancellationOn

Determine if echo cancellation is enabled or not.

Returns

YES means supported, otherwise not.

isEnabledCenterStageMode

- (BOOL) isEnabledCenterStageMode

Query if CenterStage Mode is enable by MobileRTC.

Returns

YES indicates enable. Otherwise not.

isHideConfirmStartArchiveDialog

- (BOOL) isHideConfirmStartArchiveDialog

Get the confirm start archive dialog whether hide or display.

Returns

YES means hide, false means display.

isHideMeetingInputUserInfoWindow

- (BOOL) isHideMeetingInputUserInfoWindow

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

Returns

The value of the setting value.

isHideNoVideoUsersEnabled

- (BOOL) isHideNoVideoUsersEnabled

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

Returns

YES means enabled. NO not.

isHideSelfViewEnabled

- (BOOL) isHideSelfViewEnabled

Get the flag to enable/disable to hide userself's view.

isHideWebinarNameInputWindow

- (BOOL) isHideWebinarNameInputWindow

Get the webinar username input dialog to hide or display.

Returns

Value of the setting value.

isMirrorEffectEnabled

- (BOOL) isMirrorEffectEnabled

Determine if mirror effect is enabled.

Returns

YES means enabled, otherwise not.

isSupportEchoCancellation

- (BOOL) isSupportEchoCancellation

Determine if the meeting supports echo cancellation.

Returns

YES means supported, otherwise not. Only using this feature when enabled original sound called: "enableMicOriginalInput:".

micOriginalInputEnabled

- (BOOL) micOriginalInputEnabled

Query mic original input enable or not.

Returns

YES means mic original input enable, otherwise not.

minimizeMeetingDisabled

- (BOOL) minimizeMeetingDisabled

Query if it is disabled to Minimize Meeting.

Returns

YES means disabled, otherwise not.

Warning

The function only in Zoom UI mode.

muteAudioWhenJoinMeeting

- (BOOL) muteAudioWhenJoinMeeting

Query if user's audio is muted when he joins the meeting.

Returns

YES means muted, otherwise not.

muteVideoWhenJoinMeeting

- (BOOL) muteVideoWhenJoinMeeting

Query if user's video is muted when he joins the meeting.

Returns

YES means muted, otherwise not.

prePopulateWebinarRegistrationInfo:username:

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

Pre populate webinar registration info.

Parameters

email	registration email address.
username	registration username.

reactionSkinTone

- (MobileRTCEmojiReactionSkinTone) reactionSkinTone

Get reaction skin tone.

Returns

SkinTone for emoji reaction.

Warning

The function only in Zoom UI mode.

reactionsOnMeetingUIHidden

- (BOOL) reactionsOnMeetingUIHidden

Query reactions on MeetingUI is hidden or not.

Warning

YES means reactions on MeetingUI is hidden, otherwise not.

setAutoConnectInternetAudio:

- (void) setAutoConnectInternetAudio:

(BOOL)

connected

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

Parameters

connected

The option value.

setFaceBeautyEnabled:

- (void) setFaceBeautyEnabled:

(BOOL)

enable

Set Touch up my appearance enable or not.

Parameters

enable

YES means successful, otherwise not.

setHideConfirmStartArchiveDialog:

- (void) setHideConfirmStartArchiveDialog:

(BOOL)

hide

Set the confirm start archive dialog to hide or display.

Parameters

hide	true means hide the dialog. Otherwise, do not hide the dialog.

Warning

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

setHideMeetingInputUserInfoWindow:

- (void) setHideMeetingInputUserInfoWindow:

(BOOL)

hide

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

Parameters

hide	YES means hide the dialog. Otherwise, do not hide the dialog.

setHideNoVideoUsersEnabled:

- (void) setHideNoVideoUsersEnabled:

(BOOL)

enabled

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

Parameters

enabled

YES means enabled. NO not.

setHideRegisterWebinarInfoWindow:

- (void) setHideRegisterWebinarInfoWindow:

(BOOL)

hide

Set the webinar register information dialog to hide or display.

Parameters

hide	Yes means hide the dialog. Otherwise, do not hide the dialog.

setHideWebinarNameInputWindow:

- (void) setHideWebinarNameInputWindow:

(BOOL)

hide

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

Parameters

hide	true means hide the dialog. Otherwise, do not hide the dialog.

setMuteAudioWhenJoinMeeting:

- (void) setMuteAudioWhenJoinMeeting:

(BOOL)

muted

Set to mute user's audio when he joins the meeting.

Parameters

muted

YES means to mute the audio, otherwise not.

setMuteVideoWhenJoinMeeting:

- (void) setMuteVideoWhenJoinMeeting:

(BOOL)

muted

Set to mute user's video when he joins the meeting.

Parameters

muted

YES means to mute the video, otherwise not.

setReactionSkinTone:

- (MobileRTCMeetError) setReactionSkinTone:

(MobileRTCEmojiReactionSkinTone)

skinTone

Set emoji reaction skin tone.

Parameters

skinTone

The reaction skin tone.

Warning

The function only in Zoom UI mode.

setSpeakerOffWhenInMeeting:

- (void) setSpeakerOffWhenInMeeting:

(BOOL)

speakerOff

Set speaker off. Default value is No, Need set to NO when not used.

Parameters

speakerOff

means speaker off, otherwise not.

Warning

The function only in Zoom UI mode.

showMyMeetingElapseTime

- (BOOL) showMyMeetingElapseTime

Query show meeting elapse time.

Returns

YES means show meeting elapse time, otherwise not.

Warning

The function only in Zoom UI mode.

showVideoPreviewWhenJoinMeetingDisabled

- (BOOL) showVideoPreviewWhenJoinMeetingDisabled

Query if it is disabled to show video preview when join meeting.

Returns

YES means disabled, otherwise not.

Warning

The function only in Zoom UI mode.

speakerOffWhenInMeeting

- (BOOL) speakerOffWhenInMeeting

Query Meeting setting of speaker off when present meeting.

Returns

YES means speaker off, otherwise not.

Warning

The function only in Zoom UI mode.

videoCallPictureInPictureEnabled

- (BOOL) videoCallPictureInPictureEnabled

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

virtualBackgroundDisabled

- (BOOL) virtualBackgroundDisabled

Query if it is disabled for virtual background.

Returns

YES means disabled, otherwise not.

Property Documentation

bottomBarHidden

- (BOOL) bottomBarHidden

readwritenonatomicassign

Show/Hide BAR at the bottom of the view in the meeting.

Warning

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

The function only in Zoom UI mode.

Definition at line 93 of file MobileRTCMeetingSettings.h.

callinRoomSystemHidden

- (BOOL) callinRoomSystemHidden

readwritenonatomicassign

Show/Hide "Call in Room System" item in Invite h.323/SIP Room System.

Warning

The function only in Zoom UI mode.

Definition at line 136 of file MobileRTCMeetingSettings.h.

calloutRoomSystemHidden

- (BOOL) calloutRoomSystemHidden

readwritenonatomicassign

Show/Hide "Call out Room System" item in Invite h.323/SIP Room System.

Warning

The function only in Zoom UI mode.

Definition at line 142 of file MobileRTCMeetingSettings.h.

changeToAttendeeHidden

- (BOOL) changeToAttendeeHidden

readwritenonatomicassign

Show/Hide "Change to Attendee" in webinar meeting.

Warning

Only host/co-host can see the option in webinar meeting‘s participants.

The function only in Zoom UI mode.

Definition at line 174 of file MobileRTCMeetingSettings.h.

claimHostWithHostKeyHidden

- (BOOL) claimHostWithHostKeyHidden

readwritenonatomicassign

Show/Hide "Enter Host Key to Claim Host" item in Menu More.

Warning

The function only in Zoom UI mode.

Definition at line 148 of file MobileRTCMeetingSettings.h.

closeCaptionHidden

- (BOOL) closeCaptionHidden

readwritenonatomicassign

Show/Hide CLOSE CAPTION in a meeting.

Warning

The function only in Zoom UI mode.

Definition at line 154 of file MobileRTCMeetingSettings.h.

disconnectAudioHidden

- (BOOL) disconnectAudioHidden

readwritenonatomicassign

Show/Hide disconnect audio button.

Warning

The function only in Zoom UI mode.

Definition at line 99 of file MobileRTCMeetingSettings.h.

hideAboutButtonOnCloudWhiteboard

- (BOOL) hideAboutButtonOnCloudWhiteboard

readwritenonatomicassign

About button’s visibility on the cloud whiteboard. Default is displaying.

Deprecated

Use hideAboutButtonOnCloudWhiteboard: in MeetingService instead.

Definition at line 204 of file MobileRTCMeetingSettings.h.

hideFeedbackButtonOnCloudWhiteboard

- (BOOL) hideFeedbackButtonOnCloudWhiteboard

readwritenonatomicassign

Hide feedback button on cloud whiteboard.

Deprecated

Use hideFeedbackButtonOnCloudWhiteboard: in MeetingService instead.

Definition at line 192 of file MobileRTCMeetingSettings.h.

hideRecoverMeetingDialog

- (BOOL) hideRecoverMeetingDialog

readwritenonatomicassign

Enable or disable hiding the recover meeting dialog in Zoom UI mode.

Warning

The function only in Zoom UI mode.

Definition at line 186 of file MobileRTCMeetingSettings.h.

hideShareButtonOnCloudWhiteboard

- (BOOL) hideShareButtonOnCloudWhiteboard

readwritenonatomicassign

Hide share button on cloud whiteboard.

Deprecated

Use hideShareButtonOnCloudWhiteboard: in MeetingService instead.

Definition at line 198 of file MobileRTCMeetingSettings.h.

hintHidden

- (BOOL) hintHidden

readwritenonatomicassign

Show/Hide the hint message in the meeting.

Warning

The function only in Zoom UI mode.

Definition at line 124 of file MobileRTCMeetingSettings.h.

hostLeaveHidden

- (BOOL) hostLeaveHidden

readwritenonatomicassign

Show/Hide LEAVE MEETING item for the host in the pop up view after click the end/leave meeting button in the meeting bar.

Warning

The function only in Zoom UI mode.

Definition at line 118 of file MobileRTCMeetingSettings.h.

meetingAudioHidden

- (BOOL) meetingAudioHidden

readwritenonatomicassign

Show/Hide AUDIO button in the meeting bar.

Warning

The function only in Zoom UI mode.

Definition at line 38 of file MobileRTCMeetingSettings.h.

meetingChatHidden

- (BOOL) meetingChatHidden

readwritenonatomicassign

Show/Hide Chat in the meeting bar.

Warning

The function only in Zoom UI mode.

Definition at line 62 of file MobileRTCMeetingSettings.h.

meetingInviteHidden

- (BOOL) meetingInviteHidden

readwritenonatomicassign

Show/Hide INVITE button in the meeting bar.

Warning

The function only in Zoom UI mode.

Definition at line 50 of file MobileRTCMeetingSettings.h.

meetingInviteUrlHidden

- (BOOL) meetingInviteUrlHidden

readwritenonatomicassign

Show/Hide INVITE link in the meeting info view.

Warning

The function only in Zoom UI mode.

Definition at line 56 of file MobileRTCMeetingSettings.h.

meetingLeaveHidden

- (BOOL) meetingLeaveHidden

readwritenonatomicassign

Show/Hide the END/LEAVE MEETING button in the meeting bar.

Warning

The function only in Zoom UI mode.

Definition at line 32 of file MobileRTCMeetingSettings.h.

meetingMoreHidden

- (BOOL) meetingMoreHidden

readwritenonatomicassign

Show/Hide MORE button in the meeting bar.

Warning

The function only in Zoom UI mode.

Definition at line 80 of file MobileRTCMeetingSettings.h.

meetingParticipantHidden

- (BOOL) meetingParticipantHidden

readwritenonatomicassign

Show/Hide PARTICIPANT button in the meeting bar.

Warning

The function only in Zoom UI mode.

Definition at line 68 of file MobileRTCMeetingSettings.h.

meetingPasswordHidden

- (BOOL) meetingPasswordHidden

readwritenonatomicassign

Show/Hide meeting password in the meeting bar.

Warning

The function only in Zoom UI mode.

Definition at line 26 of file MobileRTCMeetingSettings.h.

meetingShareHidden

- (BOOL) meetingShareHidden

readwritenonatomicassign

Show/Hide SHARE button in the meeting bar.

Warning

The function only in Zoom UI mode.

Definition at line 74 of file MobileRTCMeetingSettings.h.

meetingTitleHidden

- (BOOL) meetingTitleHidden

readwritenonatomicassign

Show/Hide meeting title in the meeting bar.

Warning

The function only in Zoom UI mode.

Definition at line 20 of file MobileRTCMeetingSettings.h.

meetingVideoHidden

- (BOOL) meetingVideoHidden

readwritenonatomicassign

Show/Hide VIDEO button in the meeting bar.

Warning

The function only in Zoom UI mode.

Definition at line 44 of file MobileRTCMeetingSettings.h.

promoteToPanelistHidden

- (BOOL) promoteToPanelistHidden

readwritenonatomicassign

Show/Hide "Promote to Panelist" in webinar meeting.

Warning

Only host/co-host can see the option in webinar meeting‘s participants.

The function only in Zoom UI mode.

Definition at line 167 of file MobileRTCMeetingSettings.h.

proximityMonitoringDisable

- (BOOL) proximityMonitoringDisable

readwritenonatomicassign

Enable/Disable Proximity Sensors Monitoring in a meeting.

Warning

The function only in Zoom UI mode.

Definition at line 180 of file MobileRTCMeetingSettings.h.

qaButtonHidden

- (BOOL) qaButtonHidden

readwritenonatomicassign

Show/Hide Q&A button in webinar meeting.

Warning

The function only in Zoom UI mode.

Definition at line 160 of file MobileRTCMeetingSettings.h.

recordButtonHidden

- (BOOL) recordButtonHidden

readwritenonatomicassign

Show/Hide record button.

Warning

The function only in Zoom UI mode.

Definition at line 105 of file MobileRTCMeetingSettings.h.

thumbnailInShare

- (BOOL) thumbnailInShare

readwritenonatomicassign

Change thumbnail video layout while viewing a share in the meeting.

Warning

If you set it to YES, the video of attendees will be placed at 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 won't cover the content; if you set to NO, it will show only the video of active speaker and the video will be placed in the bottom right of the screen.

The function only in Zoom UI mode.

Definition at line 112 of file MobileRTCMeetingSettings.h.

topBarHidden

- (BOOL) topBarHidden

readwritenonatomicassign

Show/Hide the BAR ON THE TOP of view in the meeting.

Warning

The function only in Zoom UI mode.

Definition at line 86 of file MobileRTCMeetingSettings.h.

waitingHUDHidden

- (BOOL) waitingHUDHidden

readwritenonatomicassign

Show/Hide the waiting HUD while starting/joining a meeting.

Warning

The function only in Zoom UI mode.

Definition at line 130 of file MobileRTCMeetingSettings.h.