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:
	Initializes the Zoom SDK with the appropriate parameters in the ZoomVideoSDKInitParams object.
(ZoomVideoSDKError)	- cleanup
	Uninitializes the Zoom SDK.
(ZoomVideoSDKSession *_Nullable)	- joinSession:
	Joins 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.
(ZoomVideoSDKSession *_Nullable)	- prepareJoin:preJoinParam:
	Pre-joins a session in the two-step join flow. Call commitJoin to confirm or cancelPrepareJoin to cancel.
(ZoomVideoSDKError)	- commitJoin
	Confirms the join after prepareJoin:preJoinParam:. Valid in the two-step join flow.
(ZoomVideoSDKError)	- cancelPrepareJoin
	Cancels the prepare join. Valid in the two-step join flow.
(ZoomVideoSDKError)	- leaveSession:
	Leaves 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
	Gets the current session information.
(BOOL)	- isInSession
	Determines whether there is an active session between participants.
(NSString *_Nullable)	- getSDKVersion
	Gets the Zoom SDK internal version.
(NSString *_Nullable)	- exportLog
	Exports a log file to local disk.
(ZoomVideoSDKError)	- cleanAllExportedLogs
	Cleans all exported logs.
(ZoomVideoSDKAudioHelper *_Nullable)	- getAudioHelper
	Gets an instance to manage audio controls related to the current video SDK session.
(ZoomVideoSDKVideoHelper *_Nullable)	- getVideoHelper
	Gets an instance to manage cameras and video during a video SDK session.
(ZoomVideoSDKUserHelper *_Nullable)	- getUserHelper
	Gets an instance to manage users present in a video SDK session.
(ZoomVideoSDKShareHelper *_Nullable)	- getShareHelper
	Gets an instance to manage screen sharing during a video SDK session.
(ZoomVideoSDKLiveStreamHelper *_Nullable)	- getLiveStreamHelper
	Gets an instance to manage live streaming during a video SDK session.
(ZoomVideoSDKIncomingLiveStreamHelper *_Nullable)	- getIncomingLiveStreamHelper
	Gets the incoming live stream helper object.
(ZoomVideoSDKChatHelper *_Nullable)	- getChatHelper
	Gets an instance to send and receive chat messages within video SDK session participants.
(ZoomVideoSDKPhoneHelper *_Nullable)	- getPhoneHelper
	Gets an instance to manage phone invitations during a video SDK session.
(ZoomVideoSDKCmdChannel *_Nullable)	- getCmdChannel
	Gets an instance to use command channel features during a video SDK session.
(ZoomVideoSDKRecordingHelper *_Nullable)	- getRecordingHelper
	Gets an instance to manage cloud recordings during a video SDK session.
(ZoomVideoSDKAudioSettingHelper *_Nullable)	- getAudioSettingHelper
	Gets the audio setting helper.
(ZoomVideoSDKVideoSettingHelper *_Nullable)	- getVideoSettingHelper
	Gets the video setting helper.
(ZoomVideoSDKTestAudioDeviceHelper *_Nullable)	- getTestAudioDeviceHelper
	Gets the test audio device helper.
(ZoomVideoSDKLiveTranscriptionHelper *_Nullable)	- getLiveTranscriptionHelper
	Gets the live transcription helper object.
(ZoomVideoSDKVoiceInterpretationHelper *_Nullable)	- getVoiceInterpretationHelper
	Gets the voice interpretation helper object.
(ZoomVideoSDKVirtualBackgroundHelper *_Nullable)	- getVirtualBackgroundHelper
	Gets the virtual background helper object.
(ZoomVideoSDKCRCHelper *_Nullable)	- getCRCHelper
	Gets the CRC helper object.
(ZoomVideoSDKMaskHelper *_Nullable)	- getMaskHelper
	Gets the mask helper object.
(ZoomVideoSDKSubSessionHelper *_Nullable)	- getsubSessionHelper
	Gets the SubSession stream helper object. Only host and manager can call this interface.
(ZoomVideoSDKSessionType)	- getSessionType
	Gets the session type of this session.
