Package us.zoom.sdk

Class ZoomVideoSDK

java.lang.Object
us.zoom.sdk.ZoomVideoSDK
public abstract class ZoomVideoSDK extends Object
Zoom Video SDK API manager. Main singleton object that controls the video session creation, event callbacks and other main features of video SDK.

initialize(Context, ZoomVideoSDKInitParams)

  • Constructor Details

    • ZoomVideoSDK

      public ZoomVideoSDK()

  • Method Details

    • getInstance

      public static ZoomVideoSDK getInstance()
      Returns ZoomVideoSDK instance.
      Returns:
      ZoomVideoSDK instance

    • cleanup

      public abstract int cleanup()
      Clean up Zoom Video SDK
      Returns:
      Error Code ZoomVideoSDKErrors

    • initialize

      @MainThread public abstract int initialize(android.content.Context context, ZoomVideoSDKInitParams params)
      Initialize the Zoom SDK with the appropriate parameters in the ZoomVideoSDKInitParams object.

      Note: This method must be called on the main thread, otherwise an exception ZoomVideoSDKWrongThreadException will be thrown

      Parameters:
      context - Android context
      params - Parameters for init zoom sdk ZoomVideoSDKInitParams
      Returns:
      Error Code

    • addListener

      public abstract void addListener(ZoomVideoSDKDelegate listener)
      Register a listener for session events.
      Parameters:
      listener - A listener class that groups together all the callbacks related to a session.

    • removeListener

      public abstract void removeListener(ZoomVideoSDKDelegate listener)
      Unregister a listener for session events.
      Parameters:
      listener - A listener class that groups together all the callbacks related to a session.

    • joinSession

      public abstract ZoomVideoSDKSession joinSession(ZoomVideoSDKSessionContext params)
      Call this method to join a session with the appropriate ZoomVideoSDKSessionContext parameters. When successful, the SDK will attempt to join a session. Use the callbacks in the listener to confirm whether the SDK actually joined.
      Parameters:
      params - Parameters for init zoom sdk ZoomVideoSDKSessionContext
      Returns:
      Session ZoomVideoSDKSession

    • leaveSession

      public abstract int leaveSession(boolean end)
      Call this method to leave a session previously joined through joinSession method call. When successful, the SDK will attempt to leave a session. Use the callbacks in the listener to confirm whether the SDK actually left.
      Parameters:
      end - true if the host should end the entire session, or false if the host should just leave the session.
      Returns:
      Error Code ZoomVideoSDKErrors

    • getSession

      public abstract ZoomVideoSDKSession getSession()
      Returns the current session information.
      Returns:
      session information ZoomVideoSDKSession

    • isInSession

      public abstract boolean isInSession()
      Check if there is an active session between participants.
      Returns:
      true if there is; false if not

    • getSDKVersion

      public abstract String getSDKVersion()
      Returns Zoom SDK internal version
      Returns:
      SDK version

    • getAudioHelper

      public abstract ZoomVideoSDKAudioHelper getAudioHelper()
      Returns an instance to manage audio controls related to the current video SDK session.
      Returns:
      ZoomVideoSDKAudioHelper

    • getTestAudioDeviceHelper

      public abstract ZoomVideoSDKTestAudioDeviceHelper getTestAudioDeviceHelper()
      Get test audio device helper.
      Returns:
      ZoomVideoSDKTestAudioDeviceHelper

    • getVideoHelper

      public abstract ZoomVideoSDKVideoHelper getVideoHelper()
      Returns an instance to manage cameras and video during a video SDK session.
      Returns:
      ZoomVideoSDKVideoHelper

    • getAudioSettingHelper

      public abstract ZoomVideoSDKAudioSettingHelper getAudioSettingHelper()
      Get audio setting helper.

    • getUserHelper

      public abstract ZoomVideoSDKUserHelper getUserHelper()
      Returns an instance to manage users present in a video SDK session.
      Returns:
      ZoomVideoSDKUserHelper

    • getShareHelper

      public abstract ZoomVideoSDKShareHelper getShareHelper()
      Returns an instance to manage screen sharing during a video SDK session.
      Returns:
      ZoomVideoSDKShareHelper

    • getLiveStreamHelper

      public abstract ZoomVideoSDKLiveStreamHelper getLiveStreamHelper()
      Returns an instance to manage live streaming during a video SDK session.
      Returns:
      ZoomVideoSDKLiveStreamHelper

    • getChatHelper

      public abstract ZoomVideoSDKChatHelper getChatHelper()
      Returns an instance to send and receive chat messages within video SDK session participants.
      Returns:
      ZoomVideoSDKChatHelper

    • getCmdChannel

      public abstract ZoomVideoSDKCmdChannel getCmdChannel()
      Returns an instance to use command channel features during a video SDK session.
      Returns:
      A ZoomVideoSDKCmdChannel instance.

    • getRecordingHelper

      public abstract ZoomVideoSDKRecordingHelper getRecordingHelper()
      Returns an instance to manage cloud recordings during a video SDK session.
      Returns:
      A ZoomVideoSDKRecordingHelper instance.

    • getPhoneHelper

      public abstract ZoomVideoSDKPhoneHelper getPhoneHelper()
      Returns an instance to manage phone invitations during a video SDK session.
      Returns:
      ZoomVideoSDKPhoneHelper

    • getVirtualBackgroundHelper

      public abstract ZoomVideoSDKVirtualBackgroundHelper getVirtualBackgroundHelper()
      Returns an instance to manage virtual background during a video SDK session.
      Returns:
      ZoomVideoSDKVirtualBackgroundHelper

    • getCRCHelper

      public abstract ZoomVideoSDKCRCHelper getCRCHelper()
      Get CRC helper object.
      Returns:
      If the function succeeds, the return value is the CRC helper object. Otherwise returns NULL. For more details, see ZoomVideoSDKCRCHelper

    • getLiveTranscriptionHelper

      public abstract ZoomVideoSDKLiveTranscriptionHelper getLiveTranscriptionHelper()
      Get the user's live transcription helper object.
      Returns:
      If the function succeeds, the return value is the live transcription helper object. Otherwise, this function returns NULL. For more information, see ZoomVideoSDKLiveTranscriptionHelper.

    • getIncomingLiveStreamHelper

      public abstract ZoomVideoSDKIncomingLiveStreamHelper getIncomingLiveStreamHelper()
      Get incoming live stream helper object.
      Returns:
      If the function succeeds, the return value is the incoming live stream helper object. Otherwise returns null. For more details, see ZoomVideoSDKIncomingLiveStreamHelper

    • exportLog

      public abstract String exportLog()
      Exports a log file to local disk.
      Returns:
      If the function succeeds, the return value is the exported log file path.

    • cleanAllExportedLogs

      public abstract int cleanAllExportedLogs()
      Cleans all exported logs.
      Returns:
      If the function succeeds, the return value is ZoomVideoSDKErrors_Success.Otherwise the function fails.To get extended error information, see ZoomVideoSDKErrors

    • getMaskHelper

      public abstract ZoomVideoSDKMaskHelper getMaskHelper()
      Get mask helper Object.
      Returns:
      If the function succeeds, the return value is the mask helper object. Otherwise returns NULL. For more details, see ZoomVideoSDKMaskHelper.

    • getSubSessionHelper

      public abstract ZoomVideoSDKSubSessionHelper getSubSessionHelper()
      Get the subsession helper object. This interface can only be called by the host or a manager.
      Returns:
      If the function succeeds, the return value is the subsession helper object. Otherwise returns nullptr. For more details, see ZoomVideoSDKSubSessionHelper.