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
17@property (assign, nonatomic) BOOL meetingTitleHidden;
18
23@property (assign, nonatomic) BOOL meetingPasswordHidden;
24
29@property (assign, nonatomic) BOOL meetingLeaveHidden;
30
35@property (assign, nonatomic) BOOL meetingAudioHidden;
36
41@property (assign, nonatomic) BOOL meetingVideoHidden;
42
47@property (assign, nonatomic) BOOL meetingInviteHidden;
48
53@property (assign, nonatomic) BOOL meetingInviteUrlHidden;
54
59@property (assign, nonatomic) BOOL meetingChatHidden;
60
65@property (assign, nonatomic) BOOL meetingParticipantHidden;
66
71@property (assign, nonatomic) BOOL meetingShareHidden;
72
77@property (assign, nonatomic) BOOL meetingMoreHidden;
78
83@property (assign, nonatomic) BOOL topBarHidden;
84
90@property (assign, nonatomic) BOOL bottomBarHidden;
91
96@property (assign, nonatomic) BOOL disconnectAudioHidden;
97
102@property (assign, nonatomic) BOOL recordButtonHidden;
103
109@property (assign, nonatomic) BOOL thumbnailInShare;
110
115@property (assign, nonatomic) BOOL hostLeaveHidden;
116
121@property (assign, nonatomic) BOOL hintHidden;
122
127@property (assign, nonatomic) BOOL tipsHidden;
128
133@property (assign, nonatomic) BOOL waitingHUDHidden;
134
139@property (assign, nonatomic) BOOL callinRoomSystemHidden;
140
145@property (assign, nonatomic) BOOL calloutRoomSystemHidden;
146
151@property (assign, nonatomic) BOOL claimHostWithHostKeyHidden;
152
157@property (assign, nonatomic) BOOL closeCaptionHidden;
158
163@property (assign, nonatomic) BOOL qaButtonHidden;
164
170@property (assign, nonatomic) BOOL promoteToPanelistHidden;
171
177@property (assign, nonatomic) BOOL changeToAttendeeHidden;
178
183@property (assign, nonatomic) BOOL proximityMonitoringDisable;
184
189@property (assign, nonatomic) BOOL hideRecoverMeetingDialog;
190
195@property (assign, nonatomic) BOOL hideFeedbackButtonOnCloudWhiteboard DEPRECATED_MSG_ATTRIBUTE("Use hideFeedbackButtonOnCloudWhiteboard: in MeetingService instead");
196
201@property (assign, nonatomic) BOOL hideShareButtonOnCloudWhiteboard DEPRECATED_MSG_ATTRIBUTE("Use hideShareButtonOnCloudWhiteboard: in MeetingService instead");
202
207@property (assign, nonatomic) BOOL hideAboutButtonOnCloudWhiteboard DEPRECATED_MSG_ATTRIBUTE("Use hideAboutButtonOnCloudWhiteboard: in MeetingService instead");
208
214
219- (void)setAutoConnectInternetAudio:(BOOL)connected;
220
226
231- (void)setMuteAudioWhenJoinMeeting:(BOOL)muted;
232
238
243- (void)setMuteVideoWhenJoinMeeting:(BOOL)muted;
244
249- (BOOL)faceBeautyEnabled;
250
255- (void)setFaceBeautyEnabled:(BOOL)enable;
256
262
267- (void)enableMirrorEffect:(BOOL)enable;
268
274- (BOOL)driveModeDisabled;
275
281- (void)disableDriveMode:(BOOL)disabled;
282
288- (BOOL)galleryViewDisabled;
289
295- (void)disableGalleryView:(BOOL)disabled;
296
303- (void)disableCloudWhiteboard:(BOOL)disabled DEPRECATED_MSG_ATTRIBUTE("Use disableCloudWhiteboard: in MeetingService instead");
304
310- (BOOL)callInDisabled;
311
317- (void)disableCallIn:(BOOL)disabled;
318
324- (BOOL)callOutDisabled;
325
331- (void)disableCallOut:(BOOL)disabled;
332
339
345- (void)disableMinimizeMeeting:(BOOL)disabled;
346
352
357- (void)disableFreeMeetingUpgradeTips:(BOOL)disabled;
358
365
371- (void)setSpeakerOffWhenInMeeting:(BOOL)speakerOff;
372
379
385- (void)enableShowMyMeetingElapseTime:(BOOL)enable;
386
392
397- (void)enableMicOriginalInput:(BOOL)enable;
398
405
411- (void)hideReactionsOnMeetingUI:(BOOL)hidden;
412
419
425- (void)disableShowVideoPreviewWhenJoinMeeting:(BOOL)disabled;
426
432
437- (void)disableVirtualBackground:(BOOL)disabled;
438
444- (void)prePopulateWebinarRegistrationInfo:(nonnull NSString *)email username:(nonnull NSString *)username;
445
450- (void)setHideRegisterWebinarInfoWindow:(BOOL)hide;
451
457
462- (void)setHideWebinarNameInputWindow:(BOOL)hide;
463
469
476- (BOOL)disableConfidentialWatermark:(BOOL)disable;
477
484
490- (void)disableCopyMeetingUrl:(BOOL)disabled;
491
498- (MobileRTCMeetError)setReactionSkinTone:(MobileRTCEmojiReactionSkinTone)skinTone;
499
506
511- (void)disableClearWebKitCache:(BOOL)disabled;
512
518
524
529- (void)setHideNoVideoUsersEnabled:(BOOL)enabled;
530
534- (void)enableHideSelfView:(BOOL)isHidden;
535
541
546- (void)hideRequestRecordPrivilegeDialog:(BOOL)bHide;
547
553
558- (void)enableGrabShareWithoutReminder:(BOOL)enable;
559
564- (void)setHideMeetingInputUserInfoWindow:(BOOL)hide;
565
571
578
584- (BOOL)enableCenterStageMode:(BOOL)enable;
585
596- (MobileRTCSDKError)enableEchoCancellation:(BOOL)enable;
597
603
609
610
616- (void)setHideConfirmStartArchiveDialog:(BOOL)hide;
617
623
628- (void)enable5GHighBandWidth:(BOOL)enable;
629
634- (void)enableZoomDocs:(BOOL)enable;
635
636@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 tipsHidden
Show/Hide the tips message in the meeting, tips message is on the bottom of the screen.
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, hint message is on the top bar.
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...