Package us.zoom.contactscenter.api

Interface ZoomCCVideoService

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract Unit addListener(ZoomCCVideoListener listener) Add video service callback.
      abstract Unit removeListener(ZoomCCVideoListener l) Remove video service callback
      abstract Integer endVideo() End video.
      abstract Unit setVideoPreviewOption(VideoPreviewOption option) Enable or disable video preview dialog and turn the camera on or off when entering a video call.
      abstract Unit setAutoJoinWhenVideoCreated(Boolean enable) Enable or disable auto-join when creating a video call.
      abstract Unit setUseBackwardFacingCameraByDefault(Boolean enable) Enable or disable using the back facing camera by default when creating a video call.
      abstract Unit setLaunchVideoFromBrowser(Boolean enable) Sets whether the current video session was launched from a browser or the local app.
      abstract Boolean handleShortLinkVideoURL(String url) Handles a Contact Center short link and prepares the UI for joining the associated video engagement.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • endVideo

         abstract Integer endVideo()

        End video.

        Returns:

        succeed if return 0

      • setVideoPreviewOption

         abstract Unit setVideoPreviewOption(VideoPreviewOption option)

        Enable or disable video preview dialog and turn the camera on or off when entering a video call.

        Parameters:
        option - Use the video preview option to enable or disable the video preview dialog.

      • setAutoJoinWhenVideoCreated

         abstract Unit setAutoJoinWhenVideoCreated(Boolean enable)

        Enable or disable auto-join when creating a video call.

        Parameters:
        enable - If true, the alert dialog is disabled and a user enters the video call automatically.

      • setUseBackwardFacingCameraByDefault

         abstract Unit setUseBackwardFacingCameraByDefault(Boolean enable)

        Enable or disable using the back facing camera by default when creating a video call.

        Parameters:
        enable - If true, the back facing camera is used when entering the video call instead of the front facing camera.

      • setLaunchVideoFromBrowser

         abstract Unit setLaunchVideoFromBrowser(Boolean enable)

        Sets whether the current video session was launched from a browser or the local app.

        Parameters:
        enable - If true, indicates the video was launched from a browser.

      • handleShortLinkVideoURL

         abstract Boolean handleShortLinkVideoURL(String url)

        Handles a Contact Center short link and prepares the UI for joining the associated video engagement.

        The SDK validates the short link, prepares a video service, and opens the video entry page. The SDK completes short-link resolution, video join information extraction, and native configuration updates before login. Errors that occur while resolving or processing the short link are reported through video service callbacks.

        Parameters:
        url - The Zoom Contact Center short link used to join the video engagement.
        Returns:

        Function returns true if the short link is valid, accepted, and handling starts. Otherwise, this function fails and returns false.