Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCMeetingSettings.h
Go to the documentation of this file.
1
5
6#import <Foundation/Foundation.h>
7
8@protocol MobileRTCMeetingSettingsDelegate;
9
14@interface MobileRTCMeetingSettings : NSObject
15
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 tipsHidden;
131
136@property (assign, nonatomic) BOOL waitingHUDHidden;
137
142@property (assign, nonatomic) BOOL callinRoomSystemHidden;
143
148@property (assign, nonatomic) BOOL calloutRoomSystemHidden;
149
154@property (assign, nonatomic) BOOL claimHostWithHostKeyHidden;
155
160@property (assign, nonatomic) BOOL closeCaptionHidden;
161
166@property (assign, nonatomic) BOOL qaButtonHidden;
167
173@property (assign, nonatomic) BOOL promoteToPanelistHidden;
174
180@property (assign, nonatomic) BOOL changeToAttendeeHidden;
181
186@property (assign, nonatomic) BOOL proximityMonitoringDisable;
187
192@property (assign, nonatomic) BOOL hideRecoverMeetingDialog;
193
198@property (assign, nonatomic) BOOL hideFeedbackButtonOnCloudWhiteboard DEPRECATED_MSG_ATTRIBUTE("Use hideFeedbackButtonOnCloudWhiteboard: in MeetingService instead");
199
204@property (assign, nonatomic) BOOL hideShareButtonOnCloudWhiteboard DEPRECATED_MSG_ATTRIBUTE("Use hideShareButtonOnCloudWhiteboard: in MeetingService instead");
205
210@property (assign, nonatomic) BOOL hideAboutButtonOnCloudWhiteboard DEPRECATED_MSG_ATTRIBUTE("Use hideAboutButtonOnCloudWhiteboard: in MeetingService instead");
211
217
222- (void)setAutoConnectInternetAudio:(BOOL)connected;
223
229
234- (void)setMuteAudioWhenJoinMeeting:(BOOL)muted;
235
241
246- (void)setMuteVideoWhenJoinMeeting:(BOOL)muted;
247
253
258- (void)setFaceBeautyEnabled:(BOOL)enable;
259
265
270- (void)enableMirrorEffect:(BOOL)enable;
271
278
284- (void)disableDriveMode:(BOOL)disabled;
285
292
298- (void)disableGalleryView:(BOOL)disabled;
299
306- (void)disableCloudWhiteboard:(BOOL)disabled DEPRECATED_MSG_ATTRIBUTE("Use disableCloudWhiteboard: in MeetingService instead");
307
314
320- (void)disableCallIn:(BOOL)disabled;
321
328
334- (void)disableCallOut:(BOOL)disabled;
335
342
348- (void)disableMinimizeMeeting:(BOOL)disabled;
349
355
360- (void)disableFreeMeetingUpgradeTips:(BOOL)disabled;
361
368
374- (void)setSpeakerOffWhenInMeeting:(BOOL)speakerOff;
375
382
388- (void)enableShowMyMeetingElapseTime:(BOOL)enable;
389
395
400- (void)enableMicOriginalInput:(BOOL)enable;
401
408
414- (void)hideReactionsOnMeetingUI:(BOOL)hidden;
415
422
428- (void)disableShowVideoPreviewWhenJoinMeeting:(BOOL)disabled;
429
435
440- (void)disableVirtualBackground:(BOOL)disabled;
441
447- (void)prePopulateWebinarRegistrationInfo:(nonnull NSString *)email username:(nonnull NSString *)username;
448
453- (void)setHideRegisterWebinarInfoWindow:(BOOL)hide;
454
460
465- (void)setHideWebinarNameInputWindow:(BOOL)hide;
466
472
479- (BOOL)disableConfidentialWatermark:(BOOL)disable;
480
487
493- (void)disableCopyMeetingUrl:(BOOL)disabled;
494
501- (MobileRTCMeetError)setReactionSkinTone:(MobileRTCEmojiReactionSkinTone)skinTone;
502
509
514- (void)disableClearWebKitCache:(BOOL)disabled;
515
521
527
532- (void)setHideNoVideoUsersEnabled:(BOOL)enabled;
533
538- (void)enableHideSelfView:(BOOL)isHidden;
539
545
550- (void)hideRequestRecordPrivilegeDialog:(BOOL)bHide;
551
557
562- (void)enableGrabShareWithoutReminder:(BOOL)enable;
563
568- (void)setHideMeetingInputUserInfoWindow:(BOOL)hide;
569
575
582
588- (BOOL)enableCenterStageMode:(BOOL)enable;
589
600- (MobileRTCSDKError)enableEchoCancellation:(BOOL)enable;
601
607
613
614
620- (void)setHideConfirmStartArchiveDialog:(BOOL)hide;
621
627
632- (void)enable5GHighBandWidth:(BOOL)enable;
633
638- (void)enableZoomDocs:(BOOL)enable;
639
644- (void)enableShareContentFlashDetection:(BOOL)enable;
645
651
656- (void)setDelegate:(id<MobileRTCMeetingSettingsDelegate> _Nullable)delegate;
657
658@end
MobileRTCMeetError
Enumeration of errors to start/join meeting.
MobileRTCSDKError
Enumeration of the SDK error.
MobileRTCEmojiReactionSkinTone
Enumeration of the emoji reactions skin tone.
A class to modify the configurations of the meeting.
BOOL isHideConfirmStartArchiveDialog()
Gets whether the confirm start archive dialog is hidden or displayed.
BOOL proximityMonitoringDisable
Enables or disables Proximity Sensors Monitoring in a meeting.
BOOL callinRoomSystemHidden
Shows or hides "Call in Room System" item in Invite H.323/SIP Room System.
BOOL meetingParticipantHidden
Shows or hides PARTICIPANT button in the meeting bar.
BOOL callOutDisabled()
Queries if it is disabled to call out.
BOOL meetingAudioHidden
Shows or hides AUDIO button in the meeting bar.
BOOL qaButtonHidden
Shows or hides Q&A button in webinar meeting.
BOOL closeCaptionHidden
Shows or hides CLOSED CAPTION in a meeting.
BOOL meetingChatHidden
Shows or hides Chat in the meeting bar.
BOOL recordButtonHidden
Shows or hides record button.
BOOL virtualBackgroundDisabled()
Queries if it is disabled for virtual background.
BOOL autoConnectInternetAudio()
Queries if the user joins meeting with audio device.
BOOL freeMeetingUpgradeTipsDisabled()
Queries if it is disabled free meeting upgrade tips.
BOOL hideShareButtonOnCloudWhiteboard
Hides share button on cloud whiteboard.
BOOL disconnectAudioHidden
Shows or hides disconnect audio button.
BOOL meetingPasswordHidden
Shows or hides meeting password in the meeting bar.
BOOL faceBeautyEnabled()
Queries if Touch up my appearance is enabled.
BOOL meetingTitleHidden
Shows or hides meeting title in the meeting bar.
BOOL isShareContentFlashDetectionEnabled()
Queries whether automatic dimming of video when sharing content flashes is enabled.
BOOL isHideSelfViewEnabled()
Gets the flag to enable or disable to hide the user's own view.
BOOL galleryViewDisabled()
Queries if Gallery View is disabled.
BOOL micOriginalInputEnabled()
Queries if mic original input is enabled.
BOOL claimHostWithHostKeyHidden
Shows or hides "Enter Host Key to Claim Host" item in Menu More.
BOOL speakerOffWhenInMeeting()
Queries meeting setting of speaker off when present meeting.
BOOL muteAudioWhenJoinMeeting()
Queries if the user's audio is muted when they join the meeting.
MobileRTCEmojiReactionSkinTone reactionSkinTone()
Gets reaction skin tone.
BOOL isHideMeetingInputUserInfoWindow()
Gets whether the meeting input user info dialog is hidden or displayed.
BOOL waitingHUDHidden
Shows or hides the waiting HUD while starting or joining a meeting.
BOOL meetingInviteHidden
Shows or hides INVITE button in the meeting bar.
BOOL reactionsOnMeetingUIHidden()
Queries if reactions on MeetingUI is hidden.
BOOL videoCallPictureInPictureEnabled()
Gets the flag of auto enter Picture-in-Picture Mode for video calls.
BOOL topBarHidden
Shows or hides the bar on the top of view in the meeting.
BOOL isEnabledCenterStageMode()
Queries if CenterStage Mode is enabled by MobileRTC.
BOOL isEchoCancellationOn()
Determines if echo cancellation is enabled.
BOOL thumbnailInShare
YES to change thumbnail video layout while viewing a share in the meeting. Otherwise,...
BOOL meetingMoreHidden
Shows or hides MORE button in the meeting bar.
BOOL isSupportEchoCancellation()
Determines if the meeting supports echo cancellation.
BOOL isDisabledClearWebKitCache()
Queries if the action of clear WebView's cache is disabled.
BOOL tipsHidden
Shows or hides the tips message in the meeting. The tips message is on the bottom of the screen.
BOOL hideRecoverMeetingDialog
Enables or disables hiding the recover meeting dialog in Zoom UI mode.
BOOL isCenterStageModeSupported()
Queries if this device supports CenterStage Mode.
BOOL isMirrorEffectEnabled()
Determines if mirror effect is enabled.
BOOL meetingInviteUrlHidden
Shows or hides INVITE link in the meeting info view.
BOOL meetingVideoHidden
Shows or hides VIDEO button in the meeting bar.
BOOL isHideNoVideoUsersEnabled()
Queries if the option HIDE NON-VIDEO PARTICIPANTS is enabled.
BOOL showMyMeetingElapseTime()
Queries show meeting elapse time.
BOOL hideAboutButtonOnCloudWhiteboard
About button's visibility on the cloud whiteboard. The default is displaying.
BOOL showVideoPreviewWhenJoinMeetingDisabled()
Queries if it is disabled to show video preview when joining meeting.
BOOL driveModeDisabled()
Queries if driving mode is disabled.
BOOL isHideWebinarNameInputWindow()
Gets whether the webinar username input dialog is hidden or displayed.
BOOL callInDisabled()
Queries if it is disabled to call in.
BOOL hideFeedbackButtonOnCloudWhiteboard
Hides feedback button on cloud whiteboard.
BOOL copyMeetingUrlDisabled()
Queries if it is disabled for copy meeting URL.
BOOL minimizeMeetingDisabled()
Queries if it is disabled to Minimize Meeting.
BOOL hideRegisterWebinarInfoWindow()
Gets whether the webinar register information dialog is hidden or displayed.
BOOL muteVideoWhenJoinMeeting()
Queries if the user's video is muted when they join the meeting.
BOOL changeToAttendeeHidden
Shows or hides "Change to Attendee" in webinar meeting.
BOOL promoteToPanelistHidden
Shows or hides "Promote to Panelist" in webinar meeting.
BOOL hintHidden
Shows or hides the hint message in the meeting. The hint message is on the top bar.
BOOL bottomBarHidden
Shows or hides bar at the bottom of the view in the meeting.
BOOL meetingShareHidden
Shows or hides SHARE button in the meeting bar.
BOOL calloutRoomSystemHidden
Shows or hides "Call out Room System" item in Invite H.323/SIP Room System.
BOOL meetingLeaveHidden
Shows or hides the END/LEAVE MEETING button in the meeting bar.
BOOL hostLeaveHidden
Shows or hides LEAVE MEETING item for the host in the pop up view after clicking the end/leave meetin...