iOS SDK API Reference
|
Set to modify the configurations of the meeting. More...
#import <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. | |
(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: |
(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. | |
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 | enableKubi |
Enable/Disable Kubi Device in the meeting. | |
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 | enableCustomMeeting |
Enable Custom In-Meeting UI in meeting. | |
BOOL | hideFeedbackButtonOnCloudWhiteboard |
hide feedback button on cloud whiteboard. | |
BOOL | hideShareButtonOnCloudWhiteboard |
hide share button on cloud whiteboard. | |
Set to modify the configurations of the meeting.
Definition at line 15 of file MobileRTCMeetingSettings.h.
- (BOOL) autoConnectInternetAudio |
Query if the user joins meeting with audio device.
- (BOOL) callInDisabled |
Query if it is disabled to call in.
- (BOOL) callOutDisabled |
Query if it is disabled to call out.
- (BOOL) copyMeetingUrlDisabled |
Query if it is disabled for copy meeting url.
- (void) disableCallIn: | (BOOL) | disabled |
Set to disable the incoming calls.
disabled | The option value. |
- (void) disableCallOut: | (BOOL) | disabled |
Set to disable the outgoing calls.
disabled | The option value. |
- (void) disableClearWebKitCache: | (BOOL) | disabled |
Disable the action of clear WebView's cache.
disabled | Specify to disable the clear action or not. |
- (void) disableCloudWhiteboard: | (BOOL) | disabled |
Enable or disable the new Zoom Whiteboard feature (different from Classic Whiteboard). This feature enabled by default.
disabled | YES means disabled, otherwise not. |
- (BOOL) disableConfidentialWatermark: | (BOOL) | disable |
Set to disable confidential watermark.
disabled | The option value. |
- (void) disableCopyMeetingUrl: | (BOOL) | disabled |
Set to disable copy meeting url in the meeting info view.
disabled | The option value. |
- (void) disableDriveMode: | (BOOL) | disabled |
Set to disable the Driving mode in the meeting.
disabled | YES means disabled, otherwise not. |
- (void) disableFreeMeetingUpgradeTips: | (BOOL) | disabled |
Set to disable free meeting upgrade tips.
disabled | The option value. |
- (void) disableGalleryView: | (BOOL) | disabled |
Set to disable the Gallery View in the meeting.
disabled | YES means disabled, otherwise not. |
- (void) disableMinimizeMeeting: | (BOOL) | disabled |
Set to disable the Minimize Meeting.
disabled | The option value. |
- (void) disableShowVideoPreviewWhenJoinMeeting: | (BOOL) | disabled |
Set to disable show video preview when join meeting.
disabled | The option value. |
- (void) disableVirtualBackground: | (BOOL) | disabled |
Set to disable virtual background.
disabled | The option value. |
- (BOOL) driveModeDisabled |
Query if driving mode is disabled.
- (void) enableHideSelfView: | (BOOL) | isHidden |
- (void) enableMicOriginalInput: | (BOOL) | enable |
Enable mic original input.
enable | YES means enable mic original input, otherwise not. |
- (void) enableMirrorEffect: | (BOOL) | enable |
Set to enable/disable mirror effect.
enable | YES means enabled, No disabled. |
- (void) enableShowMyMeetingElapseTime: | (BOOL) | enable |
Enable show meeting elapse time.
enable | YES means show meeting elapse time, otherwise not. |
- (BOOL) faceBeautyEnabled |
Query Touch up my appearance enable or not.
- (BOOL) freeMeetingUpgradeTipsDisabled |
Query if it is disabled free meeting upgrade tips.
- (BOOL) galleryViewDisabled |
Query if Gallery View is disabled.
- (void) hideReactionsOnMeetingUI: | (BOOL) | hidden |
Set the visibility of reaction on meeting UI. Default is displaying.
hidden | YES means hide reaction emotion. |
- (void) hideRequestRecordPrivilegeDialog: | (BOOL) | bHide |
Set the visibility of request local recording privilege dialog when attendee request local recording privilege. Default is displaying.
bHide | YES indicates to display the tab. No not. |
- (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.
- (BOOL) isHideSelfViewEnabled |
Get the flag to enable/disable to hide userself's view.
- (BOOL) isMirrorEffectEnabled |
Determine if mirror effect is enabled.
- (BOOL) micOriginalInputEnabled |
Query mic original input enable or not.
- (BOOL) minimizeMeetingDisabled |
Query if it is disabled to Minimize Meeting.
- (BOOL) muteAudioWhenJoinMeeting |
Query if user's audio is muted when he joins the meeting.
- (BOOL) muteVideoWhenJoinMeeting |
Query if user's video is muted when he joins the meeting.
- (void) prePopulateWebinarRegistrationInfo: | (nonnull NSString *) | ||
username: | (nonnull NSString *) | username | |
pre populate webinar registration info.
registration email address. | |
username | registration username. |
- (MobileRTCEmojiReactionSkinTone) reactionSkinTone |
Get reaction skin tone.
- (BOOL) reactionsOnMeetingUIHidden |
Query reactions on MeetingUI is hidden or not.
- (void) setAutoConnectInternetAudio: | (BOOL) | connected |
Set to auto-connect the audio when user joins meeting.
connected | The option value. |
- (void) setFaceBeautyEnabled: | (BOOL) | enable |
Set Touch up my appearance enable or not.
muted | YES means successful, otherwise not. |
- (void) setHideNoVideoUsersEnabled: | (BOOL) | enabled |
Set whether to enable the option HIDE NON-VIDEO PARTICIPANTS.
enabled | YES means enabled. NO not. |
- (void) setMuteAudioWhenJoinMeeting: | (BOOL) | muted |
Set to mute user's audio when he joins the meeting.
muted | YES means to mute the audio, otherwise not. |
- (void) setMuteVideoWhenJoinMeeting: | (BOOL) | muted |
Set to mute user's video when he joins the meeting.
muted | YES means to mute the video, otherwise not. |
- (MobileRTCMeetError) setReactionSkinTone: | (MobileRTCEmojiReactionSkinTone) | skinTone |
Set emoji reaction skin tone.
skinTone | The reaction skin tone. |
- (void) setSpeakerOffWhenInMeeting: | (BOOL) | speakerOff |
Set speaker off. Default value is No, Need set to NO when not used.
YES | means speaker off, otherwise not. |
- (BOOL) showMyMeetingElapseTime |
Query show meeting elapse time.
- (BOOL) showVideoPreviewWhenJoinMeetingDisabled |
Query if it is disabled to show video preview when join meeting.
- (BOOL) speakerOffWhenInMeeting |
Query Meeting setting of speaker off when present meeting.
- (BOOL) virtualBackgroundDisabled |
Query if it is disabled for virtual background.
|
readwritenonatomicassign |
Show/Hide BAR at the bottom of the view in the meeting.
Definition at line 94 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Show/Hide "Call in Room System" item in Invite h.323/SIP Room System.
Definition at line 144 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Show/Hide "Call out Room System" item in Invite h.323/SIP Room System.
Definition at line 150 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Show/Hide "Change to Attendee" in webinar meeting.
Definition at line 182 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Show/Hide "Enter Host Key to Claim Host" item in Menu More.
Definition at line 156 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Show/Hide CLOSE CAPTION in a meeting.
Definition at line 162 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Show/Hide disconnect audio button.
Definition at line 100 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Enable Custom In-Meeting UI in meeting.
Definition at line 193 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Enable/Disable Kubi Device in the meeting.
Definition at line 113 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
hide feedback button on cloud whiteboard.
Definition at line 198 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
hide share button on cloud whiteboard.
Definition at line 203 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Show/Hide the hint message in the meeting.
Definition at line 132 of file MobileRTCMeetingSettings.h.
|
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.
Definition at line 126 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Show/Hide AUDIO button in the meeting bar.
Definition at line 39 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Show/Hide Chat in the meeting bar.
Definition at line 63 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Show/Hide INVITE button in the meeting bar.
Definition at line 51 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Show/Hide INVITE link in the meeting info view.
Definition at line 57 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Show/Hide the END/LEAVE MEETING button in the meeting bar.
Definition at line 33 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Show/Hide MORE button in the meeting bar.
Definition at line 81 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Show/Hide PARTICIPANT button in the meeting bar.
Definition at line 69 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Show/Hide meeting password in the meeting bar.
Definition at line 27 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Show/Hide SHARE button in the meeting bar.
Definition at line 75 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Show/Hide meeting title in the meeting bar.
Definition at line 21 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Show/Hide VIDEO button in the meeting bar.
Definition at line 45 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Show/Hide "Promote to Panelist" in webinar meeting.
Definition at line 175 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Enable/Disable Proximity Sensors Monitoring in a meeting.
Definition at line 188 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Show/Hide Q&A button in webinar meeting.
Definition at line 168 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Show/Hide record button.
Definition at line 106 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Change thumbnail video layout while viewing a share in the meeting.
Definition at line 120 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Show/Hide the BAR ON THE TOP of view in the meeting.
Definition at line 87 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Show/Hide the waiting HUD while starting/joining a meeting.
Definition at line 138 of file MobileRTCMeetingSettings.h.