Zoom meeting settings. More...

Public Member Functions
void	setAutoConnectVoIPWhenJoinMeeting (boolean enabled)
	Sets whether to connect VoIP automatically when the current user joins the meeting.
boolean	isAutoConnectVoIPWhenJoinMeetingEnabled ()
	Determines whether VoIP auto-connection is enabled when the current user joins the meeting.
void	setMuteMyMicrophoneWhenJoinMeeting (boolean enabled)
	Sets whether to mute the microphone when the current user joins the meeting.
boolean	isMuteMyMicrophoneWhenJoinMeetingEnabled ()
	Determines whether the microphone is muted when the current user joins the meeting.
void	setTurnOffMyVideoWhenJoinMeeting (boolean enabled)
	Sets whether to turn off the video when the current user joins the meeting.
boolean	isTurnOffMyVideoWhenJoinMeetingEnabled ()
	Determines whether the video is turned off when the current user joins the meeting.
void	setKubiDeviceEnabled (boolean enabled)
	Sets whether to enable Kubi device setting. If enabling Kubi, android.permission.ACCESS_FINE_LOCATION should be declared in AndroidManifest.xml.
boolean	isKubiDeviceEnabled ()
	Determines whether Kubi device is enabled. If enabling Kubi, android.permission.ACCESS_FINE_LOCATION should be declared in AndroidManifest.xml.
boolean	isHideNoVideoUsersEnabled ()
	Determines whether the option HIDE NON-VIDEO PARTICIPANTS is enabled.
void	setHideNoVideoUsersEnabled (boolean enabled)
	Sets whether to enable the option HIDE NON-VIDEO PARTICIPANTS.
boolean	isSwitchVideoLayoutAccordingToUserCountEnabled ()
	Determines whether it is able to switch video layout mode automatically between SPEAKER VIEW and GALLERY VIEW based on the number of users.
void	setSwitchVideoLayoutAccordingToUserCountEnabled (boolean enabled)
	Sets whether to enable the feature to switch video layout mode automatically between SPEAKER VIEW and GALLERY VIEW based on the number of users.
int	getSwitchVideoLayoutUserCountThreshold ()
	Get the threshold for the number of users which is used to switch the video layout automatically.
void	setSwitchVideoLayoutUserCountThreshold (int value)
	Set the threshold for the number of users which is used to switch the video layout automatically.
void	setGalleryVideoViewDisabled (boolean disabled)
	Sets whether to disable video GALLERY VIEW.
boolean	isGalleryVideoViewDisabled ()
	Determines whether DISABLE video GALLERY VIEW is enabled.
boolean	isAlwaysShowMeetingToolbarEnabled ()
	Determines whether the option ALWAYS SHOW MEETING CONTROLS is enabled.
void	setAlwaysShowMeetingToolbarEnabled (boolean enabled)
	Sets whether to enable the option ALWAYS SHOW MEETING CONTROLS.
boolean	isNoVideoTileOnShareScreenEnabled ()
	Determines whether NO VIDEO TILE ON SHARE SCREEN is enabled.
void	setNoVideoTileOnShareScreenEnabled (boolean enabled)
	Sets whether to enable the option NO MEETING TILE ON SHARED SCREEN.
boolean	isNoLeaveMeetingButtonForHostEnabled ()
	Determines whether hiding the leaving button on the dialog when the host leaves the meeting is enabled.
void	setNoLeaveMeetingButtonForHostEnabled (boolean enabled)
	Sets whether to hide the leaving button on the dialog when the host leaves the meeting.
boolean	isNoUserJoinOrLeaveTipEnabled ()
	Determines whether the tips, NO USER JOINS or LEAVES, is enabled.
void	setNoUserJoinOrLeaveTipEnabled (boolean enabled)
	Sets whether to enable the tips, NO USER JOINS OR LEAVES.
boolean	isCustomizedMeetingUIEnabled ()
	Determines whether USE CUSTOM MEETING UI is enabled.
void	setCustomizedMeetingUIEnabled (boolean enabled)
	Sets whether to enable the option USE CUSTOM MEETING UI.
void	setConfNotificationChannelId (String channelId)
	Set the channel ID of notification for ongoing meeting.
void	setClaimHostWithHostKeyActionEnabled (boolean enabled)
	Sets whether CLAIM HOST with host key in the meeting is enabled.
void	setNoInviteH323RoomCallOutEnabled (boolean enabled)
	Sets whether to disable invitation from H.323 Room System.
void	setNoInviteH323RoomCallInEnabled (boolean enabled)
	Sets whether to disable invitation from H.323 Room System.
void	setClosedCaptionHidden (boolean bHide)
	Sets whether to hide the closed caption on the main video. Default value: hide.
boolean	isHideClosedCaption ()
	Determines whether HIDE CLOSED CAPTION on the main video is enabled.
void	enableForceAutoStartMyVideoWhenJoinMeeting (boolean bEnable)
	Sets whether it is able to force participants to start video when joining the meeting.
void	enableForceAutoStopMyVideoWhenJoinMeeting (boolean bEnable)
	Sets whether it is able to force participants to turn off video when joining the meeting.
void	disableAutoShowSelectJoinAudioDlgWhenJoinMeeting (boolean bDisable)
	Sets the visibility of the dialog SELECT JOIN AUDIO when joining the meeting.
void	disableShowMeetingNotification (boolean bDisable)
	Sets whether to disable SHOW MEETING NOTIFICATION.
void	enable720p (boolean enable)
	Sets whether to enable 720p. It is only supported on devices with at least 4 gold cores.
boolean	is720PEnabled ()
	Determines whether 720p is enabled. It is only supported on devices with at least 4 gold cores.
