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 &params)=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 &params)=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.

Detailed Description

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.

Constructor & Destructor Documentation

◆ ~IZoomVideoSDK()

virtual IZoomVideoSDK::~IZoomVideoSDK ( )

inlinevirtual

Definition at line 38 of file zoom_video_sdk_interface.h.

38{}

Member Function Documentation

◆ addListener()

virtual void IZoomVideoSDK::addListener ( IZoomVideoSDKDelegate * listener )

pure virtual

Add a listener for session events.

Parameters

listener A listener class that groups together all the callbacks related to a session.

◆ cleanAllExportedLogs()

virtual ZoomVideoSDKErrors IZoomVideoSDK::cleanAllExportedLogs ( )

pure virtual

Cleans all exported logs.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. For detailed error codes, see ZoomVideoSDKErrors enum.

◆ cleanup()

virtual ZoomVideoSDKErrors IZoomVideoSDK::cleanup ( )

pure virtual

Clean up ZOOM Video SDK.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. For detailed error codes, see ZoomVideoSDKErrors enum.

◆ exportLog()

virtual const zchar_t * IZoomVideoSDK::exportLog ( )

pure virtual

Exports a log file to local disk.

Returns: If the function succeeds, the return value is the exported log file path.

◆ GetAudioDeviceTestHelper()

virtual IZoomVideoSDKTestAudioDeviceHelper * IZoomVideoSDK::GetAudioDeviceTestHelper ( )

pure virtual

Get audio setting helper object.

Returns: If the function succeeds, the return value is the audio device test helper object. Otherwise returns nullptr. For more details, see IZoomVideoSDKTestAudioDeviceHelper.

◆ getAudioHelper()

virtual IZoomVideoSDKAudioHelper * IZoomVideoSDK::getAudioHelper ( )

pure virtual

Returns an instance to manage audio controls related to the current video SDK session.

Returns: If the function succeeds, the return value is the audio helper object. Otherwise returns nullptr. For more details, see IZoomVideoSDKAudioHelper.

◆ getAudioSettingHelper()

virtual IZoomVideoSDKAudioSettingHelper * IZoomVideoSDK::getAudioSettingHelper ( )

pure virtual

Get audio setting helper object.

Returns: If the function succeeds, the return value is the audio setting helper object. Otherwise returns nullptr. For more details, see IZoomVideoSDKSettingHelper.

◆ getChatHelper()

virtual IZoomVideoSDKChatHelper * IZoomVideoSDK::getChatHelper ( )

pure virtual

Returns an instance to send and receive chat messages within video SDK session participants.

Returns: If the function succeeds, the return value is the chat helper object. Otherwise returns nullptr. For more details, see IZoomVideoSDKChatHelper.

◆ getCmdChannel()

virtual IZoomVideoSDKCmdChannel * IZoomVideoSDK::getCmdChannel ( )

pure virtual

Returns an instance to use command channel features during a video SDK session.

Returns: If the function succeeds, the return value is the command channel object. Otherwise returns nullptr. For more details, see IZoomVideoSDKCmdChannel.

◆ getCRCHelper()

virtual IZoomVideoSDKCRCHelper * IZoomVideoSDK::getCRCHelper ( )

pure virtual

Get CRC helper object.

Returns: If the function succeeds, the return value is the CRC helper object. Otherwise returns nullptr. For more details, see IZoomVideoSDKCRCHelper.

◆ getIncomingLiveStreamHelper()

virtual IZoomVideoSDKIncomingLiveStreamHelper * IZoomVideoSDK::getIncomingLiveStreamHelper ( )

pure virtual

Get incoming live stream helper object.

Returns: If the function succeeds, the return value is the incoming live stream helper object. Otherwise returns nullptr. For more details, see IZoomVideoSDKIncomingLiveStreamHelper.

◆ getLiveStreamHelper()

virtual IZoomVideoSDKLiveStreamHelper * IZoomVideoSDK::getLiveStreamHelper ( )

pure virtual

Returns an instance to manage live streaming during a video SDK session.

Returns: If the function succeeds, the return value is the live stream helper object. Otherwise returns nullptr. For more details, see IZoomVideoSDKLiveStreamHelper.

◆ getLiveTranscriptionHelper()

virtual IZoomVideoSDKLiveTranscriptionHelper * IZoomVideoSDK::getLiveTranscriptionHelper ( )

pure virtual

Get live transcription helper object.

Returns: If the function succeeds, the return value is the live transcription helper object. Otherwise returns nullptr. For more details, see IZoomVideoSDKLiveTranscriptionHelper.

◆ getNetworkConnectionHelper()

virtual IZoomVideoSDKNetworkConnectionHelper * IZoomVideoSDK::getNetworkConnectionHelper ( )

pure virtual

Get network connection helper object.

Returns: If the function succeeds, the return value is the network connection helper object. Otherwise returns nullptr. For more details, see IZoomVideoSDKNetworkConnectionHelper.

◆ getPhoneHelper()

virtual IZoomVideoSDKPhoneHelper * IZoomVideoSDK::getPhoneHelper ( )

pure virtual

Returns an instance to manage phone invitations during a video SDK session.

Returns: If the function succeeds, the return value is the phone helper object. Otherwise returns nullptr. For more details, see IZoomVideoSDKPhoneHelper.

◆ getRecordingHelper()