(ZoomVideoSDKBroadcastStreamingHelper *_Nullable)	- getBroadcastStreamingHelper
	Gets the broadcast streaming controller object.
(ZoomVideoSDKBroadcastStreamingViewerHelper *_Nullable)	- getBroadcastStreamingViewerHelper
	Gets the broadcast streaming viewer object.
(ZoomVideoSDKEmojiReactionHelper *_Nullable)	- getEmojiReactionHelper
	Gets the emoji reaction helper object.
(ZoomVideoSDKWhiteboardHelper *_Nullable)	- getWhiteboardHelper
	Gets the whiteboard helper object.
(ZoomVideoRealTimeMediaStreamsHelper *_Nullable)	- getRealTimeMediaStreamsHelper
	Gets an instance to manage RTMS (Real-Time Media Streams) during a video SDK session.

Class Methods
(ZoomVideoSDK *_Nullable)	+ shareInstance
	Returns ZoomVideoSDK instance.
(ZoomVideoSDK *_Nullable)	+ sharedInstance
	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 233 of file ZoomVideoSDK.h.

Method Documentation

◆ cancelPrepareJoin

- (ZoomVideoSDKError) cancelPrepareJoin

Cancels the prepare join. Valid in the two-step join flow.

Returns: If the function succeeds, it returns Errors_Success. Otherwise, this function returns an error.

References cancelPrepareJoin.

Referenced by cancelPrepareJoin.

◆ cleanAllExportedLogs

- (ZoomVideoSDKError) cleanAllExportedLogs

Cleans all exported logs.

Returns: If the function succeeds, it returns Errors_Success. Otherwise, this function returns an error.

References cleanAllExportedLogs.

Referenced by cleanAllExportedLogs.

◆ cleanup

- (ZoomVideoSDKError) cleanup

Uninitializes the Zoom SDK.

Returns: If the function succeeds, it returns Errors_Success. Otherwise, this function returns an error.

Warning: This function cannot be called while in a session. Leave the session before calling -[ZoomVideoSDK cleanup].

References cleanup.

Referenced by cleanup.

◆ commitJoin

- (ZoomVideoSDKError) commitJoin

Confirms the join after prepareJoin:preJoinParam:. Valid in the two-step join flow.

Returns: If the function succeeds, it returns Errors_Success. Otherwise, this function returns an error.

Note: If the commit fails asynchronously, onError is triggered.

References commitJoin.

Referenced by commitJoin.

◆ exportLog

- (NSString *_Nullable) exportLog

Exports a log file to local disk.

Returns: If the function succeeds, it returns the exported log file path. Otherwise, this function fails and returns nil.

References exportLog.

Referenced by exportLog.

◆ getAudioHelper

- (ZoomVideoSDKAudioHelper *_Nullable) getAudioHelper

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

Returns: If the function succeeds, it returns a ZoomVideoSDKAudioHelper object. Otherwise, this function fails and returns nil.

References getAudioHelper.

Referenced by getAudioHelper.

◆ getAudioSettingHelper

- (ZoomVideoSDKAudioSettingHelper *_Nullable) getAudioSettingHelper

Gets the audio setting helper.

Returns: If the function succeeds, it returns a ZoomVideoSDKAudioSettingHelper object. Otherwise, this function fails and returns nil.

References getAudioSettingHelper.

Referenced by getAudioSettingHelper.

◆ getBroadcastStreamingHelper

- (ZoomVideoSDKBroadcastStreamingHelper *_Nullable) getBroadcastStreamingHelper

Gets the broadcast streaming controller object.

Returns: If the function succeeds, it returns a ZoomVideoSDKBroadcastStreamingHelper object. Otherwise, this function fails and returns nil.

References getBroadcastStreamingHelper.

Referenced by getBroadcastStreamingHelper.

◆ getBroadcastStreamingViewerHelper

- (ZoomVideoSDKBroadcastStreamingViewerHelper *_Nullable) getBroadcastStreamingViewerHelper

Gets the broadcast streaming viewer object.

