|
Meeting SDK for iOS API Reference
|
A class to modify the configurations of the meeting. More...
#include <MobileRTCMeetingSettings.h>
Inherits NSObject.
Instance Methods | |
| (BOOL) | - autoConnectInternetAudio |
| Queries if the user joins meeting with audio device. | |
| (void) | - setAutoConnectInternetAudio: |
| Sets to auto-connect the audio when the user joins the meeting. | |
| (BOOL) | - muteAudioWhenJoinMeeting |
| Queries if the user's audio is muted when they join the meeting. | |
| (void) | - setMuteAudioWhenJoinMeeting: |
| Sets to mute the user's audio when they join the meeting. | |
| (BOOL) | - muteVideoWhenJoinMeeting |
| Queries if the user's video is muted when they join the meeting. | |
| (void) | - setMuteVideoWhenJoinMeeting: |
| Sets to mute the user's video when they join the meeting. | |
| (BOOL) | - faceBeautyEnabled |
| Queries if Touch up my appearance is enabled. | |
| (void) | - setFaceBeautyEnabled: |
| Enables or disables Touch up my appearance. | |
| (BOOL) | - isMirrorEffectEnabled |
| Determines if mirror effect is enabled. | |
| (void) | - enableMirrorEffect: |
| Enables or disables mirror effect. | |
| (BOOL) | - driveModeDisabled |
| Queries if driving mode is disabled. | |
| (void) | - disableDriveMode: |
| Sets to disable the Driving mode in the meeting. | |
| (BOOL) | - galleryViewDisabled |
| Queries if Gallery View is disabled. | |
| (void) | - disableGalleryView: |
| Sets to disable the Gallery View in the meeting. | |
| (void) | - disableCloudWhiteboard: |
| Enables or disables the new Zoom Whiteboard feature (different from Classic Whiteboard). This feature is enabled by default. | |
| (BOOL) | - callInDisabled |
| Queries if it is disabled to call in. | |
| (void) | - disableCallIn: |
| Sets to disable the incoming calls. | |
| (BOOL) | - callOutDisabled |
| Queries if it is disabled to call out. | |
| (void) | - disableCallOut: |
| Sets to disable the outgoing calls. | |
| (BOOL) | - minimizeMeetingDisabled |
| Queries if it is disabled to Minimize Meeting. | |
| (void) | - disableMinimizeMeeting: |
| Sets to disable the Minimize Meeting. | |
| (BOOL) | - freeMeetingUpgradeTipsDisabled |
| Queries if it is disabled free meeting upgrade tips. | |
| (void) | - disableFreeMeetingUpgradeTips: |
| Sets to disable free meeting upgrade tips. | |
| (BOOL) | - speakerOffWhenInMeeting |
| Queries meeting setting of speaker off when present meeting. | |
| (void) | - setSpeakerOffWhenInMeeting: |
| Sets speaker off. The default value is NO. Set to NO when not used. | |
| (BOOL) | - showMyMeetingElapseTime |
| Queries show meeting elapse time. | |
| (void) | - enableShowMyMeetingElapseTime: |
| Enables or disables showing meeting elapse time. | |
| (BOOL) | - micOriginalInputEnabled |
| Queries if mic original input is enabled. | |
| (void) | - enableMicOriginalInput: |
| Enables or disables mic original input. | |
| (BOOL) | - reactionsOnMeetingUIHidden |
| Queries if reactions on MeetingUI is hidden. | |
| (void) | - hideReactionsOnMeetingUI: |
| Sets the visibility of reaction on meeting UI. The default is displaying. | |
| (BOOL) | - showVideoPreviewWhenJoinMeetingDisabled |
| Queries if it is disabled to show video preview when joining meeting. | |
| (void) | - disableShowVideoPreviewWhenJoinMeeting: |
| Sets to disable show video preview when joining meeting. | |
| (BOOL) | - virtualBackgroundDisabled |
| Queries if it is disabled for virtual background. | |
| (void) | - disableVirtualBackground: |
| Sets to disable virtual background. | |
| (void) | - prePopulateWebinarRegistrationInfo:username: |
| Pre-populates webinar registration info. | |
| (void) | - setHideRegisterWebinarInfoWindow: |
| Sets the webinar register information dialog to hide or display. | |
| (BOOL) | - hideRegisterWebinarInfoWindow |
| Gets whether the webinar register information dialog is hidden or displayed. | |
| (void) | - setHideWebinarNameInputWindow: |
| Sets the webinar username input dialog to hide or display. If hide webinar user name input dialog, should handle MobileRTCMeetingServiceDelegate::onWebinarNeedInputScreenName:. inputName: . | |
| (BOOL) | - isHideWebinarNameInputWindow |
| Gets whether the webinar username input dialog is hidden or displayed. | |
| (BOOL) | - disableConfidentialWatermark: |
| Sets to disable confidential watermark. | |
| (BOOL) | - copyMeetingUrlDisabled |
| Queries if it is disabled for copy meeting URL. | |
| (void) | - disableCopyMeetingUrl: |
| Sets to disable copy meeting URL in the meeting info view. | |
| (MobileRTCMeetError) | - setReactionSkinTone: |
| Sets emoji reaction skin tone. | |
| (MobileRTCEmojiReactionSkinTone) | - reactionSkinTone |
| Gets reaction skin tone. | |
| (void) | - disableClearWebKitCache: |
| Disables the action of clear WebView's cache. | |
| (BOOL) | - isDisabledClearWebKitCache |
| Queries if the action of clear WebView's cache is disabled. | |
| (BOOL) | - isHideNoVideoUsersEnabled |
| Queries if the option HIDE NON-VIDEO PARTICIPANTS is enabled. | |
| (void) | - setHideNoVideoUsersEnabled: |
| Sets whether to enable the option HIDE NON-VIDEO PARTICIPANTS. | |
| (void) | - enableHideSelfView: |
| Enables or disables to hide the user's own view. isHidden YES indicates to enable to hide the user's own view. | |
| (BOOL) | - isHideSelfViewEnabled |
| Gets the flag to enable or disable to hide the user's own view. | |
| (void) | - hideRequestRecordPrivilegeDialog: |
| Sets the visibility of request local recording privilege dialog when attendee requests local recording privilege. Default is displaying. | |
| (BOOL) | - videoCallPictureInPictureEnabled |
| Gets the flag of auto enter Picture-in-Picture Mode for video calls. | |
| (void) | - enableGrabShareWithoutReminder: |
| Sets whether to close the current sharing of another user without prompt and directly beginning a new sharing content by the closer. Default value: NO (prompt). | |
| (void) | - setHideMeetingInputUserInfoWindow: |
| Sets the meeting input user info dialog to hide or display. | |
| (BOOL) | - isHideMeetingInputUserInfoWindow |
| Gets whether the meeting input user info dialog is hidden or displayed. | |
| (BOOL) | - isCenterStageModeSupported |
| Queries if this device supports CenterStage Mode. | |
| (BOOL) | - enableCenterStageMode: |
| Enables or disables CenterStage Mode. This is disabled by default. | |
| (BOOL) | - isEnabledCenterStageMode |
| Queries if CenterStage Mode is enabled by MobileRTC. | |
| (MobileRTCSDKError) | - enableEchoCancellation: |
| Enables or disables echo cancellation. | |
| (BOOL) | - isEchoCancellationOn |
| Determines if echo cancellation is enabled. | |
| (BOOL) | - isSupportEchoCancellation |
| Determines if the meeting supports echo cancellation. | |
| (void) | - setHideConfirmStartArchiveDialog: |
| Sets the confirm start archive dialog to hide or display. | |
| (BOOL) | - isHideConfirmStartArchiveDialog |
| Gets whether the confirm start archive dialog is hidden or displayed. | |
| (void) | - enable5GHighBandWidth: |
| Enables or disables canceling the bandwidth limit. If YES is set, the network bandwidth is no longer limited, and better audio and video quality can be obtained. Bandwidth is not limited by default. If it is a WiFi network, the bandwidth is not limited, and this setting is invalid. | |
| (void) | - enableZoomDocs: |
| Enables or disables zoom docs features in custom UI. This can only take effect when MobileRTCSDKInitContext::enableCustomizeMeetingUI is true. This is disabled by default. When you enable this feature, you need to handle the MobileRTCMeetingServiceDelegate::onDocsStatusChanged:, and subscribe the docs share with the MobileRTCMeetingService::showDocByParentViewCtroller:. | |
| (void) | - enableShareContentFlashDetection: |
| Enables or disables automatic dimming of video when sharing content flashes. When enabled, the video will be automatically dimmed when the shared content contains flashing elements. | |
| (BOOL) | - isShareContentFlashDetectionEnabled |
| Queries whether automatic dimming of video when sharing content flashes is enabled. | |
| (void) | - setDelegate: |
| Set the delegate to receive meeting settings events, including 3D avatar settings events. | |
| (BOOL) | - isCustom3DAvatarEnabled |
| Determine if the custom 3D avatar feature is enabled. | |
| (NSArray< MobileRTC3DAvatarImageInfo * > *_Nullable) | - getCustom3DAvatarImageList |
| Get the list of available custom 3D avatar images. Each image represents a custom 3D avatar that can be selected, edited, duplicated, or deleted. | |
| (BOOL) | - isCustom3DAvatarImageModelDataReady: |
| Check whether the model data for a specific custom 3D avatar image is ready. The avatar image can only be used after its model data has been fully downloaded and prepared. | |
| (MobileRTCSDKError) | - downloadCustom3DAvatarImageModelData: |
| Download the model data required for a specific custom 3D avatar image. Call this method if isCustom3DAvatarImageModelDataReady returns NO for the specified custom 3d avatar image. | |
| (MobileRTCSDKError) | - setCustom3DAvatarImage: |
| Apply a custom 3D avatar image as the active avatar. | |
| (BOOL) | - isCustom3DAvatarDefaultImageModelDataReady |
| Checks whether the model data for default custom 3D avatar elements image have been fully downloaded and are ready for use. This method is typically used before starting the custom 3D avatar creation process to ensure default elements data is available. | |
| (MobileRTCSDKError) | - downloadCustom3DAvatarDefaultImageModelData |
| Download the model data required for a default custom 3D avatar image. Call this method if isCustom3DAvatarDefaultImageModelDataReady returns NO for the default custom 3d avatar image. | |
| (MobileRTCCustom3DAvatarElementSettingContext *_Nullable) | - startCreateCustom3DAvatarWithPreviewView: |
| Start creating a new custom 3D avatar. This method initializes a custom 3D avatar creation session and returns a MobileRTCCustom3DAvatarElementSettingContext instance for configuring avatar elements (image, model data, color, etc.). | |
| (MobileRTCSDKError) | - finishCreateCustom3DAvatar: |
| Finish creating a custom 3D avatar. This method ends the custom 3D avatar creation session that was started by startCreateCustom3DAvatarWithPreviewView. | |
| (MobileRTCCustom3DAvatarElementSettingContext *_Nullable) | - startEditCustom3DAvatarWithPreviewView:imageInfo: |
| Start editing an existing custom 3D avatar. This method starts an editing session for the specified custom 3D avatar and returns a MobileRTCCustom3DAvatarElementSettingContext instance for modifying avatar elements such as images and colors. | |
| (MobileRTCSDKError) | - finishEditCustom3DAvatar: |
| Finish editing a custom 3D avatar. This method ends the custom 3D avatar editing session that was started by startEditCustom3DAvatarWithPreviewView. | |
| (MobileRTCSDKError) | - duplicateCustom3DAvatarImage: |
| Duplicate a custom 3D avatar. | |
| (MobileRTCSDKError) | - deleteCustom3DAvatarImage: |
| Delete a custom 3D avatar. | |
Properties | |
| BOOL | meetingTitleHidden |
| Shows or hides meeting title in the meeting bar. | |
| BOOL | meetingPasswordHidden |
| Shows or hides meeting password in the meeting bar. | |
| BOOL | meetingLeaveHidden |
| Shows or hides the END/LEAVE MEETING button in the meeting bar. | |
| BOOL | meetingAudioHidden |
| Shows or hides AUDIO button in the meeting bar. | |
| BOOL | meetingVideoHidden |
| Shows or hides VIDEO button in the meeting bar. | |
| BOOL | meetingInviteHidden |
| Shows or hides INVITE button in the meeting bar. | |
| BOOL | meetingInviteUrlHidden |
| Shows or hides INVITE link in the meeting info view. | |
| BOOL | meetingChatHidden |
| Shows or hides Chat in the meeting bar. | |
| BOOL | meetingParticipantHidden |
| Shows or hides PARTICIPANT button in the meeting bar. | |
| BOOL | meetingShareHidden |
| Shows or hides SHARE button in the meeting bar. | |
| BOOL | meetingMoreHidden |
| Shows or hides MORE button in the meeting bar. | |
| BOOL | topBarHidden |
| Shows or hides the bar on the top of view in the meeting. | |
| BOOL | bottomBarHidden |
| Shows or hides bar at the bottom of the view in the meeting. | |
| BOOL | disconnectAudioHidden |
| Shows or hides disconnect audio button. | |
| BOOL | recordButtonHidden |
| Shows or hides record button. | |
| BOOL | thumbnailInShare |
| YES to change thumbnail video layout while viewing a share in the meeting. Otherwise, NO. | |
| BOOL | hostLeaveHidden |
| Shows or hides LEAVE MEETING item for the host in the pop up view after clicking the end/leave meeting button in the meeting bar. | |
| BOOL | hintHidden |
| Shows or hides the hint message in the meeting. The hint message is on the top bar. | |
| BOOL | tipsHidden |
| Shows or hides the tips message in the meeting. The tips message is on the bottom of the screen. | |
| BOOL | waitingHUDHidden |
| Shows or hides the waiting HUD while starting or joining a meeting. | |
| BOOL | callinRoomSystemHidden |
| Shows or hides "Call in Room System" item in Invite H.323/SIP Room System. | |
| BOOL | calloutRoomSystemHidden |
| Shows or hides "Call out Room System" item in Invite H.323/SIP Room System. | |
| BOOL | claimHostWithHostKeyHidden |
| Shows or hides "Enter Host Key to Claim Host" item in Menu More. | |
| BOOL | closeCaptionHidden |
| Shows or hides CLOSED CAPTION in a meeting. | |
| BOOL | qaButtonHidden |
| Shows or hides Q&A button in webinar meeting. | |
| BOOL | promoteToPanelistHidden |
| Shows or hides "Promote to Panelist" in webinar meeting. | |
| BOOL | changeToAttendeeHidden |
| Shows or hides "Change to Attendee" in webinar meeting. | |
| BOOL | proximityMonitoringDisable |
| Enables or disables Proximity Sensors Monitoring in a meeting. | |
| BOOL | hideRecoverMeetingDialog |
| Enables or disables hiding the recover meeting dialog in Zoom UI mode. | |
| BOOL | hideFeedbackButtonOnCloudWhiteboard |
| Hides feedback button on cloud whiteboard. | |
| BOOL | hideShareButtonOnCloudWhiteboard |
| Hides share button on cloud whiteboard. | |
| BOOL | hideAboutButtonOnCloudWhiteboard |
| About button's visibility on the cloud whiteboard. The default is displaying. | |
A class to modify the configurations of the meeting.
Definition at line 14 of file MobileRTCMeetingSettings.h.
| - (BOOL) autoConnectInternetAudio |
Queries if the user joins meeting with audio device.
References autoConnectInternetAudio.
Referenced by autoConnectInternetAudio.
| - (BOOL) callInDisabled |
Queries if it is disabled to call in.
References callInDisabled.
Referenced by callInDisabled.
| - (BOOL) callOutDisabled |
Queries if it is disabled to call out.
References callOutDisabled.
Referenced by callOutDisabled.
| - (BOOL) copyMeetingUrlDisabled |
Queries if it is disabled for copy meeting URL.
References copyMeetingUrlDisabled.
Referenced by copyMeetingUrlDisabled.
| - (MobileRTCSDKError) deleteCustom3DAvatarImage: | (MobileRTC3DAvatarImageInfo *_Nullable) | imageInfo |
Delete a custom 3D avatar.
| imageInfo | The custom 3D avatar image info object to delete. |
Provided by category MobileRTCMeetingSettings(Custom3DAvatar).
| - (void) disableCallIn: | (BOOL) | disabled |
Sets to disable the incoming calls.
| disabled | The option value. |
| - (void) disableCallOut: | (BOOL) | disabled |
Sets to disable the outgoing calls.
| disabled | The option value. |
| - (void) disableClearWebKitCache: | (BOOL) | disabled |
Disables the action of clear WebView's cache.
| disabled | YES to disable the clear action. Otherwise, NO. |
| - (void) disableCloudWhiteboard: | (BOOL) | disabled |
Enables or disables the new Zoom Whiteboard feature (different from Classic Whiteboard). This feature is enabled by default.
| disabled | YES to disable. Otherwise, NO. |
| - (BOOL) disableConfidentialWatermark: | (BOOL) | disable |
Sets to disable confidential watermark.
| disable | The option value. |
| - (void) disableCopyMeetingUrl: | (BOOL) | disabled |
Sets to disable copy meeting URL in the meeting info view.
| disabled | The option value. |
| - (void) disableDriveMode: | (BOOL) | disabled |
Sets to disable the Driving mode in the meeting.
| disabled | YES to disable. Otherwise, NO. |
| - (void) disableFreeMeetingUpgradeTips: | (BOOL) | disabled |
Sets to disable free meeting upgrade tips.
| disabled | The option value. |
| - (void) disableGalleryView: | (BOOL) | disabled |
Sets to disable the Gallery View in the meeting.
| disabled | YES to disable. Otherwise, NO. |
| - (void) disableMinimizeMeeting: | (BOOL) | disabled |
Sets to disable the Minimize Meeting.
| disabled | The option value. |
| - (void) disableShowVideoPreviewWhenJoinMeeting: | (BOOL) | disabled |
Sets to disable show video preview when joining meeting.
| disabled | The option value. |
| - (void) disableVirtualBackground: | (BOOL) | disabled |
Sets to disable virtual background.
| disabled | The option value. |
| - (MobileRTCSDKError) downloadCustom3DAvatarDefaultImageModelData |
Download the model data required for a default custom 3D avatar image. Call this method if isCustom3DAvatarDefaultImageModelDataReady returns NO for the default custom 3d avatar image.
Provided by category MobileRTCMeetingSettings(Custom3DAvatar).
| - (MobileRTCSDKError) downloadCustom3DAvatarImageModelData: | (MobileRTC3DAvatarImageInfo *_Nullable) | imageInfo |
Download the model data required for a specific custom 3D avatar image. Call this method if isCustom3DAvatarImageModelDataReady returns NO for the specified custom 3d avatar image.
| imageInfo | The custom 3D avatar image info object. |
Provided by category MobileRTCMeetingSettings(Custom3DAvatar).
| - (BOOL) driveModeDisabled |
Queries if driving mode is disabled.
References driveModeDisabled.
Referenced by driveModeDisabled.
| - (MobileRTCSDKError) duplicateCustom3DAvatarImage: | (MobileRTC3DAvatarImageInfo *_Nullable) | imageInfo |
Duplicate a custom 3D avatar.
| imageInfo | The custom 3D avatar image info object to duplicate. |
Provided by category MobileRTCMeetingSettings(Custom3DAvatar).
| - (void) enable5GHighBandWidth: | (BOOL) | enable |
Enables or disables canceling the bandwidth limit. If YES is set, the network bandwidth is no longer limited, and better audio and video quality can be obtained. Bandwidth is not limited by default. If it is a WiFi network, the bandwidth is not limited, and this setting is invalid.
| enable | YES to enable. Otherwise, NO. |
| - (BOOL) enableCenterStageMode: | (BOOL) | enable |
Enables or disables CenterStage Mode. This is disabled by default.
| enable | YES to enable. Otherwise, NO. |
| - (MobileRTCSDKError) enableEchoCancellation: | (BOOL) | enable |
Enables or disables echo cancellation.
| enable | YES to enable. Otherwise, NO. |
| - (void) enableGrabShareWithoutReminder: | (BOOL) | enable |
Sets whether to close the current sharing of another user without prompt and directly beginning a new sharing content by the closer. Default value: NO (prompt).
| enable | YES to indicate no prompt. Otherwise, NO. |
| - (void) enableHideSelfView: | (BOOL) | isHidden |
Enables or disables to hide the user's own view. isHidden YES indicates to enable to hide the user's own view.
| isHidden | YES to enable to hide the user's own view. Otherwise, NO. |
| - (void) enableMicOriginalInput: | (BOOL) | enable |
Enables or disables mic original input.
| enable | YES to enable mic original input. Otherwise, NO. |
| - (void) enableMirrorEffect: | (BOOL) | enable |
Enables or disables mirror effect.
| enable | YES to enable. Otherwise, NO to disable. |
| - (void) enableShareContentFlashDetection: | (BOOL) | enable |
Enables or disables automatic dimming of video when sharing content flashes. When enabled, the video will be automatically dimmed when the shared content contains flashing elements.
| enable | YES to enable automatic dimming. Otherwise, NO. |
| - (void) enableShowMyMeetingElapseTime: | (BOOL) | enable |
Enables or disables showing meeting elapse time.
| enable | YES to show meeting elapse time. Otherwise, NO. |
| - (void) enableZoomDocs: | (BOOL) | enable |
Enables or disables zoom docs features in custom UI. This can only take effect when MobileRTCSDKInitContext::enableCustomizeMeetingUI is true. This is disabled by default. When you enable this feature, you need to handle the MobileRTCMeetingServiceDelegate::onDocsStatusChanged:, and subscribe the docs share with the MobileRTCMeetingService::showDocByParentViewCtroller:.
| enable | YES to enable. Otherwise, NO. |
| - (BOOL) faceBeautyEnabled |
Queries if Touch up my appearance is enabled.
References faceBeautyEnabled.
Referenced by faceBeautyEnabled.
| - (MobileRTCSDKError) finishCreateCustom3DAvatar: | (BOOL) | save |
Finish creating a custom 3D avatar. This method ends the custom 3D avatar creation session that was started by startCreateCustom3DAvatarWithPreviewView.
| save |
|
Provided by category MobileRTCMeetingSettings(Custom3DAvatar).
| - (MobileRTCSDKError) finishEditCustom3DAvatar: | (BOOL) | save |
Finish editing a custom 3D avatar. This method ends the custom 3D avatar editing session that was started by startEditCustom3DAvatarWithPreviewView.
| save |
|
Provided by category MobileRTCMeetingSettings(Custom3DAvatar).
| - (BOOL) freeMeetingUpgradeTipsDisabled |
Queries if it is disabled free meeting upgrade tips.
References freeMeetingUpgradeTipsDisabled.
Referenced by freeMeetingUpgradeTipsDisabled.
| - (BOOL) galleryViewDisabled |
Queries if Gallery View is disabled.
References galleryViewDisabled.
Referenced by galleryViewDisabled.
| - (NSArray< MobileRTC3DAvatarImageInfo * > *_Nullable) getCustom3DAvatarImageList |
Get the list of available custom 3D avatar images. Each image represents a custom 3D avatar that can be selected, edited, duplicated, or deleted.
Provided by category MobileRTCMeetingSettings(Custom3DAvatar).
| - (void) hideReactionsOnMeetingUI: | (BOOL) | hidden |
Sets the visibility of reaction on meeting UI. The default is displaying.
| hidden | YES to hide reaction emotion. Otherwise, NO. |
| - (BOOL) hideRegisterWebinarInfoWindow |
Gets whether the webinar register information dialog is hidden or displayed.
References hideRegisterWebinarInfoWindow.
Referenced by hideRegisterWebinarInfoWindow.
| - (void) hideRequestRecordPrivilegeDialog: | (BOOL) | bHide |
Sets the visibility of request local recording privilege dialog when attendee requests local recording privilege. Default is displaying.
| bHide | YES to hide the dialog. Otherwise, NO. |
| - (BOOL) isCenterStageModeSupported |
Queries if this device supports CenterStage Mode.
References isCenterStageModeSupported.
Referenced by isCenterStageModeSupported.
| - (BOOL) isCustom3DAvatarDefaultImageModelDataReady |
Checks whether the model data for default custom 3D avatar elements image have been fully downloaded and are ready for use. This method is typically used before starting the custom 3D avatar creation process to ensure default elements data is available.
Provided by category MobileRTCMeetingSettings(Custom3DAvatar).
| - (BOOL) isCustom3DAvatarEnabled |
Determine if the custom 3D avatar feature is enabled.
Provided by category MobileRTCMeetingSettings(Custom3DAvatar).
| - (BOOL) isCustom3DAvatarImageModelDataReady: | (MobileRTC3DAvatarImageInfo *_Nullable) | imageInfo |
Check whether the model data for a specific custom 3D avatar image is ready. The avatar image can only be used after its model data has been fully downloaded and prepared.
| imageInfo | The custom 3D avatar image info object. |
Provided by category MobileRTCMeetingSettings(Custom3DAvatar).
| - (BOOL) isDisabledClearWebKitCache |
Queries if the action of clear WebView's cache is disabled.
References isDisabledClearWebKitCache.
Referenced by isDisabledClearWebKitCache.
| - (BOOL) isEchoCancellationOn |
Determines if echo cancellation is enabled.
References isEchoCancellationOn.
Referenced by isEchoCancellationOn.
| - (BOOL) isEnabledCenterStageMode |
Queries if CenterStage Mode is enabled by MobileRTC.
References isEnabledCenterStageMode.
Referenced by isEnabledCenterStageMode.
| - (BOOL) isHideConfirmStartArchiveDialog |
Gets whether the confirm start archive dialog is hidden or displayed.
References isHideConfirmStartArchiveDialog.
Referenced by isHideConfirmStartArchiveDialog.
| - (BOOL) isHideMeetingInputUserInfoWindow |
Gets whether the meeting input user info dialog is hidden or displayed.
References isHideMeetingInputUserInfoWindow.
Referenced by isHideMeetingInputUserInfoWindow.
| - (BOOL) isHideNoVideoUsersEnabled |
Queries if the option HIDE NON-VIDEO PARTICIPANTS is enabled.
References isHideNoVideoUsersEnabled.
Referenced by isHideNoVideoUsersEnabled.
| - (BOOL) isHideSelfViewEnabled |
Gets the flag to enable or disable to hide the user's own view.
References isHideSelfViewEnabled.
Referenced by isHideSelfViewEnabled.
| - (BOOL) isHideWebinarNameInputWindow |
Gets whether the webinar username input dialog is hidden or displayed.
References isHideWebinarNameInputWindow.
Referenced by isHideWebinarNameInputWindow.
| - (BOOL) isMirrorEffectEnabled |
Determines if mirror effect is enabled.
References isMirrorEffectEnabled.
Referenced by isMirrorEffectEnabled.
| - (BOOL) isShareContentFlashDetectionEnabled |
Queries whether automatic dimming of video when sharing content flashes is enabled.
References isShareContentFlashDetectionEnabled.
Referenced by isShareContentFlashDetectionEnabled.
| - (BOOL) isSupportEchoCancellation |
Determines if the meeting supports echo cancellation.
References isSupportEchoCancellation.
Referenced by isSupportEchoCancellation.
| - (BOOL) micOriginalInputEnabled |
Queries if mic original input is enabled.
References micOriginalInputEnabled.
Referenced by micOriginalInputEnabled.
| - (BOOL) minimizeMeetingDisabled |
Queries if it is disabled to Minimize Meeting.
References minimizeMeetingDisabled.
Referenced by minimizeMeetingDisabled.
| - (BOOL) muteAudioWhenJoinMeeting |
Queries if the user's audio is muted when they join the meeting.
References muteAudioWhenJoinMeeting.
Referenced by muteAudioWhenJoinMeeting.
| - (BOOL) muteVideoWhenJoinMeeting |
Queries if the user's video is muted when they join the meeting.
References muteVideoWhenJoinMeeting.
Referenced by muteVideoWhenJoinMeeting.
| - (void) prePopulateWebinarRegistrationInfo: | (nonnull NSString *) | ||
| username: | (nonnull NSString *) | username |
Pre-populates webinar registration info.
| The registration email address. | |
| username | The registration username. |
| - (MobileRTCEmojiReactionSkinTone) reactionSkinTone |
Gets reaction skin tone.
References reactionSkinTone.
Referenced by reactionSkinTone.
| - (BOOL) reactionsOnMeetingUIHidden |
Queries if reactions on MeetingUI is hidden.
References reactionsOnMeetingUIHidden.
Referenced by reactionsOnMeetingUIHidden.
| - (void) setAutoConnectInternetAudio: | (BOOL) | connected |
Sets to auto-connect the audio when the user joins the meeting.
| connected | The option value. |
| - (MobileRTCSDKError) setCustom3DAvatarImage: | (MobileRTC3DAvatarImageInfo *_Nullable) | imageInfo |
Apply a custom 3D avatar image as the active avatar.
| imageInfo | The custom 3D avatar image info object to apply. |
Provided by category MobileRTCMeetingSettings(Custom3DAvatar).
| - (void) setDelegate: | (id< MobileRTCMeetingSettingsDelegate > _Nullable) | delegate |
Set the delegate to receive meeting settings events, including 3D avatar settings events.
| delegate | The delegate object. |
| - (void) setFaceBeautyEnabled: | (BOOL) | enable |
Enables or disables Touch up my appearance.
| enable | YES to enable. Otherwise, NO. |
| - (void) setHideConfirmStartArchiveDialog: | (BOOL) | hide |
Sets the confirm start archive dialog to hide or display.
| hide | YES to hide the dialog. Otherwise, NO. |
| - (void) setHideMeetingInputUserInfoWindow: | (BOOL) | hide |
Sets the meeting input user info dialog to hide or display.
| hide | YES to hide the dialog. Otherwise, NO. |
| - (void) setHideNoVideoUsersEnabled: | (BOOL) | enabled |
Sets whether to enable the option HIDE NON-VIDEO PARTICIPANTS.
| enabled | YES to enable. Otherwise, NO. |
| - (void) setHideRegisterWebinarInfoWindow: | (BOOL) | hide |
Sets the webinar register information dialog to hide or display.
| hide | YES to hide the dialog. Otherwise, NO. |
| - (void) setHideWebinarNameInputWindow: | (BOOL) | hide |
Sets the webinar username input dialog to hide or display. If hide webinar user name input dialog, should handle MobileRTCMeetingServiceDelegate::onWebinarNeedInputScreenName:. inputName: .
| hide | YES to hide the dialog. Otherwise, NO. |
| - (void) setMuteAudioWhenJoinMeeting: | (BOOL) | muted |
Sets to mute the user's audio when they join the meeting.
| muted | YES to mute the audio. Otherwise, NO. |
| - (void) setMuteVideoWhenJoinMeeting: | (BOOL) | muted |
Sets to mute the user's video when they join the meeting.
| muted | YES to mute the video. Otherwise, NO. |
| - (MobileRTCMeetError) setReactionSkinTone: | (MobileRTCEmojiReactionSkinTone) | skinTone |
Sets emoji reaction skin tone.
| skinTone | The reaction skin tone. |
| - (void) setSpeakerOffWhenInMeeting: | (BOOL) | speakerOff |
Sets speaker off. The default value is NO. Set to NO when not used.
| speakerOff | YES to set speaker off. Otherwise, NO. |
| - (BOOL) showMyMeetingElapseTime |
Queries show meeting elapse time.
References showMyMeetingElapseTime.
Referenced by showMyMeetingElapseTime.
| - (BOOL) showVideoPreviewWhenJoinMeetingDisabled |
Queries if it is disabled to show video preview when joining meeting.
References showVideoPreviewWhenJoinMeetingDisabled.
Referenced by showVideoPreviewWhenJoinMeetingDisabled.
| - (BOOL) speakerOffWhenInMeeting |
Queries meeting setting of speaker off when present meeting.
References speakerOffWhenInMeeting.
Referenced by speakerOffWhenInMeeting.
| - (MobileRTCCustom3DAvatarElementSettingContext *_Nullable) startCreateCustom3DAvatarWithPreviewView: | (UIView *_Nullable) | previewView |
Start creating a new custom 3D avatar. This method initializes a custom 3D avatar creation session and returns a MobileRTCCustom3DAvatarElementSettingContext instance for configuring avatar elements (image, model data, color, etc.).
| previewView | The UIView to display the preview. |
Provided by category MobileRTCMeetingSettings(Custom3DAvatar).
| - (MobileRTCCustom3DAvatarElementSettingContext *_Nullable) startEditCustom3DAvatarWithPreviewView: | (UIView *_Nullable) | previewView | |
| imageInfo: | (MobileRTC3DAvatarImageInfo *_Nullable) | imageInfo |
Start editing an existing custom 3D avatar. This method starts an editing session for the specified custom 3D avatar and returns a MobileRTCCustom3DAvatarElementSettingContext instance for modifying avatar elements such as images and colors.
| previewView | The UIView to display the preview. |
| imageInfo | The custom 3D avatar image info object to edit. |
Provided by category MobileRTCMeetingSettings(Custom3DAvatar).
| - (BOOL) videoCallPictureInPictureEnabled |
Gets the flag of auto enter Picture-in-Picture Mode for video calls.
References videoCallPictureInPictureEnabled.
Referenced by videoCallPictureInPictureEnabled.
| - (BOOL) virtualBackgroundDisabled |
Queries if it is disabled for virtual background.
References virtualBackgroundDisabled.
Referenced by virtualBackgroundDisabled.
|
readwritenonatomicassign |
Shows or hides bar at the bottom of the view in the meeting.
Definition at line 93 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Shows or hides "Call in Room System" item in Invite H.323/SIP Room System.
Definition at line 142 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Shows or hides "Call out Room System" item in Invite H.323/SIP Room System.
Definition at line 148 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Shows or hides "Change to Attendee" in webinar meeting.
Definition at line 180 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Shows or hides "Enter Host Key to Claim Host" item in Menu More.
Definition at line 154 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Shows or hides CLOSED CAPTION in a meeting.
Definition at line 160 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Shows or hides disconnect audio button.
Definition at line 99 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
About button's visibility on the cloud whiteboard. The default is displaying.
Definition at line 210 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Hides feedback button on cloud whiteboard.
Definition at line 198 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Enables or disables hiding the recover meeting dialog in Zoom UI mode.
Definition at line 192 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Hides share button on cloud whiteboard.
Definition at line 204 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Shows or hides the hint message in the meeting. The hint message is on the top bar.
Definition at line 124 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Shows or hides LEAVE MEETING item for the host in the pop up view after clicking the end/leave meeting button in the meeting bar.
Definition at line 118 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Shows or hides AUDIO button in the meeting bar.
Definition at line 38 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Shows or hides Chat in the meeting bar.
Definition at line 62 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Shows or hides INVITE button in the meeting bar.
Definition at line 50 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Shows or hides INVITE link in the meeting info view.
Definition at line 56 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Shows or hides the END/LEAVE MEETING button in the meeting bar.
Definition at line 32 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Shows or hides MORE button in the meeting bar.
Definition at line 80 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Shows or hides PARTICIPANT button in the meeting bar.
Definition at line 68 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Shows or hides meeting password in the meeting bar.
Definition at line 26 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Shows or hides SHARE button in the meeting bar.
Definition at line 74 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Shows or hides meeting title in the meeting bar.
Definition at line 20 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Shows or hides VIDEO button in the meeting bar.
Definition at line 44 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Shows or hides "Promote to Panelist" in webinar meeting.
Definition at line 173 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Enables or disables Proximity Sensors Monitoring in a meeting.
Definition at line 186 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Shows or hides Q&A button in webinar meeting.
Definition at line 166 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Shows or hides record button.
Definition at line 105 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
YES to change thumbnail video layout while viewing a share in the meeting. Otherwise, NO.
Definition at line 112 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Shows or hides the tips message in the meeting. The tips message is on the bottom of the screen.
Definition at line 130 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Shows or hides the bar on the top of view in the meeting.
Definition at line 86 of file MobileRTCMeetingSettings.h.
|
readwritenonatomicassign |
Shows or hides the waiting HUD while starting or joining a meeting.
Definition at line 136 of file MobileRTCMeetingSettings.h.