virtual IZoomVideoSDKRecordingHelper * IZoomVideoSDK::getRecordingHelper ( )

pure virtual

Returns an instance to manage cloud recordings during a video SDK session.

Returns: If the function succeeds, the return value is the recording helper object. Otherwise returns nullptr. For more details, see IZoomVideoSDKVideoHelper.

◆ getSDKVersion()

virtual const zchar_t * IZoomVideoSDK::getSDKVersion ( )

pure virtual

Returns the sdk version.

Returns: If the function succeeds, the return value is sdk version. Otherwise returns nullptr.

◆ getSessionInfo()

virtual IZoomVideoSDKSession * IZoomVideoSDK::getSessionInfo ( )

pure virtual

Returns the current session information.

Returns: If the function succeeds, the return value is the pointer to IZoomVideoSDKSession object. Otherwise returns nullptr.

◆ getShareHelper()

virtual IZoomVideoSDKShareHelper * IZoomVideoSDK::getShareHelper ( )

pure virtual

Returns an instance to manage screen sharing during a video SDK session.

Returns: If the function succeeds, the return value is the share helper object. Otherwise returns nullptr. For more details, see IZoomVideoSDKShareHelper.

◆ getShareSettingHelper()

virtual IZoomVideoSDKShareSettingHelper * IZoomVideoSDK::getShareSettingHelper ( )

pure virtual

Get share setting helper object.

Returns: If the function succeeds, the return value is the share setting helper object. Otherwise returns nullptr. For more details, see IZoomVideoSDKShareSettingHelper.

◆ getSubSessionHelper()

virtual IZoomVideoSDKSubSessionHelper * IZoomVideoSDK::getSubSessionHelper ( )

pure virtual

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 IZoomVideoSDKSubSessionHelper.

◆ getUserHelper()

virtual IZoomVideoSDKUserHelper * IZoomVideoSDK::getUserHelper ( )

pure virtual

Returns an instance to manage users present in a video SDK session.

Returns: If the function succeeds, the return value is the user helper object. Otherwise returns nullptr. For more details, see IZoomVideoSDKUserHelper.

◆ getVideoHelper()

virtual IZoomVideoSDKVideoHelper * IZoomVideoSDK::getVideoHelper ( )

pure virtual

Returns an instance to manage cameras and video during a video SDK session.

Returns: If the function succeeds, the return value is the video helper object. Otherwise returns nullptr. For more details, see IZoomVideoSDKVideoHelper.

◆ getVideoSettingHelper()

virtual IZoomVideoSDKVideoSettingHelper * IZoomVideoSDK::getVideoSettingHelper ( )

pure virtual

Get video setting helper object.

Returns: If the function succeeds, the return value is the video setting helper object. Otherwise returns nullptr. For more details, see IZoomVideoSDKVideoSettingHelper.

◆ initialize()

virtual ZoomVideoSDKErrors IZoomVideoSDK::initialize ( ZoomVideoSDKInitParams & params )

pure virtual

Initialize the Zoom Video SDK with the appropriate parameters in the ZoomVideoSDKInitParams structure.

Parameters

[out] params Parameters for init zoom video sdk. For more details, see ZoomVideoSDKInitParams structure.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. For detailed error codes, see ZoomVideoSDKErrors enum.

◆ isInSession()

virtual bool IZoomVideoSDK::isInSession ( )

pure virtual

Check if there is an active session between participants.

Returns: true if there is; false if not

◆ joinSession()

virtual IZoomVideoSDKSession * IZoomVideoSDK::joinSession ( ZoomVideoSDKSessionContext & params )

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.

Parameters

[out] params The parameter is used to join session. For more details, see ZoomVideoSDKSessionContext structure.

Returns: If the function succeeds, the return value is the pointer to IZoomVideoSDKSession object. Otherwise returns nullptr. For more details, see IZoomVideoSDKSession enum.

◆ leaveSession()

virtual ZoomVideoSDKErrors IZoomVideoSDK::leaveSession ( bool end )

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.

Parameters

end	true if the host should end the entire session, or False if the host should just leave the session.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. For detailed error codes, see ZoomVideoSDKErrors enum.

◆ removeListener()

virtual void IZoomVideoSDK::removeListener ( IZoomVideoSDKDelegate * listener )

pure virtual

Remove a listener for session events.

Parameters

listener A listener class that groups together all the callbacks related to a session.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IZoomVideoSDK()

Member Function Documentation

◆ addListener()

◆ cleanAllExportedLogs()

◆ cleanup()

◆ exportLog()

◆ GetAudioDeviceTestHelper()

◆ getAudioHelper()

◆ getAudioSettingHelper()

◆ getChatHelper()

◆ getCmdChannel()

◆ getCRCHelper()

◆ getIncomingLiveStreamHelper()

◆ getLiveStreamHelper()

◆ getLiveTranscriptionHelper()

◆ getNetworkConnectionHelper()

◆ getPhoneHelper()

◆ getRecordingHelper()

◆ getSDKVersion()

◆ getSessionInfo()

◆ getShareHelper()

◆ getShareSettingHelper()

◆ getSubSessionHelper()

◆ getUserHelper()

◆ getVideoHelper()

◆ getVideoSettingHelper()

◆ initialize()

◆ isInSession()

◆ joinSession()

◆ leaveSession()

◆ removeListener()