ZoomVideoSDK Class 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 <ZoomVideoSDK.h>

Inherits NSObject.

Instance Methods
(ZoomVideoSDKError)	- initialize:
	Initialize the Zoom SDK with the appropriate parameters in the ZoomVideoSDKInitParams object.
(ZoomVideoSDKError)	- cleanup
	un-nitialize the Zoom SDK.
(ZoomVideoSDKSession *_Nullable)	- joinSession:
	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 delegate to confirm whether the SDK actually joined.
(ZoomVideoSDKError)	- leaveSession:
	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 delegate to confirm whether the SDK actually left.
(ZoomVideoSDKSession *_Nullable)	- getSession
	Returns the current session information.
(BOOL)	- isInSession
	Check if there is an active session between participants.
(NSString *_Nullable)	- getSDKVersion
	Returns Zoom SDK internal version.
(NSString *_Nullable)	- exportLog
	Exporting a log file to local disk.
(ZoomVideoSDKError)	- cleanAllExportedLogs
	Clean all exported logs.
(ZoomVideoSDKAudioHelper *_Nullable)	- getAudioHelper
	Returns an instance to manage audio controls related to the current video SDK session.
(ZoomVideoSDKVideoHelper *_Nullable)	- getVideoHelper
	Returns an instance to manage cameras and video during a video SDK session.
(ZoomVideoSDKUserHelper *_Nullable)	- getUserHelper
	Returns an instance to manage users present in a video SDK session.
(ZoomVideoSDKShareHelper *_Nullable)	- getShareHelper
	Returns an instance to manage screen sharing during a video SDK session.
(ZoomVideoSDKLiveStreamHelper *_Nullable)	- getLiveStreamHelper
	Returns an instance to manage live streaming during a video SDK session.
(ZoomVideoSDKIncomingLiveStreamHelper *_Nullable)	- getIncomingLiveStreamHelper
	Get incoming live stream helper object.
(ZoomVideoSDKChatHelper *_Nullable)	- getChatHelper
	Returns an instance to send and receive chat messages within video SDK session participants.
(ZoomVideoSDKPhoneHelper *_Nullable)	- getPhoneHelper
	Returns an instance to manage phone invitations during a video SDK session.
(ZoomVideoSDKCmdChannel *_Nullable)	- getCmdChannel
	Returns an instance to use command channel features during a video SDK session.
(ZoomVideoSDKRecordingHelper *_Nullable)	- getRecordingHelper
	Returns an instance to manage cloud recordings during a video SDK session.
(ZoomVideoSDKAudioSettingHelper *_Nullable)	- getAudioSettingHelper
	Get audio setting helper.
(ZoomVideoSDKTestAudioDeviceHelper *_Nullable)	- getTestAudioDeviceHelper
	Get test audio device helper.
(ZoomVideoSDKLiveTranscriptionHelper *_Nullable)	- getLiveTranscriptionHelper
	Get live transcription helper object.
(ZoomVideoSDKVirtualBackgroundHelper *_Nullable)	- getVirtualBackgroundHelper
	Get virtual background helper object.
(ZoomVideoSDKCRCHelper *_Nullable)	- getCRCHelper
	Get crc helper object.
(ZoomVideoSDKMaskHelper *_Nullable)	- getMaskHelper
	Get mask helper Object.

Class Methods
(ZoomVideoSDK *_Nullable)	+ shareInstance
	Returns ZoomVideoSDK instance.

Properties
id< ZoomVideoSDKDelegate > _Nullable	delegate
	The delegate of ZoomVideoSDK, a listener object that groups together all the callbacks related to a session.

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.

Warning

Access to the class and all the other components of the VideoSDK by merging <ZoomVideoSDK/ZoomVideoSDK.h> into source code.

The user can only obtain SDK configuration by initializing the class.

Definition at line 200 of file ZoomVideoSDK.h.

Method Documentation

cleanAllExportedLogs

- (ZoomVideoSDKError) cleanAllExportedLogs

Clean all exported logs.

Returns

If the function succeeds, it will return Errors_Success. Otherwise failed.

cleanup

- (ZoomVideoSDKError) cleanup

un-nitialize the Zoom SDK.

Warning

Only cleanup succesfully after initialized .

Returns

The result of cleanup SDK.

exportLog

- (NSString *_Nullable) exportLog

Exporting a log file to local disk.

Returns

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

getAudioHelper

- (ZoomVideoSDKAudioHelper *_Nullable) getAudioHelper

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

Returns

The object of ZoomVideoSDKAudioHelper. See [ZoomVideoSDKAudioHelper]

getAudioSettingHelper

- (ZoomVideoSDKAudioSettingHelper *_Nullable) getAudioSettingHelper

Get audio setting helper.

Returns

A [ZoomVideoSDKAudioSettingHelper] instance.

getChatHelper

- (ZoomVideoSDKChatHelper *_Nullable) getChatHelper

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

Returns