Returns: If the function succeeds, it returns a ZoomVideoSDKBroadcastStreamingViewerHelper object. Otherwise, this function fails and returns nil.

References getBroadcastStreamingViewerHelper.

Referenced by getBroadcastStreamingViewerHelper.

◆ getChatHelper

- (ZoomVideoSDKChatHelper *_Nullable) getChatHelper

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

Returns: If the function succeeds, it returns a ZoomVideoSDKChatHelper object. Otherwise, this function fails and returns nil.

References getChatHelper.

Referenced by getChatHelper.

◆ getCmdChannel

- (ZoomVideoSDKCmdChannel *_Nullable) getCmdChannel

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

Returns: If the function succeeds, it returns a ZoomVideoSDKCmdChannel object. Otherwise, this function fails and returns nil.

References getCmdChannel.

Referenced by getCmdChannel.

◆ getCRCHelper

- (ZoomVideoSDKCRCHelper *_Nullable) getCRCHelper

Gets the CRC helper object.

Returns: If the function succeeds, it returns a ZoomVideoSDKCRCHelper object. Otherwise, this function fails and returns nil.

References getCRCHelper.

Referenced by getCRCHelper.

◆ getEmojiReactionHelper

- (ZoomVideoSDKEmojiReactionHelper *_Nullable) getEmojiReactionHelper

Gets the emoji reaction helper object.

Returns: If the function succeeds, it returns a ZoomVideoSDKEmojiReactionHelper object. Otherwise, this function fails and returns nil.

References getEmojiReactionHelper.

Referenced by getEmojiReactionHelper.

◆ getIncomingLiveStreamHelper

- (ZoomVideoSDKIncomingLiveStreamHelper *_Nullable) getIncomingLiveStreamHelper

Gets the incoming live stream helper object.

Returns: If the function succeeds, it returns a ZoomVideoSDKIncomingLiveStreamHelper object. Otherwise, this function fails and returns nil.

References getIncomingLiveStreamHelper.

Referenced by getIncomingLiveStreamHelper.

◆ getLiveStreamHelper

- (ZoomVideoSDKLiveStreamHelper *_Nullable) getLiveStreamHelper

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

Returns: If the function succeeds, it returns a ZoomVideoSDKLiveStreamHelper object. Otherwise, this function fails and returns nil.

References getLiveStreamHelper.

Referenced by getLiveStreamHelper.

◆ getLiveTranscriptionHelper

- (ZoomVideoSDKLiveTranscriptionHelper *_Nullable) getLiveTranscriptionHelper

Gets the live transcription helper object.

Returns: If the function succeeds, it returns a ZoomVideoSDKLiveTranscriptionHelper object. Otherwise, this function fails and returns nil.

References getLiveTranscriptionHelper.

Referenced by getLiveTranscriptionHelper.

◆ getMaskHelper

- (ZoomVideoSDKMaskHelper *_Nullable) getMaskHelper

Gets the mask helper object.

Returns: If the function succeeds, it returns a ZoomVideoSDKMaskHelper object. Otherwise, this function fails and returns nil.

References getMaskHelper.

Referenced by getMaskHelper.

◆ getPhoneHelper

- (ZoomVideoSDKPhoneHelper *_Nullable) getPhoneHelper

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

Returns: If the function succeeds, it returns a ZoomVideoSDKPhoneHelper object. Otherwise, this function fails and returns nil.

References getPhoneHelper.

Referenced by getPhoneHelper.

◆ getRealTimeMediaStreamsHelper

- (ZoomVideoRealTimeMediaStreamsHelper *_Nullable) getRealTimeMediaStreamsHelper

Gets an instance to manage RTMS (Real-Time Media Streams) during a video SDK session.

Returns: If the function succeeds, it returns a ZoomVideoRealTimeMediaStreamsHelper object. Otherwise, this function fails and returns nil.

References getRealTimeMediaStreamsHelper.

Referenced by getRealTimeMediaStreamsHelper.

◆ getRecordingHelper

