Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCMeetingSettings.h
Go to the documentation of this file.
1//
2// MobileRTCMeetingSettings.h
3// MobileRTC
4//
5// Created by Zoom Communications on 7/2/15.
6// Copyright (c) Zoom Communications, Inc. All rights reserved.
7//
8
9#import <Foundation/Foundation.h>
10
15@interface MobileRTCMeetingSettings : NSObject
20@property (assign, nonatomic) BOOL meetingTitleHidden;
21
26@property (assign, nonatomic) BOOL meetingPasswordHidden;
27
32@property (assign, nonatomic) BOOL meetingLeaveHidden;
33
38@property (assign, nonatomic) BOOL meetingAudioHidden;
39
44@property (assign, nonatomic) BOOL meetingVideoHidden;
45
50@property (assign, nonatomic) BOOL meetingInviteHidden;
51
56@property (assign, nonatomic) BOOL meetingInviteUrlHidden;
57
62@property (assign, nonatomic) BOOL meetingChatHidden;
63
68@property (assign, nonatomic) BOOL meetingParticipantHidden;
69
74@property (assign, nonatomic) BOOL meetingShareHidden;
75
80@property (assign, nonatomic) BOOL meetingMoreHidden;
81
86@property (assign, nonatomic) BOOL topBarHidden;
87
93@property (assign, nonatomic) BOOL bottomBarHidden;
94
99@property (assign, nonatomic) BOOL disconnectAudioHidden;
100
105@property (assign, nonatomic) BOOL recordButtonHidden;
106
112@property (assign, nonatomic) BOOL thumbnailInShare;
113
118@property (assign, nonatomic) BOOL hostLeaveHidden;
119
124@property (assign, nonatomic) BOOL hintHidden;
125
130@property (assign, nonatomic) BOOL waitingHUDHidden;
131
136@property (assign, nonatomic) BOOL callinRoomSystemHidden;
137
142@property (assign, nonatomic) BOOL calloutRoomSystemHidden;
143
148@property (assign, nonatomic) BOOL claimHostWithHostKeyHidden;
149
154@property (assign, nonatomic) BOOL closeCaptionHidden;
155
160@property (assign, nonatomic) BOOL qaButtonHidden;
161
167@property (assign, nonatomic) BOOL promoteToPanelistHidden;
168
174@property (assign, nonatomic) BOOL changeToAttendeeHidden;
175
180@property (assign, nonatomic) BOOL proximityMonitoringDisable;
181
186@property (assign, nonatomic) BOOL hideRecoverMeetingDialog;
187
192@property (assign, nonatomic) BOOL hideFeedbackButtonOnCloudWhiteboard DEPRECATED_MSG_ATTRIBUTE("Use hideFeedbackButtonOnCloudWhiteboard: in MeetingService instead");
193
198@property (assign, nonatomic) BOOL hideShareButtonOnCloudWhiteboard DEPRECATED_MSG_ATTRIBUTE("Use hideShareButtonOnCloudWhiteboard: in MeetingService instead");
199
204@property (assign, nonatomic) BOOL hideAboutButtonOnCloudWhiteboard DEPRECATED_MSG_ATTRIBUTE("Use hideAboutButtonOnCloudWhiteboard: in MeetingService instead");
205
211
216- (void)setAutoConnectInternetAudio:(BOOL)connected;
217
223
228- (void)setMuteAudioWhenJoinMeeting:(BOOL)muted;
229
235
240- (void)setMuteVideoWhenJoinMeeting:(BOOL)muted;
241
246- (BOOL)faceBeautyEnabled;
247
252- (void)setFaceBeautyEnabled:(BOOL)enable;
253
259
264- (void)enableMirrorEffect:(BOOL)enable;
265
271- (BOOL)driveModeDisabled;
272
278- (void)disableDriveMode:(BOOL)disabled;
279
285- (BOOL)galleryViewDisabled;
286
292- (void)disableGalleryView:(BOOL)disabled;
293
300- (void)disableCloudWhiteboard:(BOOL)disabled DEPRECATED_MSG_ATTRIBUTE("Use disableCloudWhiteboard: in MeetingService instead");
301
307- (BOOL)callInDisabled;
308
314- (void)disableCallIn:(BOOL)disabled;
315
321- (BOOL)callOutDisabled;
322
328- (void)disableCallOut:(BOOL)disabled;
329
336
342- (void)disableMinimizeMeeting:(BOOL)disabled;
343
349
354- (void)disableFreeMeetingUpgradeTips:(BOOL)disabled;
355
362
368- (void)setSpeakerOffWhenInMeeting:(BOOL)speakerOff;
369
376
382- (void)enableShowMyMeetingElapseTime:(BOOL)enable;
383
389
394- (void)enableMicOriginalInput:(BOOL)enable;
395
401
407- (void)hideReactionsOnMeetingUI:(BOOL)hidden;
408
415
421- (void)disableShowVideoPreviewWhenJoinMeeting:(BOOL)disabled;
422
428
433- (void)disableVirtualBackground:(BOOL)disabled;
434
440- (void)prePopulateWebinarRegistrationInfo:(nonnull NSString *)email username:(nonnull NSString *)username;
441
446- (void)setHideRegisterWebinarInfoWindow:(BOOL)hide;
447
453
458- (void)setHideWebinarNameInputWindow:(BOOL)hide;
459
465
472- (BOOL)disableConfidentialWatermark:(BOOL)disable;
473
480
486- (void)disableCopyMeetingUrl:(BOOL)disabled;
487
493- (MobileRTCMeetError)setReactionSkinTone:(MobileRTCEmojiReactionSkinTone)skinTone;
494
501
506- (void)disableClearWebKitCache:(BOOL)disabled;
507
513
519
524- (void)setHideNoVideoUsersEnabled:(BOOL)enabled;
525
529- (void)enableHideSelfView:(BOOL)isHidden;
530
535
540- (void)hideRequestRecordPrivilegeDialog:(BOOL)bHide;
541
546
551- (void)enableGrabShareWithoutReminder:(BOOL)enable;
552
557- (void)setHideMeetingInputUserInfoWindow:(BOOL)hide;
558
564
571
577- (BOOL)enableCenterStageMode:(BOOL)enable;
578
589- (MobileRTCSDKError)enableEchoCancellation:(BOOL)enable;
590
596
602
603
609- (void)setHideConfirmStartArchiveDialog:(BOOL)hide;
610
616
621- (void)enable5GHighBandWidth:(BOOL)enable;
622
627- (void)enableZoomDocs:(BOOL)enable;
628
629@end
MobileRTCMeetError
Enumeration of errors to start/join meeting.
MobileRTCSDKError
Enumeration of SDK error.
MobileRTCEmojiReactionSkinTone
Enumeration of emoji reactions skin tone.
Set to modify the configurations of the meeting.
BOOL isHideConfirmStartArchiveDialog()
Get the confirm start archive dialog whether hide or display.
BOOL proximityMonitoringDisable
Enable/Disable Proximity Sensors Monitoring in a meeting.
BOOL callinRoomSystemHidden
Show/Hide "Call in Room System" item in Invite h.323/SIP Room System.
BOOL meetingParticipantHidden
Show/Hide PARTICIPANT button in the meeting bar.
BOOL callOutDisabled()
Query if it is disabled to call out.
BOOL meetingAudioHidden
Show/Hide AUDIO button in the meeting bar.
BOOL qaButtonHidden
Show/Hide Q&A button in webinar meeting.
BOOL closeCaptionHidden
Show/Hide CLOSE CAPTION in a meeting.
BOOL meetingChatHidden
Show/Hide Chat in the meeting bar.
BOOL recordButtonHidden
Show/Hide record button.
BOOL virtualBackgroundDisabled()
Query if it is disabled for virtual background.
BOOL autoConnectInternetAudio()
Query if the user joins meeting with audio device.
BOOL freeMeetingUpgradeTipsDisabled()
Query if it is disabled free meeting upgrade tips.
BOOL hideShareButtonOnCloudWhiteboard
Hide share button on cloud whiteboard.
BOOL disconnectAudioHidden
Show/Hide disconnect audio button.
BOOL meetingPasswordHidden
Show/Hide meeting password in the meeting bar.
BOOL faceBeautyEnabled()
Query Touch up my appearance enable or not.
BOOL meetingTitleHidden
Show/Hide meeting title in the meeting bar.
BOOL isHideSelfViewEnabled()
Get the flag to enable/disable to hide userself's view.
BOOL galleryViewDisabled()
Query if Gallery View is disabled.
BOOL micOriginalInputEnabled()
Query mic original input enable or not.
BOOL claimHostWithHostKeyHidden
Show/Hide "Enter Host Key to Claim Host" item in Menu More.
BOOL speakerOffWhenInMeeting()
Query Meeting setting of speaker off when present meeting.
BOOL muteAudioWhenJoinMeeting()
Query if user's audio is muted when he joins the meeting.
MobileRTCEmojiReactionSkinTone reactionSkinTone()
Get reaction skin tone.
BOOL isHideMeetingInputUserInfoWindow()
Get the meeting input user info dialog to hide or display.
BOOL waitingHUDHidden
Show/Hide the waiting HUD while starting/joining a meeting.
BOOL meetingInviteHidden
Show/Hide INVITE button in the meeting bar.
BOOL reactionsOnMeetingUIHidden()
Query reactions on MeetingUI is hidden or not.
BOOL videoCallPictureInPictureEnabled()
Get the flag of auto enter Picture-in-Picture Mode for video calls.
BOOL topBarHidden
Show/Hide the BAR ON THE TOP of view in the meeting.
BOOL isEnabledCenterStageMode()
Query if CenterStage Mode is enable by MobileRTC.
BOOL isEchoCancellationOn()
Determine if echo cancellation is enabled or not.
BOOL thumbnailInShare
Change thumbnail video layout while viewing a share in the meeting.
BOOL meetingMoreHidden
Show/Hide MORE button in the meeting bar.
BOOL isSupportEchoCancellation()
Determine if the meeting supports echo cancellation.
BOOL isDisabledClearWebKitCache()
Query if the action of clear WebView's cache be disabled.
BOOL hideRecoverMeetingDialog
Enable or disable hiding the recover meeting dialog in Zoom UI mode.
BOOL isCenterStageModeSupported()
Query if this device supports CenterStage Mode.
BOOL isMirrorEffectEnabled()
Determine if mirror effect is enabled.
BOOL meetingInviteUrlHidden
Show/Hide INVITE link in the meeting info view.
BOOL meetingVideoHidden
Show/Hide VIDEO button in the meeting bar.
BOOL isHideNoVideoUsersEnabled()
Query if the option HIDE NON-VIDEO PARTICIPANTS is enabled.
BOOL showMyMeetingElapseTime()
Query show meeting elapse time.
BOOL hideAboutButtonOnCloudWhiteboard
About button’s visibility on the cloud whiteboard. Default is displaying.
BOOL showVideoPreviewWhenJoinMeetingDisabled()
Query if it is disabled to show video preview when join meeting.
BOOL driveModeDisabled()
Query if driving mode is disabled.
BOOL isHideWebinarNameInputWindow()
Get the webinar username input dialog to hide or display.
BOOL callInDisabled()
Query if it is disabled to call in.
BOOL hideFeedbackButtonOnCloudWhiteboard
Hide feedback button on cloud whiteboard.
BOOL copyMeetingUrlDisabled()
Query if it is disabled for copy meeting url.
BOOL minimizeMeetingDisabled()
Query if it is disabled to Minimize Meeting.
BOOL hideRegisterWebinarInfoWindow()
Get the webinar register information dialog to hide or display.
BOOL muteVideoWhenJoinMeeting()
Query if user's video is muted when he joins the meeting.
BOOL changeToAttendeeHidden
Show/Hide "Change to Attendee" in webinar meeting.
BOOL promoteToPanelistHidden
Show/Hide "Promote to Panelist" in webinar meeting.
BOOL hintHidden
Show/Hide the hint message in the meeting.
BOOL bottomBarHidden
Show/Hide BAR at the bottom of the view in the meeting.
BOOL meetingShareHidden
Show/Hide SHARE button in the meeting bar.
BOOL calloutRoomSystemHidden
Show/Hide "Call out Room System" item in Invite h.323/SIP Room System.
BOOL meetingLeaveHidden
Show/Hide the END/LEAVE MEETING button in the meeting bar.
BOOL hostLeaveHidden
Show/Hide LEAVE MEETING item for the host in the pop up view after click the end/leave meeting button...