Package us.zoom.sdk

Interface ZoomUIService

public interface ZoomUIService
Service for users' to operate with Zoom UI

  • Method Details

    • switchToNextPage

      void switchToNextPage()
      Switch to the next scene. For a new meeting UI, the video frames' sequence is { drive scene(if has), active scene, sign language scene(if has), gallery scene(if has) }.

    • switchToPreviousPage

      void switchToPreviousPage()
      Switch to the previous scene. For a new meeting UI, the video frames' sequence is { drive scene(if has), active scene, sign language scene(if has), gallery scene(if has) }.

    • switchToActiveSpeaker

      void switchToActiveSpeaker()
      Switch to the active scene. For a new meeting UI, the video frames' sequence is { drive scene(if has), active scene, sign language scene(if has), gallery scene(if has) }.

    • switchToDriveScene

      void switchToDriveScene()
      Switch to the drive scene. This is not supported for tablet in the new meeting UI. For a new meeting UI, the video frames' sequence is { drive scene(if has), active scene, sign language scene(if has), gallery scene(if has) }.

    • switchToVideoWall

      void switchToVideoWall()
      Switch to the gallery scene. For a new meeting UI, the video frames' sequence is { drive scene(if has), active scene, sign language scene(if has), gallery scene(if has) }.

    • switchToSignLanguageView

      void switchToSignLanguageView()
      Switch to the sign language scene. It is only supported in the new meeting UI. For a new meeting UI, the video frames' sequence is { drive scene(if has), active scene, sign language scene(if has), gallery scene(if has) }.

    • setHideMeetingInputUserInfoWindow

      void setHideMeetingInputUserInfoWindow(boolean hide)
      Set the meeting input user info dialog to hide or display.
      Parameters:
      hide - true means hide the dialog. Otherwise, do not hide the dialog.

    • isHideMeetingInputUserInfoWindow

      boolean isHideMeetingInputUserInfoWindow()
      Get the meeting input user info dialog to hide or display.
      Returns:
      value of the setting value.

    • prePopulateWebinarRegistrationInfo

      void prePopulateWebinarRegistrationInfo(String email, String username)
      Preset email and username for webinars which need registration to join, the email and username value will be input to the webinar registration dialog as default.
      Parameters:
      email - preset email
      username - preset username

    • setHideRegisterWebinarInfoWindow

      void setHideRegisterWebinarInfoWindow(boolean hide)
      Set the webinar register information dialog to hide or display.
      Parameters:
      hide - true means hide the dialog. Otherwise, do not hide the dialog.

    • isHideRegisterWebinarInfoWindow

      boolean isHideRegisterWebinarInfoWindow()
      Get the webinar register information dialog to hide or display.
      Returns:
      value of the setting value.

    • setZoomUIDelegate

      void setZoomUIDelegate(ZoomUIDelegate delegate)
      Set the zoom ui delegate. can handle the user click event.

      when conference end user should set the delegate null.

      Parameters:
      delegate - ZoomUIDelegate

    • hideReactionsOnMeetingUI

      void hideReactionsOnMeetingUI(boolean hidden)
      Hide meeting reaction ui.
      Parameters:
      hidden - true:hide ui

    • hideDisconnectAudio

      void hideDisconnectAudio(boolean hidden)
      Hide disconnect audio button in meeting.
      Parameters:
      hidden - true: hide; false: show

    • hiddenPromoToPanelist

      void hiddenPromoToPanelist(boolean hidden)
      Hide promo to panelist in webinar
      Parameters:
      hidden - true: hide; false:show

    • hiddenChangeToAttendee

      void hiddenChangeToAttendee(boolean hidden)
      Hide Change to attendee in webinar
      Parameters:
      hidden - true: hide; false:show

    • showMiniMeetingWindow

      boolean showMiniMeetingWindow()
      Show minimized meeting window
      Returns:
      true if show successfully

    • hideMiniMeetingWindow

      void hideMiniMeetingWindow()

    • setMiniMeetingViewSize

      void setMiniMeetingViewSize(CustomizedMiniMeetingViewSize size)
      Set the customized minimize meeting view size
      Parameters:
      size - size

    • enableMinimizeMeeting

      void enableMinimizeMeeting(boolean enable)
      Enable minimize meeting feature. This feature is disabled as default. If the minimize meeting feature is enabled, the pip mode is disabled. Notice: if set disablePIPMode(boolean) false, the minimize meeting feature is disabled.
      Parameters:
      enable - true: enable; false: disable;

    • disablePIPMode

      void disablePIPMode(boolean disable)
      Disable PIP mode feature. The PIP mode is enabled as default. If the PIP mode feature is enabled, the minimize meeting feature is disabled. Notice: if set enableMinimizeMeeting(boolean) true, the pip mode will be disabled.
      Parameters:
      disable - true: disable the pip mode; false: enable the pip mode.

    • disableFreeMeetingNeedAdminUpgradeTips

      void disableFreeMeetingNeedAdminUpgradeTips(boolean disable)
      Disable free meeting upgrade tips for zoom ui.
      Parameters:
      disable - true: disable; false: enable; default is false.

    • enableJavaScriptForShareWebView

      void enableJavaScriptForShareWebView(boolean enable)
      Enable webView javascript for share url. default is true.
      Parameters:
      enable - true/false

    • hideMeetingInviteUrl

      void hideMeetingInviteUrl(boolean hidden)
      hide meeting invite url
      Parameters:
      hidden - true: hide; false: show

    • setCustomizedInvitationDomain

      MobileRTCSDKError setCustomizedInvitationDomain(String invitationDomain)
      Set the customized invitation domain.
      Parameters:
      invitationDomain - Specify the customized invitation domain. eg: https://abc.com.
      Returns:
      MobileRTCSDKError.SDKERR_SUCCESS means success, otherwise not

    • setCustomizedPollingUrl

      MobileRTCSDKError setCustomizedPollingUrl(String pollingURL, boolean bCreate)
      Allowing the developer to customize the URL of create/edit the polling.
      Parameters:
      pollingURL - customized URL.
      bCreate - When bCreate is true, it changes the URL of creating a polling. Otherwise, it changes the URL of editing a polling.
      Returns:
      MobileRTCSDKError.SDKERR_SUCCESS means success, otherwise not

    • setHideShareOptions

      void setHideShareOptions(List<Integer> shareOptions)
      Hide specified share item list
      Parameters:
      shareOptions - ShareOptions

    • setCustomShareOptions

      void setCustomShareOptions(List<ICustomShareOptionItem> optionItemList)
      Add customized share item
      Parameters:
      optionItemList - ICustomShareOptionItem

    • hideCloudWhiteboardFeedbackButton

      void hideCloudWhiteboardFeedbackButton(boolean isHide)
      Hide feedback button on cloud whiteboard
      Parameters:
      isHide - hide if True, else show

    • setCloudWhiteboardFeedbackUrl

      MobileRTCSDKError setCloudWhiteboardFeedbackUrl(String url)
      Allowing the developer to customize the URL of feedback on cloud whiteboard
      Parameters:
      url - Specify the feedback url in the the white board page.
      Returns:
      MobileRTCSDKError.SDKERR_SUCCESS means success, otherwise not

    • hideCloudWhiteboardShareButton

      void hideCloudWhiteboardShareButton(boolean isHide)
      Hide share button on cloud whiteboard
      Parameters:
      isHide - hide if True, else show

    • hideCloudWhiteboardAboutButton

      void hideCloudWhiteboardAboutButton(boolean isHide)
      Hide about button on cloud whiteboard
      Parameters:
      isHide - hide if True, else show

    • setNewMeetingUI

      void setNewMeetingUI(Class<? extends NewMeetingActivity> activity)
      set the meeting UI.
      Parameters:
      activity - the new meeting UI activity class. Null means use the default new meeting UI activity

    • isTabletDevice

      boolean isTabletDevice()
      Query if the current device is tablet device for zoom ui.
      Returns:
      true means the current device is tablet device for zoom ui, false means not.

    • enableHideSelfView

      MobileRTCSDKError enableHideSelfView(boolean bEnable)
      Enable or disable to hide the user self's view in gallery view.
      Parameters:
      bEnable - true indicates to enable to hide the user self's view.
      Returns:
      If the function succeeds, the return value is MobileRTCSDKError.SDKERR_SUCCESS

    • isHideSelfViewEnabled

      boolean isHideSelfViewEnabled()
      Get the flag to enable/disable to hide user self's view in gallery view.
      Returns:
      Enabled or disabled.

    • hideRequestRecordPrivilegeDialog

      void hideRequestRecordPrivilegeDialog(boolean bHide)
      Set the visibility of request local recording privilege dialog when attendee request local recording privilege. Default is displaying.
      Parameters:
      bHide - TRUE indicates to hide the tab. FALSE not.

    • hideJoinMeetingNamePasswordDialog

      void hideJoinMeetingNamePasswordDialog(boolean bHide)
      Whether to hide the name and password dialog when the meeting requires a name and password dialog. Show name and password dialog by default.
      Parameters:
      bHide - true means to hide the name and password dialog

    • setHideWebinarNameInputWindow

      void setHideWebinarNameInputWindow(boolean hide)
      Set the webinar username input dialog to hide or display. if hide webinar user name input dialog, should handle InMeetingServiceListener.onWebinarNeedInputScreenName(InMeetingEventHandler)} InMeetingEventHandler.inputName(String)
      Parameters:
      hide - true means hide the dialog. Otherwise, do not hide the dialog.

    • isHideWebinarNameInputWindow

      boolean isHideWebinarNameInputWindow()
      Get the webinar username input dialog to hide or display.
      Returns:
      value of the setting value.

    • setHideConfirmStartArchiveDialog

      void setHideConfirmStartArchiveDialog(boolean hide)
      Set the confirm start archive dialog to hide or display. if hide confirm start archive dialog when join meeting, should handle InMeetingServiceListener.onUserConfirmToStartArchive(IMeetingArchiveConfirmHandler)
      Parameters:
      hide - true means hide the dialog. Otherwise, do not hide the dialog.

    • isHideConfirmStartArchiveDialog

      boolean isHideConfirmStartArchiveDialog()
      Get the confirm start archive dialog whether hide or display.
      Returns:
      true means hide, false means display.

    • setHideRecoverMeetingDialog

      void setHideRecoverMeetingDialog(boolean hide)
      for hide confirm start archive dialog
      Parameters:
      hide - true means hide the dialog. Otherwise, do not hide the dialog.

    • isHideRecoverMeetingDialog

      boolean isHideRecoverMeetingDialog()
      Get the recover meeting dialog whether hide or display.
      Returns:
      true means hide, false means display.