Package us.zoom.sdk
Interface MeetingSettingsHelper
public interface MeetingSettingsHelper
ZOOM meeting settings.
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
disableAutoShowSelectJoinAudioDlgWhenJoinMeeting
(boolean bDisable) Set the visibility of the dialog SELECT JOIN AUDIO when joining meeting.void
disableChatUI
(boolean disable) Disable chat ui for zoom ui.void
disableClearWebKitCache
(boolean disabled) Disable the action of clear WebView's cache.boolean
disableConfidentialWatermark
(boolean disable) Disable use confidential watermarkvoid
disableCopyMeetingUrl
(boolean disable) Disable use copy url for long press zoom ui meeting title bar.void
disableLeaveMeetingWhenTaskRemoved
(boolean disable) Disable/Enable leave meeting when service onTaskRemoved called.void
disableShowMeetingNotification
(boolean bDisable) Set if it is disabled to SHOW MEETING NOTIFICATION.void
disableShowVideoPreviewWhenJoinMeeting
(boolean disableVideoPreview) Disable/Enable the video preview dialog when joining a video meeting Note: this api must be called before joining a video meeting to take effectvoid
enable5GHighBandWidth
(boolean enable) Whether to cancel the bandwidth limit, If YES is set, the network bandwidth is no longer limited, and better audio and video quality can be obtained.void
enable720p
(boolean enable) Set to enable 720p, it is only supported in device with at least 4 gold cores Suggest : CPU Qualcomm Snapdragon 660 abovevoid
enableAutoAdjustMicVolume
(boolean enable) Deprecated.void
enableCloudWhiteboard
(boolean enable) Enable or disable the new Zoom Whiteboard feature (different from Classic Whiteboard).int
enableEchoCancellation
(boolean enable) Enable echo cancellation.void
enableForceAutoStartMyVideoWhenJoinMeeting
(boolean bEnable) Set if it is able to force participants to start video when joining the meeting.void
enableForceAutoStopMyVideoWhenJoinMeeting
(boolean bEnable) Set if it is able to force participants to turn off video when joining the meeting.void
enableGrabShareWithoutReminder
(boolean enable) Set whether to close the current sharing of another user without prompt and directly beginning a new sharing content by the closer.void
enableGreenBorderForShareScreen
(boolean enable) enable or disable showing the green border when screen sharing.void
enableMicOriginalInput
(boolean enable) Disable/Enable mic original input.void
enableMirrorEffect
(boolean enable) Enable or disable video mirror effectvoid
enableShowMyMeetingElapseTime
(boolean show) Enable show meeting elapse timevoid
enableUseConnectionService
(boolean enable) Determine if use connection servicevoid
enableWhiteboardVideoView
(boolean enable) Enable the capability to show whiteboard inMobileRTCVideoView
.void
enableZoomDocsInCustomUI
(boolean enable) Enable or disable zoom docs features in custom ui.void
forceDisableCamera
(boolean disable) Force disable camera in meeting.Get the emoji reaction skin tone type.int
Get the threshold for the number of users which is used to switch the video layout automatically.Get type of video aspect ratiovoid
hiddenPoll
(boolean hiddenPoll) Hidden poll feature for zoom uivoid
hiddenQA
(boolean hiddenQA) Hidden question and answer feature for zoom uivoid
hideAnnotationInScreenShareToolbar
(boolean hideAnnotation) Hide annotation button in screen share toolbar,for sdk screen share.void
hideCloudWhiteboardHelperCenterButton
(boolean bHide) Set the Helper center button's visibility on cloud whiteboard.void
hideCloudWhiteboardOpenInBrowserButton
(boolean bHide) Set the Open in browser button's visibility on cloud whiteboard.void
hideStopShareInScreenShareToolbar
(boolean hideStopShare) Hide stopshare button in screen share toolbar.boolean
Query if 720p enabled, it is only supported in device with at least 4 gold coresboolean
Query if the option ALWAYS SHOW MEETING CONTROLS is enabledboolean
Deprecated.boolean
Query if the VoIP auto-connection is enabled when the current user joins the meeting.boolean
Query whether cameras in a meeting are forcibly disabled.boolean
Query if USE CUSTOM MEETING UI is enabled.boolean
Query if the action of clear WebView's cache be disabled.boolean
To query whether the query dialog will be displayed when joining a video meetingboolean
Determine if echo cancellation is enabled or not.boolean
Query if DISABLE video GALLERY VIEW is enabled.boolean
Query if enabling or disabling showing the green border when screen sharing.boolean
Query if annotation button is hide in screen share toolbar.boolean
Query if HIDE CLOSED CAPTION on the main video is enabled.boolean
Query if the option HIDE NON-VIDEO PARTICIPANTS is enabled.boolean
Query if stopshare button is hide in screen share toolbar.boolean
Query if Kubi device is enabled.boolean
Query is mic original input enableboolean
Get the flag to enable/disable the video mirror effectboolean
Query if the microphone is muted always when the current user joins the meeting.boolean
Query if hide leaving button on the dialog when the host leaves meeting is enabledboolean
Query if the tips, NO USER JOINS or LEAVES, is enabled.boolean
Query if NO VIDEO TILE ON SHARE SCREEN is enabled.boolean
Query is enable show meeting elapse timeboolean
Determine if the meeting supports echo cancellation.boolean
Query if it is able to switch video layout mode automatically between SPEAKER VIEW and GALLERY VIEW based on the number of users.boolean
Query if the video is turned off when the current user joins the meeting.boolean
Query whether the capability to show whiteboard inMobileRTCVideoView
is enabled.boolean
Query whether zoom docs feature is enabled in custom ui.void
setActivityForShowDisclaimer
(android.app.Activity activity) Set the activity to show the disclaimer dialog.void
setAlwaysShowMeetingToolbarEnabled
(boolean enabled) Set whether to enable the option ALWAYS SHOW MEETING CONTROLS.void
Set the path for saving annotation screenshots to the albumvoid
set customize audio focus gain typevoid
setAutoConnectVoIPWhenJoinMeeting
(boolean enabled) Set whether to connect VoIP automatically when the current user joins the meeting.void
setClaimHostWithHostKeyActionEnabled
(boolean enabled) Set if CLAIM HOST with host key in the meeting is enabled.void
setClosedCaptionHidden
(boolean bHide) Set whether to hide the closed caption on the main video.void
setConfNotificationCategory
(String category) Set the category of notification for ongoing meeting.void
setConfNotificationChannelId
(String channelId) Set the channel ID of notification for ongoing meeting.void
setConfNotificationPriority
(int priority) set the priority of the ongoing meeting notificationvoid
setCustomizedMeetingUIEnabled
(boolean enabled) Set whether to enable the option USE CUSTOM MEETING UI.void
Customize meeting notification stylesetDimensionConfig
(DimensionType type, DimensionValue value) Set the dimension config.void
Set the disclaimer banner config.void
setGalleryVideoViewDisabled
(boolean disabled) Set whether to enable video GALLERY VIEW.void
Set to hide notifications when downloading emoji.void
setHideNoVideoUsersEnabled
(boolean enabled) Set whether to enable the option HIDE NON-VIDEO PARTICIPANTS.void
setHideShareButtonInMeetingToolbar
(boolean bHide) Set hide share button in meeting toolbar.void
setKubiDeviceEnabled
(boolean enabled) Set whether to enable Kubi device setting.void
setMuteMyMicrophoneWhenJoinMeeting
(boolean enabled) Set whether to mute microphone when the current user joins the meeting.void
setNoInviteH323RoomCallInEnabled
(boolean enabled) Set whether to disable invitation from H.323 Room System.void
setNoInviteH323RoomCallOutEnabled
(boolean enabled) Set whether to disable invitation from H.323 Room System.void
setNoLeaveMeetingButtonForHostEnabled
(boolean enabled) Set whether to hide leaving button on the dialog when the host leaves meeting.void
setNoUserJoinOrLeaveTipEnabled
(boolean enabled) Set whether to enable the tips, NO USER JOINS OR LEAVES.void
setNoVideoTileOnShareScreenEnabled
(boolean enabled) Set whether to enable the options NO MEETING TILE ON SHARED SCREEN.boolean
setPreferredAudioInputDevice
(android.media.AudioDeviceInfo deviceInfo) Set Prefer audio input deviceAudioManager.getDevices(int)
boolean
setPreferredAudioOutputDevice
(android.media.AudioDeviceInfo deviceInfo) Set Prefer audio output deviceAudioManager.getDevices(int)
void
setPresetVBImage
(int resId, String vbKey, boolean delete) set the preset virtual background image.void
setReactionSkinTone
(ReactionSkinToneType skinTone) Set the emoji reaction skin tone type.void
setSwitchVideoLayoutAccordingToUserCountEnabled
(boolean enabled) Set whether to enable the feature to switch video layout mode automatically between SPEAKER VIEW and GALLERY VIEW based on the number of users.void
setSwitchVideoLayoutUserCountThreshold
(int value) Set the threshold for the number of users which is used to switch the video layout automatically.void
setTurnOffMyVideoWhenJoinMeeting
(boolean enabled) Set whether to turn off the video when the current user joins the meeting.void
setVideoAspectRatio
(VideoAspectRatioType aspectRatioType) Set type of video aspect ratio
-
Field Details
-
ANTIBANDING_50HZ
- See Also:
-
ANTIBANDING_60HZ
- See Also:
-
ANTIBANDING_AUTO
- See Also:
-
ANTIBANDING_OFF
- See Also:
-
-
Method Details
-
setAutoConnectVoIPWhenJoinMeeting
void setAutoConnectVoIPWhenJoinMeeting(boolean enabled) Set whether to connect VoIP automatically when the current user joins the meeting.- Parameters:
enabled
- TRUE means that the audio is connected automatically.
-
isAutoConnectVoIPWhenJoinMeetingEnabled
boolean isAutoConnectVoIPWhenJoinMeetingEnabled()Query if the VoIP auto-connection is enabled when the current user joins the meeting.- Returns:
- TRUE means enabled. FALSE disabled.
-
setMuteMyMicrophoneWhenJoinMeeting
void setMuteMyMicrophoneWhenJoinMeeting(boolean enabled) Set whether to mute microphone when the current user joins the meeting.- Parameters:
enabled
- TRUE means to enable the feature. FALSE not.
-
isMuteMyMicrophoneWhenJoinMeetingEnabled
boolean isMuteMyMicrophoneWhenJoinMeetingEnabled()Query if the microphone is muted always when the current user joins the meeting.- Returns:
- TRUE means that the feature is enabled. FALSE not.
-
setTurnOffMyVideoWhenJoinMeeting
void setTurnOffMyVideoWhenJoinMeeting(boolean enabled) Set whether to turn off the video when the current user joins the meeting.- Parameters:
enabled
- TRUE means to enable the feature. FALSE not.
-
isTurnOffMyVideoWhenJoinMeetingEnabled
boolean isTurnOffMyVideoWhenJoinMeetingEnabled()Query if the video is turned off when the current user joins the meeting.- Returns:
- TRUE means that the feature is enabled. FALSE not.
-
setKubiDeviceEnabled
void setKubiDeviceEnabled(boolean enabled) Set whether to enable Kubi device setting. If enable Kubi, android.permission.ACCESS_FINE_LOCATION should be declared in AndroidManifest.xml.- Parameters:
enabled
- TRUE means to enable.
-
isKubiDeviceEnabled
boolean isKubiDeviceEnabled()Query if Kubi device is enabled. If enable Kubi, android.permission.ACCESS_FINE_LOCATION should be declared in AndroidManifest.xml.- Returns:
- TRUE means that the feature is enabled. FALSE not.
-
isHideNoVideoUsersEnabled
boolean isHideNoVideoUsersEnabled()Query if the option HIDE NON-VIDEO PARTICIPANTS is enabled.- Returns:
- TRUE means enabled. FALSE not.
-
setHideNoVideoUsersEnabled
void setHideNoVideoUsersEnabled(boolean enabled) Set whether to enable the option HIDE NON-VIDEO PARTICIPANTS.- Parameters:
enabled
- TRUE means enabled. FALSE not.
-
isSwitchVideoLayoutAccordingToUserCountEnabled
boolean isSwitchVideoLayoutAccordingToUserCountEnabled()Query if it is able to switch video layout mode automatically between SPEAKER VIEW and GALLERY VIEW based on the number of users.- Returns:
- TRUE means able. FALSE not.
-
setSwitchVideoLayoutAccordingToUserCountEnabled
void setSwitchVideoLayoutAccordingToUserCountEnabled(boolean enabled) Set whether to enable the feature to switch video layout mode automatically between SPEAKER VIEW and GALLERY VIEW based on the number of users.- Parameters:
enabled
- TRUE means to enable. FALSE not.
-
getSwitchVideoLayoutUserCountThreshold
int getSwitchVideoLayoutUserCountThreshold()Get the threshold for the number of users which is used to switch the video layout automatically.- Returns:
- The threshold value.
-
setSwitchVideoLayoutUserCountThreshold
void setSwitchVideoLayoutUserCountThreshold(int value) Set the threshold for the number of users which is used to switch the video layout automatically.- Parameters:
value
- The threshold for the number of users.
-
setGalleryVideoViewDisabled
void setGalleryVideoViewDisabled(boolean disabled) Set whether to enable video GALLERY VIEW.- Parameters:
disabled
- TRUE means to disable video gallery view.
-
isGalleryVideoViewDisabled
boolean isGalleryVideoViewDisabled()Query if DISABLE video GALLERY VIEW is enabled.- Returns:
- TURE means that the feature is enabled. FALSE not.
-
isAlwaysShowMeetingToolbarEnabled
boolean isAlwaysShowMeetingToolbarEnabled()Query if the option ALWAYS SHOW MEETING CONTROLS is enabled- Returns:
- TURE means that the feature is enabled. FALSE not.
-
setAlwaysShowMeetingToolbarEnabled
void setAlwaysShowMeetingToolbarEnabled(boolean enabled) Set whether to enable the option ALWAYS SHOW MEETING CONTROLS.- Parameters:
enabled
- TRUE means to enable. FALSE not.
-
isNoLeaveMeetingButtonForHostEnabled
boolean isNoLeaveMeetingButtonForHostEnabled()Query if hide leaving button on the dialog when the host leaves meeting is enabled- Returns:
- TRUE means enabled. FALSE disabled.
-
setNoLeaveMeetingButtonForHostEnabled
void setNoLeaveMeetingButtonForHostEnabled(boolean enabled) Set whether to hide leaving button on the dialog when the host leaves meeting.- Parameters:
enabled
- TRUE means enabled. FALSE disabled.
-
isNoUserJoinOrLeaveTipEnabled
boolean isNoUserJoinOrLeaveTipEnabled()Query if the tips, NO USER JOINS or LEAVES, is enabled.- Returns:
- TRUE means enabled. FALSE disabled.
-
setNoUserJoinOrLeaveTipEnabled
void setNoUserJoinOrLeaveTipEnabled(boolean enabled) Set whether to enable the tips, NO USER JOINS OR LEAVES.- Parameters:
enabled
- TRUE means to enable. FALSE not.
-
isCustomizedMeetingUIEnabled
boolean isCustomizedMeetingUIEnabled()Query if USE CUSTOM MEETING UI is enabled.- Returns:
- TRUE means enabled. FALSE disabled.
-
setCustomizedMeetingUIEnabled
void setCustomizedMeetingUIEnabled(boolean enabled) Set whether to enable the option USE CUSTOM MEETING UI. Note: The feature must be enabled in user SDK account if he wants to use the custom meeting UI. Note: Must be set before the meeting- Parameters:
enabled
- TRUE means enabled. FALSE disabled.
-
setConfNotificationChannelId
Set the channel ID of notification for ongoing meeting.- Parameters:
channelId
- Channel ID of notification.
-
setClaimHostWithHostKeyActionEnabled
void setClaimHostWithHostKeyActionEnabled(boolean enabled) Set if CLAIM HOST with host key in the meeting is enabled.- Parameters:
enabled
- TRUE means to enable. FALSE disabled.
-
setNoInviteH323RoomCallOutEnabled
void setNoInviteH323RoomCallOutEnabled(boolean enabled) Set whether to disable invitation from H.323 Room System.- Parameters:
enabled
- TRUE means to disable the notification.
-
setNoInviteH323RoomCallInEnabled
void setNoInviteH323RoomCallInEnabled(boolean enabled) Set whether to disable invitation from H.323 Room System.- Parameters:
enabled
- TRUE means to disable the notification.
-
setClosedCaptionHidden
void setClosedCaptionHidden(boolean bHide) Set whether to hide the closed caption on the main video. Default value: hide.- Parameters:
bHide
- TRUE means hiding. FALSE displaying.
-
isHideClosedCaption
boolean isHideClosedCaption()Query if HIDE CLOSED CAPTION on the main video is enabled.- Returns:
- TRUE means enabled. FALSE disabled.
-
enableForceAutoStartMyVideoWhenJoinMeeting
void enableForceAutoStartMyVideoWhenJoinMeeting(boolean bEnable) Set if it is able to force participants to start video when joining the meeting.- Parameters:
bEnable
- TRUE means enabled. FALSE disabled.
-
enableForceAutoStopMyVideoWhenJoinMeeting
void enableForceAutoStopMyVideoWhenJoinMeeting(boolean bEnable) Set if it is able to force participants to turn off video when joining the meeting.- Parameters:
bEnable
- TRUE means enabled. FALSE disabled.
-
disableAutoShowSelectJoinAudioDlgWhenJoinMeeting
void disableAutoShowSelectJoinAudioDlgWhenJoinMeeting(boolean bDisable) Set the visibility of the dialog SELECT JOIN AUDIO when joining meeting.- Parameters:
bDisable
- TRUE means to hide. FALSE display.
-
disableShowMeetingNotification
void disableShowMeetingNotification(boolean bDisable) Set if it is disabled to SHOW MEETING NOTIFICATION. disableShowMeetingNotification(true) work only sdk version below Android P.Because above Android P,Limited access to sensors in background. Above Android P screen share and background voip feature need foreground service with foreground notification.- Parameters:
bDisable
- enabled true to enable
-
enable720p
void enable720p(boolean enable) Set to enable 720p, it is only supported in device with at least 4 gold cores Suggest : CPU Qualcomm Snapdragon 660 above- Parameters:
enable
- true enable
-
is720PEnabled
boolean is720PEnabled()Query if 720p enabled, it is only supported in device with at least 4 gold cores- Returns:
- true enable
-
disableChatUI
void disableChatUI(boolean disable) Disable chat ui for zoom ui.- Parameters:
disable
- default false
-
setConfNotificationPriority
void setConfNotificationPriority(int priority) set the priority of the ongoing meeting notification- Parameters:
priority
- Relative priority for this notification. Must be one of the priority constants defined byNotificationCompat
. Acceptable values range fromNotificationCompat.PRIORITY_MIN
(-2) toNotificationCompat.PRIORITY_MAX
(2).
-
enableShowMyMeetingElapseTime
void enableShowMyMeetingElapseTime(boolean show) Enable show meeting elapse time- Parameters:
show
- true show false hidden
-
isShowMyMeetingElapseTimeEnabled
boolean isShowMyMeetingElapseTimeEnabled()Query is enable show meeting elapse time- Returns:
- true enable show
-
setCustomizedNotificationData
void setCustomizedNotificationData(CustomizedNotificationData data, InMeetingNotificationHandle handle) Customize meeting notification style- Parameters:
data
- the customized data itemhandle
- use can handle the callback and return to meeting activity for custom ui.
-
disableShowVideoPreviewWhenJoinMeeting
void disableShowVideoPreviewWhenJoinMeeting(boolean disableVideoPreview) Disable/Enable the video preview dialog when joining a video meeting Note: this api must be called before joining a video meeting to take effect- Parameters:
disableVideoPreview
- true: disable; false: enable
-
isDisableShowVideoPreviewWhenJoinMeeting
boolean isDisableShowVideoPreviewWhenJoinMeeting()To query whether the query dialog will be displayed when joining a video meeting- Returns:
- true: will not display; false: will display
-
disableLeaveMeetingWhenTaskRemoved
void disableLeaveMeetingWhenTaskRemoved(boolean disable) Disable/Enable leave meeting when service onTaskRemoved called.- Parameters:
disable
- true:disable false: enable. default is enable
-
enableMicOriginalInput
void enableMicOriginalInput(boolean enable) Disable/Enable mic original input.- Parameters:
enable
- true:enable
-
enableEchoCancellation
int enableEchoCancellation(boolean enable) Enable echo cancellation.- Parameters:
enable
- true means enabled, false disabled.- Returns:
- error code
MobileRTCSDKError
-
isEchoCancellationOn
boolean isEchoCancellationOn()Determine if echo cancellation is enabled or not.- Returns:
- true means supported, otherwise not.
-
isSupportEchoCancellation
boolean isSupportEchoCancellation()Determine if the meeting supports echo cancellation.- Returns:
- true means supported, otherwise not.
-
isMicOriginalInputEnable
boolean isMicOriginalInputEnable()Query is mic original input enable- Returns:
- true:enable
-
disableConfidentialWatermark
boolean disableConfidentialWatermark(boolean disable) Disable use confidential watermark- Parameters:
disable
- disable- Returns:
- true:disable success
-
disableCopyMeetingUrl
void disableCopyMeetingUrl(boolean disable) Disable use copy url for long press zoom ui meeting title bar.- Parameters:
disable
- disable
-
setReactionSkinTone
Set the emoji reaction skin tone type.- Parameters:
skinTone
-ReactionSkinToneType
-
getReactionSkinTone
ReactionSkinToneType getReactionSkinTone()Get the emoji reaction skin tone type.- Returns:
- skinTone
ReactionSkinToneType
-
setVideoAspectRatio
Set type of video aspect ratio- Parameters:
aspectRatioType
-VideoAspectRatioType
-
getVideoAspectRatio
VideoAspectRatioType getVideoAspectRatio()Get type of video aspect ratio- Returns:
- skinTone
ReactionSkinToneType
-
isMirrorEffectEnabled
boolean isMirrorEffectEnabled()Get the flag to enable/disable the video mirror effect- Returns:
- true enable, false disable
-
enableMirrorEffect
void enableMirrorEffect(boolean enable) Enable or disable video mirror effect- Parameters:
enable
- true enable, false disable
-
disableClearWebKitCache
void disableClearWebKitCache(boolean disabled) Disable the action of clear WebView's cache.- Parameters:
disabled
- Specify to disable the clear action or not.
-
isDisabledClearWebKitCache
boolean isDisabledClearWebKitCache()Query if the action of clear WebView's cache be disabled.- Returns:
- Action of clear WebView's cache is disabled or not.
-
enableCloudWhiteboard
void enableCloudWhiteboard(boolean enable) Enable or disable the new Zoom Whiteboard feature (different from Classic Whiteboard). This is enabled by default.- Parameters:
enable
- true means enabled, otherwise not.
-
setAnnotationSnapshotPathInAlbum
Set the path for saving annotation screenshots to the album- Parameters:
path
- saving annotation screenshots path
-
setAudioFocusType
set customize audio focus gain type- Parameters:
type
- audio focus gain typeAudioFocusGainType
-
enableAutoAdjustMicVolume
Deprecated.Enable auto-adjust microphone.- Parameters:
enable
- true means enabled, false means disabled.
-
isAutoAdjustMicVolumeOn
Deprecated.Determine if auto-adjust microphone is enabled or not.- Returns:
- true means enabled, otherwise it is not enabled.
-
enableUseConnectionService
void enableUseConnectionService(boolean enable) Determine if use connection service- Parameters:
enable
- true means enabled, otherwise not
-
setConfNotificationCategory
Set the category of notification for ongoing meeting.- Parameters:
category
- category of notification.
-
setActivityForShowDisclaimer
void setActivityForShowDisclaimer(android.app.Activity activity) Set the activity to show the disclaimer dialog.- Parameters:
activity
- the activity to show the disclaimer dialog.
-
hideCloudWhiteboardHelperCenterButton
void hideCloudWhiteboardHelperCenterButton(boolean bHide) Set the Helper center button's visibility on cloud whiteboard. Default is displaying.- Parameters:
bHide
- bHide true means hiding, otherwise means displaying.
-
hideCloudWhiteboardOpenInBrowserButton
void hideCloudWhiteboardOpenInBrowserButton(boolean bHide) Set the Open in browser button's visibility on cloud whiteboard. Default is displaying.- Parameters:
bHide
- bHide true means hiding, otherwise means displaying.
-
setDisclaimerBannerUIConfig
Set the disclaimer banner config.- Parameters:
config
- The UI config of the disclaimer bannerDisclaimerBannerConfig
.
-
enable5GHighBandWidth
void enable5GHighBandWidth(boolean enable) Whether to cancel 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.- Parameters:
enable
- a boolean flag to set up the behavoir.
-
setDimensionConfig
Set the dimension config.- Parameters:
type
- The type of dimensionDimensionType
.value
- The value of dimensionDimensionValue
.- Returns:
- If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails. For more details, see
MobileRTCSDKError
.
-
forceDisableCamera
void forceDisableCamera(boolean disable) Force disable camera in meeting. When disabled, SDK will not call the camera related API. Note: this can only take effect whenisCustomizedMeetingUIEnabled()
is true. This interface should be called before meeting. This interface is designed to disable the SDK's camera when the user callsZoomSDKVideoSourceHelper.setExternalVideoSource(ZoomSDKVideoSource)
- Parameters:
disable
- Whether to disable camera in a meeting. True means disable the camera related API. Otherwise don't.
-
isCameraForceDisabled
boolean isCameraForceDisabled()Query whether cameras in a meeting are forcibly disabled.- Returns:
- true means the cameras in a meeting are forcibly disabled. Otherwise they aren't.
-
enableWhiteboardVideoView
void enableWhiteboardVideoView(boolean enable) Enable the capability to show whiteboard inMobileRTCVideoView
. When enable this capability, the subscribe share can switch between whiteboard and normal share. This can only be effect whenisCustomizedMeetingUIEnabled()
is true. Call this interface before the meeting. When the capability is enabled, handleMobileRTCVideoViewManager.addWhiteboardVideoUnit()
()} andMobileRTCVideoViewManager.removeWhiteboardVideoUnit()
when the callbackInMeetingWhiteboardCtrlEvent.onWhiteboardStatusChanged(SDKWhiteboardStatus)
is received.- Parameters:
enable
- whether enable the capability to show whiteboard inMobileRTCVideoView
. True means enable this capability.
-
isWhiteboardVideoViewEnabled
boolean isWhiteboardVideoViewEnabled()Query whether the capability to show whiteboard inMobileRTCVideoView
is enabled.- Returns:
- true means the capability is enabled. Otherwise the function is disabled.
-
setPresetVBImage
set the preset virtual background image. Note: this can only take effect whenisCustomizedMeetingUIEnabled()
is true. This interface should be called before meeting.- Parameters:
resId
- the drawable resID that should be set as the virtual background image.vbKey
- the key to index the preset virtual background. If you want add a new virtual background, you should pass a new key.delete
- whether the virtual background should be deleted. true means that you want remove the previous preset virtual background image, false means that you want preset the virtual background image.
-
setPreferredAudioOutputDevice
boolean setPreferredAudioOutputDevice(android.media.AudioDeviceInfo deviceInfo) Set Prefer audio output deviceAudioManager.getDevices(int)
- Parameters:
deviceInfo
-- Returns:
-
setPreferredAudioInputDevice
boolean setPreferredAudioInputDevice(android.media.AudioDeviceInfo deviceInfo) Set Prefer audio input deviceAudioManager.getDevices(int)
- Parameters:
deviceInfo
-- Returns:
-
enableZoomDocsInCustomUI
void enableZoomDocsInCustomUI(boolean enable) Enable or disable zoom docs features in custom ui. Note: this can only take effect whenisCustomizedMeetingUIEnabled()
is true. This interface should be called before meeting. This is disabled by default. When you enable this feature, handle theInMeetingDocsController.InMeetingDocsEvent
and subscribe the docs share with theMobileRTCVideoViewManager.addDocsVideoUnit(long)
()}.- Parameters:
enable
- true means enable, otherwise disable.
-
isZoomDocsEnabledInCustomUI
boolean isZoomDocsEnabledInCustomUI()Query whether zoom docs feature is enabled in custom ui.- Returns:
- true means the feature is enabled in csutom ui, otherwise false.
-
setHideEmojiDownloadNotification
void setHideEmojiDownloadNotification()Set to hide notifications when downloading emoji.
-