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
22 public static ZoomVideoSDK getInstance() {
23
24 if (null == instance) {
25 synchronized (ZoomVideoSDK.class) {
26 if (null == instance) {
27 instance = new ZoomVideoSDKImpl();
28 }
29 }
30 }
31 return instance;
32 }
33
39 public abstract int cleanup();
40
48 @MainThread
49 public abstract int initialize(Context context, ZoomVideoSDKInitParams params);
50
55 public abstract void addListener(ZoomVideoSDKDelegate listener);
56
61 public abstract void removeListener(ZoomVideoSDKDelegate listener);
62
63
70
72
81
86 public abstract int commitJoin();
87
92 public abstract int cancelPrepareJoin();
93
100 public abstract int leaveSession(boolean end);
101
107
108
113 public abstract boolean isInSession();
114
119 public abstract String getSDKVersion();
120
121
127
133
139
145
151
157
163
169
175
181
187
193
199
205
211
217
223
228 public abstract String exportLog();
229
234 public abstract int cleanAllExportedLogs();
235
241
247
253
259
265
271}
Zoom Video SDK API manager. Main singleton object that controls the video session creation,...
abstract int cancelPrepareJoin()
Cancel prepare join. Valid in the two-step join flow.
abstract ZoomVideoSDKSubSessionHelper getSubSessionHelper()
Gets 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()
Gets the incoming live stream helper object.
static ZoomVideoSDK getInstance()
Returns the ZoomVideoSDK instance.
abstract ZoomVideoSDKRTMSHelper getRealTimeMediaStreamsHelper()
Gets the real-time media streams helper object.
abstract ZoomVideoSDKTestAudioDeviceHelper getTestAudioDeviceHelper()
Gets the test audio device helper.
abstract ZoomVideoSDKEmojiReactionHelper getEmojiReactionHelper()
Gets the emoji reaction helper object.
abstract ZoomVideoSDKSession joinSession(ZoomVideoSDKSessionContext params)
Joins a session with the appropriate ZoomVideoSDKSessionContext parameters. When successful,...
abstract ZoomVideoSDKUserHelper getUserHelper()
Returns an instance to manage users present in a video SDK session.
abstract ZoomVideoSDKVideoSettingHelper getVideoSettingHelper()
Gets the video setting helper.
abstract ZoomVideoSDKLiveTranscriptionHelper getLiveTranscriptionHelper()
Gets the user's live transcription helper object.
abstract ZoomVideoSDKCRCHelper getCRCHelper()
Gets the CRC helper object.
abstract ZoomVideoSDKLiveStreamHelper getLiveStreamHelper()
Returns an instance to manage live streaming during a video SDK session.
abstract ZoomVideoSDKBroadcastStreamingViewer getBroadcastStreamingViewer()
Gets the broadcast streaming viewer object.
abstract ZoomVideoSDKAudioSettingHelper getAudioSettingHelper()
Gets the audio setting helper.
abstract int leaveSession(boolean end)
Leaves a session previously joined through the joinSession method call. When successful,...
abstract ZoomVideoSDKVideoHelper getVideoHelper()
Returns an instance to manage cameras and video during a video SDK session.
abstract boolean isInSession()
Determines whether there is an active session between participants.
abstract int initialize(Context context, ZoomVideoSDKInitParams params)
Initializes 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 ZoomVideoSDKSession prepareJoin(ZoomVideoSDKSessionContext params, ZoomVideoSDKPreJoinParam preJoinParam)
Prepares to join a session (two-step join). After prepareJoin succeeds, call commitJoin() to confirm ...
abstract String exportLog()
Exports a log file to local disk.
abstract void addListener(ZoomVideoSDKDelegate listener)
Registers a listener for session events.
abstract void removeListener(ZoomVideoSDKDelegate listener)
Unregisters a listener for session events.
abstract String getSDKVersion()
Returns the 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 ZoomVideoSDKBroadcastStreamingController getBroadcastStreamingController()
Gets the broadcast streaming controller object.
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()
Cleans up the Zoom Video SDK.
abstract ZoomVideoSDKSession getSession()
Returns the current session information.
abstract ZoomVideoSDKVoiceInterpretationHelper getVoiceInterpretationHelper()
Gets the voice interpretation helper object.
abstract ZoomVideoSDKPhoneHelper getPhoneHelper()
Returns an instance to manage phone invitations during a video SDK session.
static ZoomVideoSDKImpl instance
abstract int commitJoin()
Confirm join after prepareJoin. Valid in the two-step join flow.
abstract ZoomVideoSDKMaskHelper getMaskHelper()
Gets the mask helper object.
Zoom Video SDK initialize params.
Pre-join parameters for two-step join flow.
Audio control interface. See ZoomVideoSDK#getAudioHelper().
The command channel allows users to send commands or data (such as plain text or a binary encoded int...
A listener class that groups together the callbacks related to a session.
Emoji reaction helper interface for sending emoji reactions in 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.
Real-time media streams helper interface.
Helper class for using cloud recording in the session.
An interface to control video and manage cameras during a video session.