- (ZoomVideoSDKRecordingHelper *_Nullable) getRecordingHelper

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

Returns: If the function succeeds, it returns a ZoomVideoSDKRecordingHelper object. Otherwise, this function fails and returns nil.

References getRecordingHelper.

Referenced by getRecordingHelper.

◆ getSDKVersion

- (NSString *_Nullable) getSDKVersion

Gets the Zoom SDK internal version.

Returns: If the function succeeds, it returns the SDK version. Otherwise, this function fails and returns nil.

References getSDKVersion.

Referenced by getSDKVersion.

◆ getSession

- (ZoomVideoSDKSession *_Nullable) getSession

Gets the current session information.

Returns: If the function succeeds, it returns a ZoomVideoSDKSession object. Otherwise, this function fails and returns nil.

References getSession.

Referenced by getSession.

◆ getSessionType

- (ZoomVideoSDKSessionType) getSessionType

Gets the session type of this session.

Returns: If the function succeeds, it returns the session type. Otherwise, this function returns an error.

Deprecated: Use getSessionType] instead.

References getSessionType.

Referenced by getSessionType.

◆ getShareHelper

- (ZoomVideoSDKShareHelper *_Nullable) getShareHelper

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

Returns: If the function succeeds, it returns a ZoomVideoSDKShareHelper object. Otherwise, this function fails and returns nil.

References getShareHelper.

Referenced by getShareHelper.

◆ getsubSessionHelper

- (ZoomVideoSDKSubSessionHelper *_Nullable) getsubSessionHelper

Gets the SubSession stream helper object. Only host and manager can call this interface.

Returns: If the function succeeds, it returns a ZoomVideoSDKSubSessionHelper object. Otherwise, this function fails and returns nil.

References getsubSessionHelper.

Referenced by getsubSessionHelper.

◆ getTestAudioDeviceHelper

- (ZoomVideoSDKTestAudioDeviceHelper *_Nullable) getTestAudioDeviceHelper

Gets the test audio device helper.

Returns: If the function succeeds, it returns a ZoomVideoSDKTestAudioDeviceHelper object. Otherwise, this function fails and returns nil.

References getTestAudioDeviceHelper.

Referenced by getTestAudioDeviceHelper.

◆ getUserHelper

- (ZoomVideoSDKUserHelper *_Nullable) getUserHelper

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

Returns: If the function succeeds, it returns a ZoomVideoSDKUserHelper object. Otherwise, this function fails and returns nil.

References getUserHelper.

Referenced by getUserHelper.

◆ getVideoHelper

- (ZoomVideoSDKVideoHelper *_Nullable) getVideoHelper

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

Returns: If the function succeeds, it returns a ZoomVideoSDKVideoHelper object. Otherwise, this function fails and returns nil.

References getVideoHelper.

Referenced by getVideoHelper.

◆ getVideoSettingHelper

- (ZoomVideoSDKVideoSettingHelper *_Nullable) getVideoSettingHelper

Gets the video setting helper.

Returns: If the function succeeds, it returns a ZoomVideoSDKVideoSettingHelper object. Otherwise, this function fails and returns nil.

References getVideoSettingHelper.

Referenced by getVideoSettingHelper.

◆ getVirtualBackgroundHelper

- (ZoomVideoSDKVirtualBackgroundHelper *_Nullable) getVirtualBackgroundHelper

Gets the virtual background helper object.

Returns: If the function succeeds, it returns a ZoomVideoSDKVirtualBackgroundHelper object. Otherwise, this function fails and returns nil.

References getVirtualBackgroundHelper.

Referenced by getVirtualBackgroundHelper.

◆ getVoiceInterpretationHelper

- (ZoomVideoSDKVoiceInterpretationHelper *_Nullable) getVoiceInterpretationHelper

Gets the voice interpretation helper object.

Returns: If the function succeeds, it returns a ZoomVideoSDKVoiceInterpretationHelper object. Otherwise, this function fails and returns nil.

References getVoiceInterpretationHelper.

Referenced by getVoiceInterpretationHelper.

◆ getWhiteboardHelper