void	enable1080p (boolean enable)
	Sets whether to enable 1080p. It is only supported on special devices.
boolean	is1080pEnabled ()
	Determines whether 1080p is enabled. It is only supported on special devices.
void	disableChatUI (boolean disable)
	Disable chat ui for zoom ui.
void	hideAnnotationInScreenShareToolbar (boolean hideAnnotation)
	Hide annotation button in screen share toolbar,for sdk screen share.
boolean	isHideAnnotationInScreenShareToolbar ()
	Determines whether the annotation button is hidden in the screen share toolbar.
void	hideStopShareInScreenShareToolbar (boolean hideStopShare)
	Hides or shows the stopshare button in the screen share toolbar. For SDK screen share.
boolean	isHideStopShareInScreenShareToolbar ()
	Determines whether the stopshare button is hidden in the screen share toolbar.
void	setConfNotificationPriority (int priority)
	set the priority of the ongoing meeting notification
void	hiddenQA (boolean hiddenQA)
	Hidden question and answer feature for zoom ui.
void	hiddenPoll (boolean hiddenPoll)
	Hidden poll feature for zoom ui.
void	enableShowMyMeetingElapseTime (boolean show)
	Enable show meeting elapse time.
boolean	isShowMyMeetingElapseTimeEnabled ()
	Query is enable show meeting elapse time.
void	setCustomizedNotificationData (CustomizedNotificationData data, InMeetingNotificationHandle handle)
	Customize meeting notification style.
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.
boolean	isDisableShowVideoPreviewWhenJoinMeeting ()
	To query whether the query dialog will be displayed when joining a video meeting.
void	disableLeaveMeetingWhenTaskRemoved (boolean disable)
	Disable/Enable leave meeting when service onTaskRemoved called.
void	enableMicOriginalInput (boolean enable)
	Disable/Enable mic original input.
int	enableEchoCancellation (boolean enable)
	Enable echo cancellation.
boolean	isEchoCancellationOn ()
	Determines if echo cancellation is enabled or not.
boolean	isSupportEchoCancellation ()
	Determines if the meeting supports echo cancellation.
boolean	isMicOriginalInputEnable ()
	Query is mic original input enable.
boolean	disableConfidentialWatermark (boolean disable)
	Disable use confidential watermark.
void	disableCopyMeetingUrl (boolean disable)
	Disable use copy url for long press zoom ui meeting title bar.
void	setReactionSkinTone (ReactionSkinToneType skinTone)
	Set the emoji reaction skin tone type.
ReactionSkinToneType	getReactionSkinTone ()
	Get the emoji reaction skin tone type.
void	setVideoAspectRatio (VideoAspectRatioType aspectRatioType)
	Set type of video aspect ratio.
VideoAspectRatioType	getVideoAspectRatio ()
	Get type of video aspect ratio.
boolean	isMirrorEffectEnabled ()
	Get the flag to enable/disable the video mirror effect.
void	enableMirrorEffect (boolean enable)
	Enable or disable video mirror effect.
void	disableClearWebKitCache (boolean disabled)
	Disable the action of clear WebView's cache.
boolean	isDisabledClearWebKitCache ()
	Query if the action of clear WebView's cache be disabled.
void	enableCloudWhiteboard (boolean enable)
	Enable or disable the new Zoom Whiteboard feature (different from Classic Whiteboard). This is enabled by default.
void	setAnnotationSnapshotPathInAlbum (String path)
	Set the path for saving annotation screenshots to the album.
void	enableGreenBorderForShareScreen (boolean enable)
	enable or disable showing the green border when screen sharing.
boolean	isGreenBorderEnableForShareScreen ()
	Query if enabling or disabling showing the green border when screen sharing.
void	setAudioFocusType (AudioFocusGainType type)
	set customize audio focus gain type
void	enableAutoAdjustMicVolume (boolean enable)
	Enable auto-adjust microphone.
boolean	isAutoAdjustMicVolumeOn ()
	Determines if auto-adjust microphone is enabled or not.
void	enableUseConnectionService (boolean enable)
	Determines if use connection service.
void	setConfNotificationCategory (String category)
	Set the category of notification for ongoing meeting.
void	setHideShareButtonInMeetingToolbar (boolean bHide)
	Set hide share button in meeting toolbar.
void	setActivityForShowDisclaimer (Activity activity)
	Set the activity to show the disclaimer dialog.
void	enableGrabShareWithoutReminder (boolean 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: false (prompt).
void	hideCloudWhiteboardHelperCenterButton (boolean bHide)
	Set the Helper center button's visibility on cloud whiteboard. Default is displaying.
void	hideCloudWhiteboardOpenInBrowserButton (boolean bHide)
	Set the Open in browser button's visibility on cloud whiteboard. Default is displaying.
void	setDisclaimerBannerUIConfig (DisclaimerBannerConfig config)
	Set the disclaimer banner config.
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.
MobileRTCSDKError	setDimensionConfig (DimensionType type, DimensionValue value)
	Set the dimension config.
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 when `isCustomizedMeetingUIEnabled()` is true. This interface should be called before meeting. This interface is designed to disable the SDK's camera when the user calls `ZoomSDKVideoSourceHelper#setExternalVideoSource(ZoomSDKVideoSource)`.
boolean	isCameraForceDisabled ()
	Query whether cameras in a meeting are forcibly disabled.
void	enableWhiteboardVideoView (boolean enable)
	Enable the capability to show whiteboard in `MobileRTCVideoView`. When enable this capability, the subscribe share can switch between whiteboard and normal share. This can only be effect when `isCustomizedMeetingUIEnabled()` is true. Call this interface before the meeting.
boolean	isWhiteboardVideoViewEnabled ()
	Query whether the capability to show whiteboard in `MobileRTCVideoView` is enabled.
void	setPresetVBImage (@DrawableRes int resId, String vbKey, boolean delete)
	set the preset virtual background image. Note: this can only take effect when `isCustomizedMeetingUIEnabled()` is true. This interface should be called before meeting.
boolean	setPreferredAudioOutputDevice (AudioDeviceInfo deviceInfo)
	Set Prefer audio output device `android.media.AudioManager#getDevices(int)`.
boolean	setPreferredAudioInputDevice (AudioDeviceInfo deviceInfo)
	Set Prefer audio input device `android.media.AudioManager#getDevices(int)`.
void	enableZoomDocsInCustomUI (boolean enable)
	Enable or disable zoom docs features in custom ui. Note: this can only take effect when `isCustomizedMeetingUIEnabled()` is true. This interface should be called before meeting. This is disabled by default. When you enable this feature, handle the `InMeetingDocsController.InMeetingDocsEvent` and subscribe the docs share with the `MobileRTCVideoViewManager#addDocsVideoUnit(long)` ()}.
