Package us.zoom.sdk

Interface MeetingSettingsHelper

  • public interface MeetingSettingsHelper
    ZOOM meeting settings.

    • Method Detail

      • 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.

      • isNoVideoTileOnShareScreenEnabled

        boolean isNoVideoTileOnShareScreenEnabled()
        Query if NO VIDEO TILE ON SHARE SCREEN is enabled.
        Returns:
        TRUE means enabled. FALSE not.

      • setNoVideoTileOnShareScreenEnabled

        void setNoVideoTileOnShareScreenEnabled​(boolean enabled)
        Set whether to enable the options NO MEETING TILE ON SHARED SCREEN.
        Parameters:
        enabled - TRUE means to enable, FALSE disable.

      • 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

        void setConfNotificationChannelId​(java.lang.String channelId)
        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

      • setVideoOnWhenMyShare

        void setVideoOnWhenMyShare​(boolean videoOnWhenMyShare)
        Do not turn off video when my share start.
        Parameters:
        videoOnWhenMyShare - default false

      • disableChatUI

        void disableChatUI​(boolean disable)
        Disable chat ui for zoom ui.
        Parameters:
        disable - default false

      • hideAnnotationInScreenShareToolbar

        void hideAnnotationInScreenShareToolbar​(boolean hideAnnotation)
        Hide annotation button in screen share toolbar,for sdk screen share.
        Parameters:
        hideAnnotation - default false

      • isHideAnnotationInScreenShareToolbar

        boolean isHideAnnotationInScreenShareToolbar()
        Query if annotation button is hide in screen share toolbar.
        Returns:
        TRUE means hide. FALSE show.

      • hideStopShareInScreenShareToolbar

        void hideStopShareInScreenShareToolbar​(boolean hideStopShare)
        Hide stopshare button in screen share toolbar. for sdk screen share
        Parameters:
        hideStopShare - default false

      • isHideStopShareInScreenShareToolbar

        boolean isHideStopShareInScreenShareToolbar()
        Query if stopshare button is hide in screen share toolbar.
        Returns:
        TRUE means hide. FALSE show.

      • 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 by NotificationCompat. Acceptable values range from NotificationCompat.PRIORITY_MIN (-2) to NotificationCompat.PRIORITY_MAX (2).

      • hiddenQA

        void hiddenQA​(boolean hiddenQA)
        Hidden question and answer feature for zoom ui
        Parameters:
        hiddenQA - true hidden

      • hiddenPoll

        void hiddenPoll​(boolean hiddenPoll)
        Hidden poll feature for zoom ui
        Parameters:
        hiddenPoll - true hidden

      • 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 item
        handle - 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

      • 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

        void setAnnotationSnapshotPathInAlbum​(java.lang.String path)
        Set the path for saving annotation screenshots to the album
        Parameters:
        path - saving annotation screenshots path

      • enableGreenBorderForShareScreen

        void enableGreenBorderForShareScreen​(boolean enable)
        enable or disable showing the green border when screen sharing.
        Parameters:
        enable - true means enabled, otherwise not.

      • isGreenBorderEnableForShareScreen

        boolean isGreenBorderEnableForShareScreen()
        Query if enabling or disabling showing the green border when screen sharing.
        Returns:
        true means enabled. Otherwise, it is disabled.

      • enableAutoAdjustMicVolume

        @Deprecated
void enableAutoAdjustMicVolume​(boolean enable)
        Deprecated.
        Enable auto-adjust microphone.
        Parameters:
        enable - true means enabled, false means disabled.

      • isAutoAdjustMicVolumeOn

        @Deprecated
boolean 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

        void setConfNotificationCategory​(java.lang.String category)
        Set the category of notification for ongoing meeting.
        Parameters:
        category - category of notification.

      • setHideShareButtonInMeetingToolbar

        void setHideShareButtonInMeetingToolbar​(boolean bHide)
        Set hide share button in meeting toolbar.
        Parameters:
        bHide - true to hide

      • setActivityForShowDisclaimer

        void setActivityForShowDisclaimer​(android.app.Activity activity)
        Set the activity to show the disclaimer dialog.
        Parameters:
        activity - the activity to show the disclaimer dialog.

      • enableGrabShareWithoutReminder

        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. Default value: FALSE(prompt).
        Parameters:
        enable - TRUE indicates no prompt. FALSE not.