- (ZoomVideoSDKWhiteboardHelper *_Nullable) getWhiteboardHelper

Gets the whiteboard helper object.

Returns: If the function succeeds, it returns a ZoomVideoSDKWhiteboardHelper object. Otherwise, this function fails and returns nil.

References getWhiteboardHelper.

Referenced by getWhiteboardHelper.

◆ initialize:

- (ZoomVideoSDKError) initialize: (ZoomVideoSDKInitParams *_Nonnull) context

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

Parameters

context The parameter configuration of the SDK.

Returns: If the function succeeds, it returns Errors_Success. Otherwise, this function returns an error.

Warning: Need to initialize first before doing the following steps.

◆ isInSession

- (BOOL) isInSession

Determines whether there is an active session between participants.

Returns: YES if there is an active session. Otherwise, NO.

References isInSession.

Referenced by isInSession.

◆ joinSession:

- (ZoomVideoSDKSession *_Nullable) joinSession: (ZoomVideoSDKSessionContext *_Nonnull) context

Joins 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: If the function succeeds, it returns a ZoomVideoSDKSession object. Otherwise, this function fails and returns nil.

◆ leaveSession:

- (ZoomVideoSDKError) leaveSession: (BOOL) end

Leaves 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	YES if the host should end the entire session, NO if the host should just leave the session.

Returns: If the function succeeds, it returns Errors_Success. Otherwise, this function returns an error.

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

◆ prepareJoin:preJoinParam:

- (ZoomVideoSDKSession *_Nullable) prepareJoin:		(ZoomVideoSDKSessionContext *_Nonnull)	context
preJoinParam:		(ZoomVideoSDKPreJoinParam *_Nonnull)	preJoinParam

Pre-joins a session in the two-step join flow. Call commitJoin to confirm or cancelPrepareJoin to cancel.

Parameters

context	The session context parameters.
preJoinParam	The pre-join parameters. Do not pass nil; set timeoutInterval to 0 to use the SDK default. Valid non-zero values are 1 to 60 seconds.

Returns: If the function succeeds, it returns a ZoomVideoSDKSession object. Otherwise, this function fails and returns nil.

Note: This API is intended for joining a session that has already been started by a host. If no host has started the session, this call fails.

◆ sharedInstance

+ (ZoomVideoSDK *_Nullable) sharedInstance

Returns ZoomVideoSDK instance.

References sharedInstance.

Referenced by sharedInstance, and shareInstance.

◆ shareInstance

+ (ZoomVideoSDK *_Nullable) shareInstance

Returns ZoomVideoSDK instance.

References sharedInstance, and shareInstance.

Referenced by shareInstance.

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 238 of file ZoomVideoSDK.h.

Instance Methods

Class Methods

Properties

Detailed Description

Method Documentation

◆ cancelPrepareJoin

◆ cleanAllExportedLogs

◆ cleanup

◆ commitJoin

◆ exportLog

◆ getAudioHelper

◆ getAudioSettingHelper

◆ getBroadcastStreamingHelper

◆ getBroadcastStreamingViewerHelper

◆ getChatHelper

◆ getCmdChannel

◆ getCRCHelper

◆ getEmojiReactionHelper

◆ getIncomingLiveStreamHelper

◆ getLiveStreamHelper

◆ getLiveTranscriptionHelper

◆ getMaskHelper

◆ getPhoneHelper

◆ getRealTimeMediaStreamsHelper

◆ getRecordingHelper

◆ getSDKVersion

◆ getSession

◆ getSessionType

◆ getShareHelper

◆ getsubSessionHelper

◆ getTestAudioDeviceHelper

◆ getUserHelper

◆ getVideoHelper

◆ getVideoSettingHelper

◆ getVirtualBackgroundHelper

◆ getVoiceInterpretationHelper

◆ getWhiteboardHelper

◆ initialize:

◆ isInSession

◆ joinSession:

◆ leaveSession:

◆ prepareJoin:preJoinParam:

◆ sharedInstance

◆ shareInstance

Property Documentation

◆ delegate