Video SDK for Windows API Reference
Loading...
Searching...
No Matches
zoom_video_sdk_interface.h
Go to the documentation of this file.
1
6#ifndef _ZOOM_VIDEO_SDK_INTERFACE_H_
7#define _ZOOM_VIDEO_SDK_INTERFACE_H_
9
38{
39public:
40 virtual ~IZoomVideoSDK(){}
41
48
55
60 virtual void addListener(IZoomVideoSDKDelegate* listener) = 0;
61
66 virtual void removeListener(IZoomVideoSDKDelegate* listener) = 0;
67
75
82 virtual ZoomVideoSDKErrors leaveSession(bool end) = 0;
83
89
94 virtual bool isInSession() = 0;
95
100 virtual const zchar_t* getSDKVersion() = 0;
101
106 virtual const zchar_t* exportLog() = 0;
107
113
119
125
131
137
143
149
155
161
167
173
179
185
191
197
203
209
215
221
227
233};
235#endif
A listener class that groups together the callbacks related to a session.
Zoom Video SDK API manager. Main singleton object that controls the video session creation,...
virtual IZoomVideoSDKAudioSettingHelper * getAudioSettingHelper()=0
Get audio setting helper object.
virtual IZoomVideoSDKSession * joinSession(ZoomVideoSDKSessionContext &params)=0
Call this method to join a session with the appropriate ZoomVideoSDKSessionContext parameters.
virtual IZoomVideoSDKTestAudioDeviceHelper * GetAudioDeviceTestHelper()=0
Get audio setting helper object.
virtual ZoomVideoSDKErrors leaveSession(bool end)=0
Call this method to leave a session previously joined through joinSession method call.
virtual IZoomVideoSDKNetworkConnectionHelper * getNetworkConnectionHelper()=0
Get network connection helper object.
virtual IZoomVideoSDKBroadcastStreamingViewer * getBroadcastStreamingViewer()=0
Gets the broadcast streaming viewer object.
virtual ZoomVideoSDKErrors cleanAllExportedLogs()=0
Cleans all exported logs.
virtual IZoomVideoSDKIncomingLiveStreamHelper * getIncomingLiveStreamHelper()=0
Get incoming live stream helper object.
virtual IZoomVideoSDKShareSettingHelper * getShareSettingHelper()=0
Get share setting helper object.
virtual IZoomVideoSDKRecordingHelper * getRecordingHelper()=0
Returns an instance to manage cloud recordings during a video SDK session.
virtual IZoomVideoSDKVideoHelper * getVideoHelper()=0
Returns an instance to manage cameras and video during a video SDK session.
virtual IZoomVideoSDKVideoSettingHelper * getVideoSettingHelper()=0
Get video setting helper object.
virtual IZoomVideoSDKShareHelper * getShareHelper()=0
Returns an instance to manage screen sharing during a video SDK session.
virtual ZoomVideoSDKErrors cleanup()=0
Clean up ZOOM Video SDK.
virtual void removeListener(IZoomVideoSDKDelegate *listener)=0
Remove a listener for session events.
virtual IZoomVideoSDKCRCHelper * getCRCHelper()=0
Get CRC helper object.
virtual IZoomVideoSDKLiveTranscriptionHelper * getLiveTranscriptionHelper()=0
Get live transcription helper object.
virtual const zchar_t * exportLog()=0
Exports a log file to local disk.
virtual IZoomVideoSDKPhoneHelper * getPhoneHelper()=0
Returns an instance to manage phone invitations during a video SDK session.
virtual bool isInSession()=0
Check if there is an active session between participants.
virtual IZoomVideoSDKChatHelper * getChatHelper()=0
Returns an instance to send and receive chat messages within video SDK session participants.
virtual IZoomVideoSDKSession * getSessionInfo()=0
Returns the current session information.
virtual ZoomVideoSDKErrors initialize(ZoomVideoSDKInitParams &params)=0
Initialize the Zoom Video SDK with the appropriate parameters in the ZoomVideoSDKInitParams structure...
virtual IZoomVideoSDKLiveStreamHelper * getLiveStreamHelper()=0
Returns an instance to manage live streaming during a video SDK session.
virtual const zchar_t * getSDKVersion()=0
Returns the sdk version.
virtual IZoomVideoSDKUserHelper * getUserHelper()=0
Returns an instance to manage users present in a video SDK session.
virtual void addListener(IZoomVideoSDKDelegate *listener)=0
Add a listener for session events.
virtual IZoomVideoSDKBroadcastStreamingController * getBroadcastStreamingController()=0
Gets the broadcast streaming controller object.
virtual IZoomVideoSDKAudioHelper * getAudioHelper()=0
Returns an instance to manage audio controls related to the current video SDK session.
virtual IZoomVideoSDKSubSessionHelper * getSubSessionHelper()=0
Get the subsession helper object. This interface can only be called by the host or a manager.
virtual IZoomVideoSDKCmdChannel * getCmdChannel()=0
Returns an instance to use command channel features during a video SDK session.
zoom video sdk phone helper interface.
An interface to control video and manage cameras during a video session.
The initialization parameters for Zoom Video SDK.
Configuration context for joining a Zoom Video SDK session.
Zoom Video SDK Common Definition File.
#define BEGIN_ZOOM_VIDEO_SDK_NAMESPACE
#define END_ZOOM_VIDEO_SDK_NAMESPACE
ZoomVideoSDKErrors
Enumeration of common Zoom Video SDK errors.
wchar_t zchar_t