boolean	isZoomDocsEnabledInCustomUI ()
	Query whether zoom docs feature is enabled in custom ui.
void	setHideEmojiDownloadNotification ()
	Set to hide notifications when downloading emoji.
void	enableShareContentFlashDetection (boolean enable)
	Enable or disable automatic dimming when sharing content. When enabled, the video is automatically dimmed when the shared content contains flashing elements.
boolean	isShareContentFlashDetectionEnabled ()
	Query whether automatic dimming of video when sharing content flashes is enabled.

Static Public Attributes
static final String	ANTIBANDING_50HZ = "50hz"
static final String	ANTIBANDING_60HZ = "60hz"
static final String	ANTIBANDING_AUTO = "auto"
static final String	ANTIBANDING_OFF = "off"

Detailed Description

Zoom meeting settings.

Definition at line 13 of file MeetingSettingsHelper.java.

Member Function Documentation

◆ disableAutoShowSelectJoinAudioDlgWhenJoinMeeting()

void us.zoom.sdk.MeetingSettingsHelper.disableAutoShowSelectJoinAudioDlgWhenJoinMeeting ( boolean bDisable )

Sets the visibility of the dialog SELECT JOIN AUDIO when joining the meeting.

Parameters

bDisable true to hide, false to display.

◆ disableChatUI()

void us.zoom.sdk.MeetingSettingsHelper.disableChatUI ( boolean disable )

Disable chat ui for zoom ui.

Parameters

disable default false

◆ disableClearWebKitCache()

void us.zoom.sdk.MeetingSettingsHelper.disableClearWebKitCache ( boolean disabled )

Disable the action of clear WebView's cache.

Parameters

disabled Specify to disable the clear action or not.

◆ disableConfidentialWatermark()

boolean us.zoom.sdk.MeetingSettingsHelper.disableConfidentialWatermark ( boolean disable )

Disable use confidential watermark.

Parameters

disable disable

Returns: true:disable success

◆ disableCopyMeetingUrl()

void us.zoom.sdk.MeetingSettingsHelper.disableCopyMeetingUrl ( boolean disable )

Disable use copy url for long press zoom ui meeting title bar.

Parameters

disable disable

◆ disableLeaveMeetingWhenTaskRemoved()

void us.zoom.sdk.MeetingSettingsHelper.disableLeaveMeetingWhenTaskRemoved ( boolean disable )

Disable/Enable leave meeting when service onTaskRemoved called.

Parameters

disable true:disable false: enable. default is enable

◆ disableShowMeetingNotification()

void us.zoom.sdk.MeetingSettingsHelper.disableShowMeetingNotification ( boolean bDisable )

Sets whether to disable SHOW MEETING NOTIFICATION.

Note: disableShowMeetingNotification(true) works only for 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 true to disable, false otherwise.

◆ disableShowVideoPreviewWhenJoinMeeting()

void us.zoom.sdk.MeetingSettingsHelper.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

◆ enable1080p()

void us.zoom.sdk.MeetingSettingsHelper.enable1080p ( boolean enable )

Sets whether to enable 1080p. It is only supported on special devices.

Parameters

enable true to enable, false otherwise.

◆ enable5GHighBandWidth()

void us.zoom.sdk.MeetingSettingsHelper.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.

◆ enable720p()

void us.zoom.sdk.MeetingSettingsHelper.enable720p ( boolean enable )

Sets whether to enable 720p. It is only supported on devices with at least 4 gold cores.

Note: Suggested CPU: Qualcomm Snapdragon 660 or above.

Parameters

enable true to enable, false otherwise.

◆ enableAutoAdjustMicVolume()

void us.zoom.sdk.MeetingSettingsHelper.enableAutoAdjustMicVolume ( boolean enable )

Enable auto-adjust microphone.

Parameters

enable YES means enabled, NO disabled.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

Enable auto-adjust microphone.

Parameters

enable true means enabled, false means disabled.

◆ enableCloudWhiteboard()

void us.zoom.sdk.MeetingSettingsHelper.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.

◆ enableEchoCancellation()

int us.zoom.sdk.MeetingSettingsHelper.enableEchoCancellation ( boolean enable )

Enable echo cancellation.

Parameters

enable true means enabled, false disabled.

Returns: If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ enableForceAutoStartMyVideoWhenJoinMeeting()

void us.zoom.sdk.MeetingSettingsHelper.enableForceAutoStartMyVideoWhenJoinMeeting ( boolean bEnable )

Sets whether it is able to force participants to start video when joining the meeting.

Parameters

bEnable true to enable, false to disable.

◆ enableForceAutoStopMyVideoWhenJoinMeeting()