The object of ZoomVideoSDKChatHelper. See [ZoomVideoSDKChatHelper].

getCmdChannel

- (ZoomVideoSDKCmdChannel *_Nullable) getCmdChannel

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

Returns

A [ZoomVideoSDKCmdChannel] instance.

getCRCHelper

- (ZoomVideoSDKCRCHelper *_Nullable) getCRCHelper

Get crc helper object.

Returns

If the function succeeds, the return value is the crc helper object. Otherwise returns nil.

getIncomingLiveStreamHelper

- (ZoomVideoSDKIncomingLiveStreamHelper *_Nullable) getIncomingLiveStreamHelper

Get incoming live stream helper object.

Returns

The object of ZoomVideoSDKLiveStreamHelper. See [ZoomVideoSDKIncomingLiveStreamHelper].

getLiveStreamHelper

- (ZoomVideoSDKLiveStreamHelper *_Nullable) getLiveStreamHelper

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

Returns

The object of ZoomVideoSDKLiveStreamHelper. See [ZoomVideoSDKLiveStreamHelper].

getLiveTranscriptionHelper

- (ZoomVideoSDKLiveTranscriptionHelper *_Nullable) getLiveTranscriptionHelper

Get live transcription helper object.

Returns

A [ZoomVideoSDKLiveTranscriptionHelper] instance.

getMaskHelper

- (ZoomVideoSDKMaskHelper *_Nullable) getMaskHelper

Get mask helper Object.

Returns

If the function succeeds, the return value is the mask helper object. Otherwise returns nil.

getPhoneHelper

- (ZoomVideoSDKPhoneHelper *_Nullable) getPhoneHelper

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

Returns

The object of ZoomVideoSDKPhoneHelper. See [ZoomVideoSDKPhoneHelper].

getRecordingHelper

- (ZoomVideoSDKRecordingHelper *_Nullable) getRecordingHelper

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

Returns

A [ZoomVideoSDKRecordingHelper] instance.

getSDKVersion

- (NSString *_Nullable) getSDKVersion

Returns Zoom SDK internal version.

Returns

SDK version.

getSession

- (ZoomVideoSDKSession *_Nullable) getSession

Returns the current session information.

Returns

Session information See [SDKSessionInfo].

getShareHelper

- (ZoomVideoSDKShareHelper *_Nullable) getShareHelper

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

Returns

The object of ZoomVideoSDKShareHelper. See [ZoomVideoSDKShareHelper].

getTestAudioDeviceHelper

- (ZoomVideoSDKTestAudioDeviceHelper *_Nullable) getTestAudioDeviceHelper

Get test audio device helper.

Returns

A [ZoomVideoSDKTestAudioDeviceHelper] instance.

getUserHelper

- (ZoomVideoSDKUserHelper *_Nullable) getUserHelper

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

Returns

The object of ZoomVideoSDKUserHelper. See [ZoomVideoSDKUserHelper].

getVideoHelper

- (ZoomVideoSDKVideoHelper *_Nullable) getVideoHelper

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

Returns

The object of ZoomVideoSDKVideoHelper. See [ZoomVideoSDKVideoHelper].

getVirtualBackgroundHelper

- (ZoomVideoSDKVirtualBackgroundHelper *_Nullable) getVirtualBackgroundHelper

Get virtual background helper object.

Returns

A [ZoomVideoSDKLiveTranscriptionHelper] instance.

initialize:

- (ZoomVideoSDKError) initialize:

(ZoomVideoSDKInitParams *_Nonnull)

context

Initialize the Zoom SDK with the appropriate parameters in the ZoomVideoSDKInitParams object.

Warning

Need initialize first for doing the following steps.

Parameters

context

Initialize the parameter configuration of the SDK, please See [ZoomVideoSDKInitParams].

Returns

The result of initialize SDK.

isInSession

- (BOOL) isInSession

Check if there is an active session between participants.

Returns

YES if there is; NO if not

joinSession:

- (ZoomVideoSDKSession *_Nullable) joinSession:

(ZoomVideoSDKSessionContext *_Nonnull)

context

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 delegate to confirm whether the SDK actually joined.

Parameters

context

The context which contains the parameters.

Returns

The state of join session, started or failed.

leaveSession:

- (ZoomVideoSDKError) leaveSession:

(BOOL)

end

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 delegate to confirm whether the SDK actually left.

Parameters

end	if end the session for host. YES if the host should end the entire session, or NO if the host should just leave the session.

Warning

only host can end session. You can get the isHost information from in-Session 'userInfo'.

Returns

The result of it.

shareInstance

+ (ZoomVideoSDK *_Nullable) shareInstance

Returns ZoomVideoSDK instance.

Property Documentation

delegate

- (id<ZoomVideoSDKDelegate> _Nullable) delegate

readwritenonatomicweak

The delegate of ZoomVideoSDK, a listener object that groups together all the callbacks related to a session.

Definition at line 205 of file ZoomVideoSDK.h.