Video SDK for Android API Reference
Loading...
Searching...
No Matches
ZoomVideoSDK.java
Go to the documentation of this file.
1package us.zoom.sdk;
2
3import android.content.Context;
4
5import androidx.annotation.MainThread;
6
7import us.zoom.internal.ZoomVideoSDKImpl;
8
14public abstract class ZoomVideoSDK {
15
16 protected static ZoomVideoSDKImpl instance = null;
17
23 public static ZoomVideoSDK getInstance() {
24
25 if (null == instance) {
26 synchronized (ZoomVideoSDK.class) {
27 if (null == instance) {
28 instance = new ZoomVideoSDKImpl();
29 }
30 }
31 }
32 return instance;
33 }
34
40 public abstract int cleanup();
41
51 @MainThread
52 public abstract int initialize(Context context, ZoomVideoSDKInitParams params);
53
59 public abstract void addListener(ZoomVideoSDKDelegate listener);
60
66 public abstract void removeListener(ZoomVideoSDKDelegate listener);
67
68
78
86 public abstract int leaveSession(boolean end);
87
94
95
101 public abstract boolean isInSession();
102
108 public abstract String getSDKVersion();
109
110
117
124
131
136
143
150
157
164
171
178
185
192
199
207
215
220 public abstract String exportLog();
221
227 public abstract int cleanAllExportedLogs();
228
234
241}
Zoom Video SDK API manager. Main singleton object that controls the video session creation,...
abstract ZoomVideoSDKSubSessionHelper getSubSessionHelper()
Get the subsession helper object. This interface can only be called by the host or a manager.
abstract ZoomVideoSDKChatHelper getChatHelper()
Returns an instance to send and receive chat messages within video SDK session participants.
abstract ZoomVideoSDKIncomingLiveStreamHelper getIncomingLiveStreamHelper()
Get incoming live stream helper object.
static ZoomVideoSDK getInstance()
Returns ZoomVideoSDK instance.
abstract ZoomVideoSDKTestAudioDeviceHelper getTestAudioDeviceHelper()
Get test audio device helper.
abstract ZoomVideoSDKSession joinSession(ZoomVideoSDKSessionContext params)
Call this method to join a session with the appropriate ZoomVideoSDKSessionContext parameters....
abstract ZoomVideoSDKUserHelper getUserHelper()
Returns an instance to manage users present in a video SDK session.
abstract ZoomVideoSDKLiveTranscriptionHelper getLiveTranscriptionHelper()
Get the user's live transcription helper object.
abstract ZoomVideoSDKCRCHelper getCRCHelper()
Get CRC helper object.
abstract ZoomVideoSDKLiveStreamHelper getLiveStreamHelper()
Returns an instance to manage live streaming during a video SDK session.
abstract ZoomVideoSDKAudioSettingHelper getAudioSettingHelper()
Get audio setting helper.
abstract int leaveSession(boolean end)
Call this method to leave a session previously joined through joinSession method call....
abstract ZoomVideoSDKVideoHelper getVideoHelper()
Returns an instance to manage cameras and video during a video SDK session.
abstract boolean isInSession()
Check if there is an active session between participants.
abstract int initialize(Context context, ZoomVideoSDKInitParams params)
Initialize the Zoom SDK with the appropriate parameters in the ZoomVideoSDKInitParams object.
abstract ZoomVideoSDKVirtualBackgroundHelper getVirtualBackgroundHelper()
Returns an instance to manage virtual background during a video SDK session.
abstract ZoomVideoSDKRecordingHelper getRecordingHelper()
Returns an instance to manage cloud recordings during a video SDK session.
abstract String exportLog()
Exports a log file to local disk.
abstract void addListener(ZoomVideoSDKDelegate listener)
Register a listener for session events.
abstract void removeListener(ZoomVideoSDKDelegate listener)
Unregister a listener for session events.
abstract String getSDKVersion()
Returns Zoom SDK internal version.
abstract int cleanAllExportedLogs()
Cleans all exported logs.
abstract ZoomVideoSDKAudioHelper getAudioHelper()
Returns an instance to manage audio controls related to the current video SDK session.
abstract ZoomVideoSDKShareHelper getShareHelper()
Returns an instance to manage screen sharing during a video SDK session.
abstract ZoomVideoSDKCmdChannel getCmdChannel()
Returns an instance to use command channel features during a video SDK session.
abstract int cleanup()
Clean up Zoom Video SDK.
abstract ZoomVideoSDKSession getSession()
Returns the current session information.
abstract ZoomVideoSDKPhoneHelper getPhoneHelper()
Returns an instance to manage phone invitations during a video SDK session.
static ZoomVideoSDKImpl instance
abstract ZoomVideoSDKMaskHelper getMaskHelper()
Get mask helper Object.
Zoom Video SDK initialize params.
A listener class that groups together the callbacks related to a session.
Live stream control interface. Zoom Video SDK supports live streaming of a session to Facebook Live,...
Live transcription interface. Zoom Video SDK supports live transcription (an additional add-on servic...
The helper to set the video mask.
Helper class for using cloud recording in the session.
An interface to control video and manage cameras during a video session.