Video SDK for Windows API Reference
|
Zoom Video SDK API manager. Main singleton object that controls the video session creation, event callbacks and other main features of video SDK. More...
#include <zoom_video_sdk_interface.h>
Public Member Functions | |
virtual | ~IZoomVideoSDK () |
virtual ZoomVideoSDKErrors | initialize (ZoomVideoSDKInitParams ¶ms)=0 |
Initialize the Zoom Video SDK with the appropriate parameters in the ZoomVideoSDKInitParams structure. | |
virtual ZoomVideoSDKErrors | cleanup ()=0 |
Clean up ZOOM Video SDK. | |
virtual void | addListener (IZoomVideoSDKDelegate *listener)=0 |
Add a listener for session events. | |
virtual void | removeListener (IZoomVideoSDKDelegate *listener)=0 |
Remove a listener for session events. | |
virtual IZoomVideoSDKSession * | joinSession (ZoomVideoSDKSessionContext ¶ms)=0 |
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. | |
virtual ZoomVideoSDKErrors | leaveSession (bool end)=0 |
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. | |
virtual IZoomVideoSDKSession * | getSessionInfo ()=0 |
Returns the current session information. | |
virtual bool | isInSession ()=0 |
Check if there is an active session between participants. | |
virtual const zchar_t * | getSDKVersion ()=0 |
Returns the sdk version. | |
virtual const zchar_t * | exportLog ()=0 |
Exports a log file to local disk. | |
virtual ZoomVideoSDKErrors | cleanAllExportedLogs ()=0 |
Cleans all exported logs. | |
virtual IZoomVideoSDKAudioHelper * | getAudioHelper ()=0 |
Returns an instance to manage audio controls related to the current video SDK session. | |
virtual IZoomVideoSDKVideoHelper * | getVideoHelper ()=0 |
Returns an instance to manage cameras and video during a video SDK session. | |
virtual IZoomVideoSDKRecordingHelper * | getRecordingHelper ()=0 |
Returns an instance to manage cloud recordings during a video SDK session. | |
virtual IZoomVideoSDKUserHelper * | getUserHelper ()=0 |
Returns an instance to manage users present in a video SDK session. | |
virtual IZoomVideoSDKShareHelper * | getShareHelper ()=0 |
Returns an instance to manage screen sharing during a video SDK session. | |
virtual IZoomVideoSDKLiveStreamHelper * | getLiveStreamHelper ()=0 |
Returns an instance to manage live streaming during a video SDK session. | |
virtual IZoomVideoSDKPhoneHelper * | getPhoneHelper ()=0 |
Returns an instance to manage phone invitations during a video SDK session. | |
virtual IZoomVideoSDKChatHelper * | getChatHelper ()=0 |
Returns an instance to send and receive chat messages within video SDK session participants. | |
virtual IZoomVideoSDKCmdChannel * | getCmdChannel ()=0 |
Returns an instance to use command channel features during a video SDK session. | |
virtual IZoomVideoSDKAudioSettingHelper * | getAudioSettingHelper ()=0 |
Get audio setting helper object. | |
virtual IZoomVideoSDKTestAudioDeviceHelper * | GetAudioDeviceTestHelper ()=0 |
Get audio setting helper object. | |
virtual IZoomVideoSDKNetworkConnectionHelper * | getNetworkConnectionHelper ()=0 |
Get network connection helper object. | |
virtual IZoomVideoSDKCRCHelper * | getCRCHelper ()=0 |
Get CRC helper object. | |
virtual IZoomVideoSDKVideoSettingHelper * | getVideoSettingHelper ()=0 |
Get video setting helper object. | |
virtual IZoomVideoSDKShareSettingHelper * | getShareSettingHelper ()=0 |
Get share setting helper object. | |
virtual IZoomVideoSDKLiveTranscriptionHelper * | getLiveTranscriptionHelper ()=0 |
Get live transcription helper object. | |
virtual IZoomVideoSDKIncomingLiveStreamHelper * | getIncomingLiveStreamHelper ()=0 |
Get incoming live stream helper object. | |
virtual IZoomVideoSDKSubSessionHelper * | getSubSessionHelper ()=0 |
Get the subsession helper object. This interface can only be called by the host or a manager. | |
Zoom Video SDK API manager. Main singleton object that controls the video session creation, event callbacks and other main features of video SDK.
Definition at line 35 of file zoom_video_sdk_interface.h.
|
inlinevirtual |
Definition at line 38 of file zoom_video_sdk_interface.h.
|
pure virtual |
Add a listener for session events.
listener | A listener class that groups together all the callbacks related to a session. |
|
pure virtual |
Cleans all exported logs.
|
pure virtual |
Clean up ZOOM Video SDK.
|
pure virtual |
Exports a log file to local disk.
|
pure virtual |
Get audio setting helper object.
|
pure virtual |
Returns an instance to manage audio controls related to the current video SDK session.
|
pure virtual |
Get audio setting helper object.
|
pure virtual |
Returns an instance to send and receive chat messages within video SDK session participants.
|
pure virtual |
Returns an instance to use command channel features during a video SDK session.
|
pure virtual |
Get CRC helper object.
|
pure virtual |
Get incoming live stream helper object.
|
pure virtual |
Returns an instance to manage live streaming during a video SDK session.
|
pure virtual |
Get live transcription helper object.
|
pure virtual |
Get network connection helper object.
|
pure virtual |
Returns an instance to manage phone invitations during a video SDK session.
|
pure virtual |
Returns an instance to manage cloud recordings during a video SDK session.
|
pure virtual |
Returns the sdk version.
|
pure virtual |
Returns the current session information.
|
pure virtual |
Returns an instance to manage screen sharing during a video SDK session.
|
pure virtual |
Get share setting helper object.
|
pure virtual |
Get the subsession helper object. This interface can only be called by the host or a manager.
|
pure virtual |
Returns an instance to manage users present in a video SDK session.
|
pure virtual |
Returns an instance to manage cameras and video during a video SDK session.
|
pure virtual |
Get video setting helper object.
|
pure virtual |
Initialize the Zoom Video SDK with the appropriate parameters in the ZoomVideoSDKInitParams structure.
[out] | params | Parameters for init zoom video sdk. For more details, see ZoomVideoSDKInitParams structure. |
|
pure virtual |
Check if there is an active session between participants.
|
pure virtual |
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.
[out] | params | The parameter is used to join session. For more details, see ZoomVideoSDKSessionContext structure. |
|
pure virtual |
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.
end | true if the host should end the entire session, or False if the host should just leave the session. |
|
pure virtual |
Remove a listener for session events.
listener | A listener class that groups together all the callbacks related to a session. |