void us.zoom.sdk.MeetingSettingsHelper.enableForceAutoStopMyVideoWhenJoinMeeting ( boolean bEnable )

Sets whether it is able to force participants to turn off video when joining the meeting.

Parameters

bEnable true to enable, false to disable.

◆ enableGrabShareWithoutReminder()

void us.zoom.sdk.MeetingSettingsHelper.enableGrabShareWithoutReminder ( boolean 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: false (prompt).

Parameters

enable true to indicate no prompt, false otherwise.

◆ enableGreenBorderForShareScreen()

void us.zoom.sdk.MeetingSettingsHelper.enableGreenBorderForShareScreen ( boolean enable )

enable or disable showing the green border when screen sharing.

Parameters

enable true means enabled, otherwise not.

◆ enableMicOriginalInput()

void us.zoom.sdk.MeetingSettingsHelper.enableMicOriginalInput ( boolean enable )

Disable/Enable mic original input.

Parameters

enable true:enable

◆ enableMirrorEffect()

void us.zoom.sdk.MeetingSettingsHelper.enableMirrorEffect ( boolean enable )

Enable or disable video mirror effect.

Parameters

enable true enable, false disable

◆ enableShareContentFlashDetection()

void us.zoom.sdk.MeetingSettingsHelper.enableShareContentFlashDetection ( boolean enable )

Enable or disable automatic dimming when sharing content. When enabled, the video is automatically dimmed when the shared content contains flashing elements.

Parameters

enable true to enable automatic dimming, false to disable.

◆ enableShowMyMeetingElapseTime()

void us.zoom.sdk.MeetingSettingsHelper.enableShowMyMeetingElapseTime ( boolean show )

Enable show meeting elapse time.

Parameters

show	true show false hidden

◆ enableUseConnectionService()

void us.zoom.sdk.MeetingSettingsHelper.enableUseConnectionService ( boolean enable )

Determines if use connection service.

Parameters

enable true means enabled, otherwise not

◆ enableWhiteboardVideoView()

void us.zoom.sdk.MeetingSettingsHelper.enableWhiteboardVideoView ( boolean enable )

Enable the capability to show whiteboard in MobileRTCVideoView. When enable this capability, the subscribe share can switch between whiteboard and normal share. This can only be effect when isCustomizedMeetingUIEnabled() is true. Call this interface before the meeting.

When the capability is enabled, handle MobileRTCVideoViewManager#addWhiteboardVideoUnit() ()} and MobileRTCVideoViewManager#removeWhiteboardVideoUnit() when the callback InMeetingWhiteboardCtrlEvent#onWhiteboardStatusChanged(SDKWhiteboardStatus) is received.

Parameters

enable whether enable the capability to show whiteboard in MobileRTCVideoView. True means enable this capability.

◆ enableZoomDocsInCustomUI()

void us.zoom.sdk.MeetingSettingsHelper.enableZoomDocsInCustomUI ( boolean enable )

Enable or disable zoom docs features in custom ui. Note: this can only take effect when isCustomizedMeetingUIEnabled() is true. This interface should be called before meeting. This is disabled by default. When you enable this feature, handle the InMeetingDocsController.InMeetingDocsEvent and subscribe the docs share with the MobileRTCVideoViewManager#addDocsVideoUnit(long) ()}.

Parameters

enable true means enable, otherwise disable.

◆ forceDisableCamera()

void us.zoom.sdk.MeetingSettingsHelper.forceDisableCamera ( boolean disable )

Force disable camera in meeting. When disabled, SDK will not call the camera related API. Note: this can only take effect when isCustomizedMeetingUIEnabled() is true. This interface should be called before meeting. This interface is designed to disable the SDK's camera when the user calls ZoomSDKVideoSourceHelper#setExternalVideoSource(ZoomSDKVideoSource).

Parameters

disable Whether to disable camera in a meeting. True means disable the camera related API. Otherwise don't.

◆ getReactionSkinTone()

ReactionSkinToneType us.zoom.sdk.MeetingSettingsHelper.getReactionSkinTone ( )

Get the emoji reaction skin tone type.

Returns: skinTone ReactionSkinToneType

◆ getSwitchVideoLayoutUserCountThreshold()

int us.zoom.sdk.MeetingSettingsHelper.getSwitchVideoLayoutUserCountThreshold ( )

Get the threshold for the number of users which is used to switch the video layout automatically.

Returns: The threshold value.

◆ getVideoAspectRatio()

VideoAspectRatioType us.zoom.sdk.MeetingSettingsHelper.getVideoAspectRatio ( )

Get type of video aspect ratio.

Returns: skinTone ReactionSkinToneType

◆ hiddenPoll()

void us.zoom.sdk.MeetingSettingsHelper.hiddenPoll ( boolean hiddenPoll )

Hidden poll feature for zoom ui.

Parameters

hiddenPoll true hidden

References hiddenPoll().

Referenced by hiddenPoll().

◆ hiddenQA()

void us.zoom.sdk.MeetingSettingsHelper.hiddenQA ( boolean hiddenQA )

Hidden question and answer feature for zoom ui.

Parameters

hiddenQA true hidden

References hiddenQA().

Referenced by hiddenQA().

◆ hideAnnotationInScreenShareToolbar()

void us.zoom.sdk.MeetingSettingsHelper.hideAnnotationInScreenShareToolbar ( boolean hideAnnotation )

Hide annotation button in screen share toolbar,for sdk screen share.

Parameters

hideAnnotation default false

◆ hideCloudWhiteboardHelperCenterButton()

void us.zoom.sdk.MeetingSettingsHelper.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 us.zoom.sdk.MeetingSettingsHelper.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.

◆ hideStopShareInScreenShareToolbar()

void us.zoom.sdk.MeetingSettingsHelper.hideStopShareInScreenShareToolbar ( boolean hideStopShare )

Hides or shows the stopshare button in the screen share toolbar. For SDK screen share.

Parameters

hideStopShare true to hide, false to show. Default is false.

◆ is1080pEnabled()

boolean us.zoom.sdk.MeetingSettingsHelper.is1080pEnabled ( )

Determines whether 1080p is enabled. It is only supported on special devices.

Returns: true if enabled. Otherwise, false.

◆ is720PEnabled()

boolean us.zoom.sdk.MeetingSettingsHelper.is720PEnabled ( )

Determines whether 720p is enabled. It is only supported on devices with at least 4 gold cores.

Returns: true if enabled. Otherwise, false.

◆ isAlwaysShowMeetingToolbarEnabled()

boolean us.zoom.sdk.MeetingSettingsHelper.isAlwaysShowMeetingToolbarEnabled ( )

Determines whether the option ALWAYS SHOW MEETING CONTROLS is enabled.

Returns: true if the feature is enabled. Otherwise, false.

◆ isAutoAdjustMicVolumeOn()

boolean us.zoom.sdk.MeetingSettingsHelper.isAutoAdjustMicVolumeOn ( )

Determines if auto-adjust microphone is enabled or not.

Returns: true means enabled, otherwise it is not enabled.

◆ isAutoConnectVoIPWhenJoinMeetingEnabled()

boolean us.zoom.sdk.MeetingSettingsHelper.isAutoConnectVoIPWhenJoinMeetingEnabled ( )

Determines whether VoIP auto-connection is enabled when the current user joins the meeting.

Returns: true if VoIP auto-connection is enabled. Otherwise, false.

◆ isCameraForceDisabled()

boolean us.zoom.sdk.MeetingSettingsHelper.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.

◆ isCustomizedMeetingUIEnabled()

boolean us.zoom.sdk.MeetingSettingsHelper.isCustomizedMeetingUIEnabled ( )

Determines whether USE CUSTOM MEETING UI is enabled.

Returns: true if enabled. Otherwise, false.

◆ isDisabledClearWebKitCache()

boolean us.zoom.sdk.MeetingSettingsHelper.isDisabledClearWebKitCache ( )

Query if the action of clear WebView's cache be disabled.

Returns: Action of clear WebView's cache is disabled or not.

◆ isDisableShowVideoPreviewWhenJoinMeeting()

boolean us.zoom.sdk.MeetingSettingsHelper.isDisableShowVideoPreviewWhenJoinMeeting ( )

To query whether the query dialog will be displayed when joining a video meeting.

Returns: true: will not display; false: will display

◆ isEchoCancellationOn()

boolean us.zoom.sdk.MeetingSettingsHelper.isEchoCancellationOn ( )

Determines if echo cancellation is enabled or not.

Returns: true means supported, otherwise not.

◆ isGalleryVideoViewDisabled()

boolean us.zoom.sdk.MeetingSettingsHelper.isGalleryVideoViewDisabled ( )

Determines whether DISABLE video GALLERY VIEW is enabled.

Returns: true if the feature is enabled. Otherwise, false.

◆ isGreenBorderEnableForShareScreen()

boolean us.zoom.sdk.MeetingSettingsHelper.isGreenBorderEnableForShareScreen ( )

Query if enabling or disabling showing the green border when screen sharing.

Returns: true means enabled. Otherwise, it is disabled.

◆ isHideAnnotationInScreenShareToolbar()

boolean us.zoom.sdk.MeetingSettingsHelper.isHideAnnotationInScreenShareToolbar ( )

Determines whether the annotation button is hidden in the screen share toolbar.

Returns: true if hidden. Otherwise, false.

◆ isHideClosedCaption()

boolean us.zoom.sdk.MeetingSettingsHelper.isHideClosedCaption ( )

Determines whether HIDE CLOSED CAPTION on the main video is enabled.

Returns: true if enabled. Otherwise, false.

◆ isHideNoVideoUsersEnabled()

boolean us.zoom.sdk.MeetingSettingsHelper.isHideNoVideoUsersEnabled ( )

Determines whether the option HIDE NON-VIDEO PARTICIPANTS is enabled.

Returns: true if enabled. Otherwise, false.

◆ isHideStopShareInScreenShareToolbar()

boolean us.zoom.sdk.MeetingSettingsHelper.isHideStopShareInScreenShareToolbar ( )

Determines whether the stopshare button is hidden in the screen share toolbar.

Returns: true if hidden. Otherwise, false.

◆ isKubiDeviceEnabled()

boolean us.zoom.sdk.MeetingSettingsHelper.isKubiDeviceEnabled ( )

Determines whether Kubi device is enabled. If enabling Kubi, android.permission.ACCESS_FINE_LOCATION should be declared in AndroidManifest.xml.

Returns: true if the feature is enabled. Otherwise, false.

◆ isMicOriginalInputEnable()

boolean us.zoom.sdk.MeetingSettingsHelper.isMicOriginalInputEnable ( )

Query is mic original input enable.

Returns: true:enable

◆ isMirrorEffectEnabled()

boolean us.zoom.sdk.MeetingSettingsHelper.isMirrorEffectEnabled ( )

Get the flag to enable/disable the video mirror effect.

Returns: true enable, false disable

◆ isMuteMyMicrophoneWhenJoinMeetingEnabled()

boolean us.zoom.sdk.MeetingSettingsHelper.isMuteMyMicrophoneWhenJoinMeetingEnabled ( )

Determines whether the microphone is muted when the current user joins the meeting.

Returns: true if the feature is enabled. Otherwise, false.

◆ isNoLeaveMeetingButtonForHostEnabled()

boolean us.zoom.sdk.MeetingSettingsHelper.isNoLeaveMeetingButtonForHostEnabled ( )

Determines whether hiding the leaving button on the dialog when the host leaves the meeting is enabled.

Returns: true if enabled. Otherwise, false.

◆ isNoUserJoinOrLeaveTipEnabled()

boolean us.zoom.sdk.MeetingSettingsHelper.isNoUserJoinOrLeaveTipEnabled ( )

Determines whether the tips, NO USER JOINS or LEAVES, is enabled.

Returns: true if enabled. Otherwise, false.

◆ isNoVideoTileOnShareScreenEnabled()

boolean us.zoom.sdk.MeetingSettingsHelper.isNoVideoTileOnShareScreenEnabled ( )

Determines whether NO VIDEO TILE ON SHARE SCREEN is enabled.

Returns: true if enabled. Otherwise, false.

◆ isShareContentFlashDetectionEnabled()

boolean us.zoom.sdk.MeetingSettingsHelper.isShareContentFlashDetectionEnabled ( )

Query whether automatic dimming of video when sharing content flashes is enabled.

Returns: true if the feature is enabled, false if the feature is not enabled.

◆ isShowMyMeetingElapseTimeEnabled()

boolean us.zoom.sdk.MeetingSettingsHelper.isShowMyMeetingElapseTimeEnabled ( )

Query is enable show meeting elapse time.

Returns: true enable show

◆ isSupportEchoCancellation()

boolean us.zoom.sdk.MeetingSettingsHelper.isSupportEchoCancellation ( )

Determines if the meeting supports echo cancellation.

Returns: true means supported, otherwise not.

◆ isSwitchVideoLayoutAccordingToUserCountEnabled()

boolean us.zoom.sdk.MeetingSettingsHelper.isSwitchVideoLayoutAccordingToUserCountEnabled ( )

Determines whether it is able to switch video layout mode automatically between SPEAKER VIEW and GALLERY VIEW based on the number of users.

Returns: true if it is able to switch. Otherwise, false.

◆ isTurnOffMyVideoWhenJoinMeetingEnabled()

boolean us.zoom.sdk.MeetingSettingsHelper.isTurnOffMyVideoWhenJoinMeetingEnabled ( )

Determines whether the video is turned off when the current user joins the meeting.

Returns: true if the feature is enabled. Otherwise, false.

◆ isWhiteboardVideoViewEnabled()

boolean us.zoom.sdk.MeetingSettingsHelper.isWhiteboardVideoViewEnabled ( )

Query whether the capability to show whiteboard in MobileRTCVideoView is enabled.

Returns: true means the capability is enabled. Otherwise the function is disabled.

◆ isZoomDocsEnabledInCustomUI()

boolean us.zoom.sdk.MeetingSettingsHelper.isZoomDocsEnabledInCustomUI ( )

Query whether zoom docs feature is enabled in custom ui.

Returns: true means the feature is enabled in csutom ui, otherwise false.

◆ setActivityForShowDisclaimer()

void us.zoom.sdk.MeetingSettingsHelper.setActivityForShowDisclaimer ( Activity activity )

Set the activity to show the disclaimer dialog.

Parameters

activity the activity to show the disclaimer dialog.

◆ setAlwaysShowMeetingToolbarEnabled()

void us.zoom.sdk.MeetingSettingsHelper.setAlwaysShowMeetingToolbarEnabled ( boolean enabled )

Sets whether to enable the option ALWAYS SHOW MEETING CONTROLS.

Parameters

enabled true to enable, false otherwise.

◆ setAnnotationSnapshotPathInAlbum()

void us.zoom.sdk.MeetingSettingsHelper.setAnnotationSnapshotPathInAlbum ( String path )

Set the path for saving annotation screenshots to the album.

Parameters

path	saving annotation screenshots path

◆ setAudioFocusType()

void us.zoom.sdk.MeetingSettingsHelper.setAudioFocusType ( AudioFocusGainType type )

set customize audio focus gain type

Parameters

type	audio focus gain type `AudioFocusGainType`

◆ setAutoConnectVoIPWhenJoinMeeting()

void us.zoom.sdk.MeetingSettingsHelper.setAutoConnectVoIPWhenJoinMeeting ( boolean enabled )

Sets whether to connect VoIP automatically when the current user joins the meeting.

Parameters

enabled true to connect audio automatically, false otherwise.

◆ setClaimHostWithHostKeyActionEnabled()

void us.zoom.sdk.MeetingSettingsHelper.setClaimHostWithHostKeyActionEnabled ( boolean enabled )

Sets whether CLAIM HOST with host key in the meeting is enabled.

Parameters

enabled true to enable, false to disable.

◆ setClosedCaptionHidden()

void us.zoom.sdk.MeetingSettingsHelper.setClosedCaptionHidden ( boolean bHide )

Sets whether to hide the closed caption on the main video. Default value: hide.

Parameters

bHide true to hide, false to display.

◆ setConfNotificationCategory()

void us.zoom.sdk.MeetingSettingsHelper.setConfNotificationCategory ( String category )

Set the category of notification for ongoing meeting.

Parameters

category category of notification.

◆ setConfNotificationChannelId()

void us.zoom.sdk.MeetingSettingsHelper.setConfNotificationChannelId ( String channelId )

Set the channel ID of notification for ongoing meeting.

Parameters

channelId Channel ID of notification.

◆ setConfNotificationPriority()

void us.zoom.sdk.MeetingSettingsHelper.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 by NotificationCompat. Acceptable values range from NotificationCompat#PRIORITY_MIN (-2) to NotificationCompat#PRIORITY_MAX (2).

◆ setCustomizedMeetingUIEnabled()

void us.zoom.sdk.MeetingSettingsHelper.setCustomizedMeetingUIEnabled ( boolean enabled )

Sets whether to enable the option USE CUSTOM MEETING UI.

Note: The feature must be enabled in the user SDK account if they want to use the custom meeting UI. Must be set before the meeting.

Parameters

enabled true to enable, false to disable.

◆ setCustomizedNotificationData()

void us.zoom.sdk.MeetingSettingsHelper.setCustomizedNotificationData	(	CustomizedNotificationData	data,
		InMeetingNotificationHandle	handle )

Customize meeting notification style.

Parameters

data	the customized data item
handle	use can handle the callback and return to meeting activity for custom ui.

◆ setDimensionConfig()

MobileRTCSDKError us.zoom.sdk.MeetingSettingsHelper.setDimensionConfig	(	DimensionType	type,
		DimensionValue	value )

Set the dimension config.

Parameters

type	The type of dimension`DimensionType`.
value	The value of dimension`DimensionValue`.

Returns: If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ setDisclaimerBannerUIConfig()

void us.zoom.sdk.MeetingSettingsHelper.setDisclaimerBannerUIConfig ( DisclaimerBannerConfig config )

Set the disclaimer banner config.

Parameters

config The UI config of the disclaimer banner DisclaimerBannerConfig.

◆ setGalleryVideoViewDisabled()

void us.zoom.sdk.MeetingSettingsHelper.setGalleryVideoViewDisabled ( boolean disabled )

Sets whether to disable video GALLERY VIEW.

Parameters

disabled true to disable video gallery view, false otherwise.

◆ setHideEmojiDownloadNotification()

void us.zoom.sdk.MeetingSettingsHelper.setHideEmojiDownloadNotification ( )

Set to hide notifications when downloading emoji.

◆ setHideNoVideoUsersEnabled()

void us.zoom.sdk.MeetingSettingsHelper.setHideNoVideoUsersEnabled ( boolean enabled )

Sets whether to enable the option HIDE NON-VIDEO PARTICIPANTS.

Parameters

enabled true to enable, false otherwise.

◆ setHideShareButtonInMeetingToolbar()

void us.zoom.sdk.MeetingSettingsHelper.setHideShareButtonInMeetingToolbar ( boolean bHide )

Set hide share button in meeting toolbar.

Parameters

bHide true to hide

◆ setKubiDeviceEnabled()

void us.zoom.sdk.MeetingSettingsHelper.setKubiDeviceEnabled ( boolean enabled )

Sets whether to enable Kubi device setting. If enabling Kubi, android.permission.ACCESS_FINE_LOCATION should be declared in AndroidManifest.xml.

Parameters

enabled true to enable, false otherwise.

◆ setMuteMyMicrophoneWhenJoinMeeting()

void us.zoom.sdk.MeetingSettingsHelper.setMuteMyMicrophoneWhenJoinMeeting ( boolean enabled )

Sets whether to mute the microphone when the current user joins the meeting.

Parameters

enabled true to enable the feature, false otherwise.

◆ setNoInviteH323RoomCallInEnabled()

void us.zoom.sdk.MeetingSettingsHelper.setNoInviteH323RoomCallInEnabled ( boolean enabled )

Sets whether to disable invitation from H.323 Room System.

Parameters

enabled true to disable the notification, false otherwise.

◆ setNoInviteH323RoomCallOutEnabled()

void us.zoom.sdk.MeetingSettingsHelper.setNoInviteH323RoomCallOutEnabled ( boolean enabled )

Sets whether to disable invitation from H.323 Room System.

Parameters

enabled true to disable the notification, false otherwise.

◆ setNoLeaveMeetingButtonForHostEnabled()

void us.zoom.sdk.MeetingSettingsHelper.setNoLeaveMeetingButtonForHostEnabled ( boolean enabled )

Sets whether to hide the leaving button on the dialog when the host leaves the meeting.

Parameters

enabled true to enable, false to disable.

◆ setNoUserJoinOrLeaveTipEnabled()

void us.zoom.sdk.MeetingSettingsHelper.setNoUserJoinOrLeaveTipEnabled ( boolean enabled )

Sets whether to enable the tips, NO USER JOINS OR LEAVES.

Parameters

enabled true to enable, false otherwise.

◆ setNoVideoTileOnShareScreenEnabled()

void us.zoom.sdk.MeetingSettingsHelper.setNoVideoTileOnShareScreenEnabled ( boolean enabled )

Sets whether to enable the option NO MEETING TILE ON SHARED SCREEN.

Parameters

enabled true to enable, false to disable.

◆ setPreferredAudioInputDevice()

boolean us.zoom.sdk.MeetingSettingsHelper.setPreferredAudioInputDevice ( AudioDeviceInfo deviceInfo )

Set Prefer audio input device android.media.AudioManager#getDevices(int).

Parameters

deviceInfo

Returns

◆ setPreferredAudioOutputDevice()

boolean us.zoom.sdk.MeetingSettingsHelper.setPreferredAudioOutputDevice ( AudioDeviceInfo deviceInfo )

Set Prefer audio output device android.media.AudioManager#getDevices(int).

Parameters

deviceInfo

Returns

◆ setPresetVBImage()

void us.zoom.sdk.MeetingSettingsHelper.setPresetVBImage	(	@DrawableRes int	resId,
		String	vbKey,
		boolean	delete )

set the preset virtual background image. Note: this can only take effect when isCustomizedMeetingUIEnabled() 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.

◆ setReactionSkinTone()

void us.zoom.sdk.MeetingSettingsHelper.setReactionSkinTone ( ReactionSkinToneType skinTone )

Set the emoji reaction skin tone type.

Parameters

skinTone ReactionSkinToneType

◆ setSwitchVideoLayoutAccordingToUserCountEnabled()

void us.zoom.sdk.MeetingSettingsHelper.setSwitchVideoLayoutAccordingToUserCountEnabled ( boolean enabled )

Sets 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 to enable, false otherwise.

◆ setSwitchVideoLayoutUserCountThreshold()

void us.zoom.sdk.MeetingSettingsHelper.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.

◆ setTurnOffMyVideoWhenJoinMeeting()

void us.zoom.sdk.MeetingSettingsHelper.setTurnOffMyVideoWhenJoinMeeting ( boolean enabled )

Sets whether to turn off the video when the current user joins the meeting.

Parameters

enabled true to enable the feature, false otherwise.

◆ setVideoAspectRatio()

void us.zoom.sdk.MeetingSettingsHelper.setVideoAspectRatio ( VideoAspectRatioType aspectRatioType )

Set type of video aspect ratio.

Parameters

aspectRatioType VideoAspectRatioType

Field Documentation

◆ ANTIBANDING_50HZ

final String us.zoom.sdk.MeetingSettingsHelper.ANTIBANDING_50HZ = "50hz"

static

Definition at line 15 of file MeetingSettingsHelper.java.

◆ ANTIBANDING_60HZ

final String us.zoom.sdk.MeetingSettingsHelper.ANTIBANDING_60HZ = "60hz"

static

Definition at line 16 of file MeetingSettingsHelper.java.

◆ ANTIBANDING_AUTO

final String us.zoom.sdk.MeetingSettingsHelper.ANTIBANDING_AUTO = "auto"

static

Definition at line 17 of file MeetingSettingsHelper.java.

◆ ANTIBANDING_OFF

final String us.zoom.sdk.MeetingSettingsHelper.ANTIBANDING_OFF = "off"

static

Definition at line 18 of file MeetingSettingsHelper.java.

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ disableAutoShowSelectJoinAudioDlgWhenJoinMeeting()

◆ disableChatUI()

◆ disableClearWebKitCache()

◆ disableConfidentialWatermark()

◆ disableCopyMeetingUrl()

◆ disableLeaveMeetingWhenTaskRemoved()

◆ disableShowMeetingNotification()

◆ disableShowVideoPreviewWhenJoinMeeting()

◆ enable1080p()

◆ enable5GHighBandWidth()

◆ enable720p()

◆ enableAutoAdjustMicVolume()

◆ enableCloudWhiteboard()

◆ enableEchoCancellation()

◆ enableForceAutoStartMyVideoWhenJoinMeeting()

◆ enableForceAutoStopMyVideoWhenJoinMeeting()

◆ enableGrabShareWithoutReminder()

◆ enableGreenBorderForShareScreen()

◆ enableMicOriginalInput()

◆ enableMirrorEffect()

◆ enableShareContentFlashDetection()

◆ enableShowMyMeetingElapseTime()

◆ enableUseConnectionService()

◆ enableWhiteboardVideoView()

◆ enableZoomDocsInCustomUI()

◆ forceDisableCamera()

◆ getReactionSkinTone()

◆ getSwitchVideoLayoutUserCountThreshold()

◆ getVideoAspectRatio()

◆ hiddenPoll()

◆ hiddenQA()

◆ hideAnnotationInScreenShareToolbar()

◆ hideCloudWhiteboardHelperCenterButton()

◆ hideCloudWhiteboardOpenInBrowserButton()

◆ hideStopShareInScreenShareToolbar()

◆ is1080pEnabled()

◆ is720PEnabled()

◆ isAlwaysShowMeetingToolbarEnabled()

◆ isAutoAdjustMicVolumeOn()

◆ isAutoConnectVoIPWhenJoinMeetingEnabled()

◆ isCameraForceDisabled()

◆ isCustomizedMeetingUIEnabled()

◆ isDisabledClearWebKitCache()

◆ isDisableShowVideoPreviewWhenJoinMeeting()

◆ isEchoCancellationOn()

◆ isGalleryVideoViewDisabled()

◆ isGreenBorderEnableForShareScreen()

◆ isHideAnnotationInScreenShareToolbar()

◆ isHideClosedCaption()

◆ isHideNoVideoUsersEnabled()

◆ isHideStopShareInScreenShareToolbar()

◆ isKubiDeviceEnabled()

◆ isMicOriginalInputEnable()

◆ isMirrorEffectEnabled()

◆ isMuteMyMicrophoneWhenJoinMeetingEnabled()

◆ isNoLeaveMeetingButtonForHostEnabled()

◆ isNoUserJoinOrLeaveTipEnabled()

◆ isNoVideoTileOnShareScreenEnabled()

◆ isShareContentFlashDetectionEnabled()

◆ isShowMyMeetingElapseTimeEnabled()

◆ isSupportEchoCancellation()

◆ isSwitchVideoLayoutAccordingToUserCountEnabled()

◆ isTurnOffMyVideoWhenJoinMeetingEnabled()

◆ isWhiteboardVideoViewEnabled()

◆ isZoomDocsEnabledInCustomUI()

◆ setActivityForShowDisclaimer()

◆ setAlwaysShowMeetingToolbarEnabled()

◆ setAnnotationSnapshotPathInAlbum()

◆ setAudioFocusType()

◆ setAutoConnectVoIPWhenJoinMeeting()

◆ setClaimHostWithHostKeyActionEnabled()

◆ setClosedCaptionHidden()

◆ setConfNotificationCategory()

◆ setConfNotificationChannelId()

◆ setConfNotificationPriority()

◆ setCustomizedMeetingUIEnabled()