Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCMeetingSettings.h
Go to the documentation of this file.
1
6#import <Foundation/Foundation.h>
7
12@interface MobileRTCMeetingSettings : NSObject
13
18@property (assign, nonatomic) BOOL meetingTitleHidden;
19
24@property (assign, nonatomic) BOOL meetingPasswordHidden;
25
30@property (assign, nonatomic) BOOL meetingLeaveHidden;
31
36@property (assign, nonatomic) BOOL meetingAudioHidden;
37
42@property (assign, nonatomic) BOOL meetingVideoHidden;
43
48@property (assign, nonatomic) BOOL meetingInviteHidden;
49
54@property (assign, nonatomic) BOOL meetingInviteUrlHidden;
55
60@property (assign, nonatomic) BOOL meetingChatHidden;
61
66@property (assign, nonatomic) BOOL meetingParticipantHidden;
67
72@property (assign, nonatomic) BOOL meetingShareHidden;
73
78@property (assign, nonatomic) BOOL meetingMoreHidden;
79
84@property (assign, nonatomic) BOOL topBarHidden;
85
91@property (assign, nonatomic) BOOL bottomBarHidden;
92
97@property (assign, nonatomic) BOOL disconnectAudioHidden;
98
103@property (assign, nonatomic) BOOL recordButtonHidden;
104
110@property (assign, nonatomic) BOOL thumbnailInShare;
111
116@property (assign, nonatomic) BOOL hostLeaveHidden;
117
122@property (assign, nonatomic) BOOL hintHidden;
123
128@property (assign, nonatomic) BOOL tipsHidden;
129
134@property (assign, nonatomic) BOOL waitingHUDHidden;
135
140@property (assign, nonatomic) BOOL callinRoomSystemHidden;
141
146@property (assign, nonatomic) BOOL calloutRoomSystemHidden;
147
152@property (assign, nonatomic) BOOL claimHostWithHostKeyHidden;
153
158@property (assign, nonatomic) BOOL closeCaptionHidden;
159
164@property (assign, nonatomic) BOOL qaButtonHidden;
165
171@property (assign, nonatomic) BOOL promoteToPanelistHidden;
172
178@property (assign, nonatomic) BOOL changeToAttendeeHidden;
179
184@property (assign, nonatomic) BOOL proximityMonitoringDisable;
185
190@property (assign, nonatomic) BOOL hideRecoverMeetingDialog;
191
196@property (assign, nonatomic) BOOL hideFeedbackButtonOnCloudWhiteboard DEPRECATED_MSG_ATTRIBUTE("Use hideFeedbackButtonOnCloudWhiteboard: in MeetingService instead");
197
202@property (assign, nonatomic) BOOL hideShareButtonOnCloudWhiteboard DEPRECATED_MSG_ATTRIBUTE("Use hideShareButtonOnCloudWhiteboard: in MeetingService instead");
203
208@property (assign, nonatomic) BOOL hideAboutButtonOnCloudWhiteboard DEPRECATED_MSG_ATTRIBUTE("Use hideAboutButtonOnCloudWhiteboard: in MeetingService instead");
209
215
220- (void)setAutoConnectInternetAudio:(BOOL)connected;
221
227
232- (void)setMuteAudioWhenJoinMeeting:(BOOL)muted;
233
239
244- (void)setMuteVideoWhenJoinMeeting:(BOOL)muted;
245
250- (BOOL)faceBeautyEnabled;
251
256- (void)setFaceBeautyEnabled:(BOOL)enable;
257
263
268- (void)enableMirrorEffect:(BOOL)enable;
269
275- (BOOL)driveModeDisabled;
276
282- (void)disableDriveMode:(BOOL)disabled;
283
289- (BOOL)galleryViewDisabled;
290
296- (void)disableGalleryView:(BOOL)disabled;
297
304- (void)disableCloudWhiteboard:(BOOL)disabled DEPRECATED_MSG_ATTRIBUTE("Use disableCloudWhiteboard: in MeetingService instead");
305
311- (BOOL)callInDisabled;
312
318- (void)disableCallIn:(BOOL)disabled;
319
325- (BOOL)callOutDisabled;
326
332- (void)disableCallOut:(BOOL)disabled;
333
340
346- (void)disableMinimizeMeeting:(BOOL)disabled;
347
353
358- (void)disableFreeMeetingUpgradeTips:(BOOL)disabled;
359
366
372- (void)setSpeakerOffWhenInMeeting:(BOOL)speakerOff;
373
380
386- (void)enableShowMyMeetingElapseTime:(BOOL)enable;
387
393
398- (void)enableMicOriginalInput:(BOOL)enable;
399
406
412- (void)hideReactionsOnMeetingUI:(BOOL)hidden;
413
420
426- (void)disableShowVideoPreviewWhenJoinMeeting:(BOOL)disabled;
427
433
438- (void)disableVirtualBackground:(BOOL)disabled;
439
445- (void)prePopulateWebinarRegistrationInfo:(nonnull NSString *)email username:(nonnull NSString *)username;
446
451- (void)setHideRegisterWebinarInfoWindow:(BOOL)hide;
452
458
463- (void)setHideWebinarNameInputWindow:(BOOL)hide;
464
470
477- (BOOL)disableConfidentialWatermark:(BOOL)disable;
478
485
491- (void)disableCopyMeetingUrl:(BOOL)disabled;
492
499- (MobileRTCMeetError)setReactionSkinTone:(MobileRTCEmojiReactionSkinTone)skinTone;
500
507
512- (void)disableClearWebKitCache:(BOOL)disabled;
513
519
525
530- (void)setHideNoVideoUsersEnabled:(BOOL)enabled;
531
536- (void)enableHideSelfView:(BOOL)isHidden;
537
543
548- (void)hideRequestRecordPrivilegeDialog:(BOOL)bHide;
549
555
560- (void)enableGrabShareWithoutReminder:(BOOL)enable;
561
566- (void)setHideMeetingInputUserInfoWindow:(BOOL)hide;
567
573
580
586- (BOOL)enableCenterStageMode:(BOOL)enable;
587
598- (MobileRTCSDKError)enableEchoCancellation:(BOOL)enable;
599
605
611
612
618- (void)setHideConfirmStartArchiveDialog:(BOOL)hide;
619
625
630- (void)enable5GHighBandWidth:(BOOL)enable;
631
636- (void)enableZoomDocs:(BOOL)enable;
637
642- (void)enableShareContentFlashDetection:(BOOL)enable;
643
649
650
651@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...