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 <ZMVideoSDK.h>

Inherits NSObject.

Instance Methods
(ZMVideoSDKErrors)	- initialize:
	Initialize the Zoom Video SDK with the appropriate parameters.

(void)	- cleanUp
	Clean up Zoom Video SDK.

(void)	- addListener:
	Register a listener for session events.

(void)	- removeListener:
	Unregister a listener for session events.

(ZMVideoSDKSession *_Nullable)	- joinSession:
	Call this method to join a session with the appropriate ZMVideoSDKSessionContext parameters. When successful, the SDK will attempt to join a session. Use the callbacks in the listener to confirm whether the SDK actually joined.

(ZMVideoSDKErrors)	- 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 listener to confirm whether the SDK actually left.

(ZMVideoSDKSession *)	- getSessionInfo
	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
	Exports a log file to local disk.

(ZMVideoSDKErrors)	- cleanAllExportedLogs
	Cleans all exported logs.

(ZMVideoSDKAudioHelper *)	- getAudioHelper
	Returns an instance to manage audio controls related to the current video SDK session.

(ZMVideoSDKVideoHelper *)	- getVideoHelper
	Returns an instance to manage cameras and video during a video SDK session.

(ZMVideoSDKUserHelper *)	- getUserHelper
	Returns an instance to manage users present in a video SDK session.

(ZMVideoSDKShareHelper *)	- getShareHelper
	Returns an instance to manage screen sharing during a video SDK session.

(ZMVideoSDKLiveStreamHelper *)	- getLiveStreamHelper
	Returns an instance to manage live streaming during a video SDK session.

(ZMVideoSDKChatHelper *)	- getChatHelper
	Returns an instance to send and receive chat messages within video SDK session participants.

(ZMVideoSDKRecordingHelper *)	- getRecordingHelper
	Returns an instance to manage cloud recordings during a video SDK session.

(ZMVideoSDKCmdChannel *)	- getCmdChannel
	Returns an instance to use command channel features during a video SDK session.

(ZMVideoSDKPhoneHelper *)	- getPhoneHelper
	Returns an instance to manage phone invitations during a video SDK session.

(ZMVideoSDKAudioSettingHelper *)	- getAudioSettingHelper
	Returns an instance to manage audio setting during or before a video SDK session.

(ZMVideoSDKAudioDeviceTestHelper *)	- getAudioDeviceTestHelper
	Returns an instance to manage audio device test during or before a video SDK session.

(ZMVideoSDKNetworkConnectionHelper *)	- getNetworkConnectionHelper
	Returns an instance to manage network connection during or before a video SDK session.

(ZMVideoSDKVideoSettingHelper *)	- getVideoSettingHelper
	Get video setting helper object.

(ZMVideoSDKShareSettingHelper *)	- getShareSettingHelper
	Get share setting helper object.

(ZMVideoSDKCRCHelper *)	- getCRCHelper
	Get crc helper object.

(ZMVideoSDKLiveTranscriptionHelper *)	- getLiveTranscriptionHelper
	Get live transcription helper object.

(ZMVideoSDKIncomingLiveStreamHelper *)	- getIncomingLiveStreamHelper
	Get incoming live stream helper object.

(ZMVideoSDKSubSessionHelper *_Nullable)	- getSubSessionHelper
	Get the subsession helper object.

(ZMVideoSDKBroadcastStreamingController *_Nullable)	- getBroadcastStreamingController
	Gets the broadcast streaming controller object.

(ZMVideoSDKBroadcastStreamingViewer *_Nullable)	- getBroadcastStreamingViewer
	Gets the broadcast streaming viewer object.

(ZMVideoSDKRTMSHelper *_Nullable)	- getRealTimeMediaStreamsHelper
	Returns an instance to manage RTMS (Real-Time Media Streams) during a video SDK session.

Class Methods
(ZMVideoSDK *)	+ sharedVideoSDK
	Returns ZMVideoSDK instance.

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 218 of file ZMVideoSDK.h.

Method Documentation

◆ addListener:

- (void) addListener: (id< ZMVideoSDKDelegate >) listener

Register a listener for session events.

Parameters

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

◆ cleanAllExportedLogs

- (ZMVideoSDKErrors) cleanAllExportedLogs

Cleans all exported logs.

Returns: If the function succeeds, it will return ZMVideoSDKErrors_Success. Otherwise the function fails.

◆ cleanUp

- (void) cleanUp

Clean up Zoom Video SDK.

◆ exportLog

- (NSString *_Nullable) exportLog

Exports a log file to local disk.

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

◆ getAudioDeviceTestHelper

- (ZMVideoSDKAudioDeviceTestHelper *) getAudioDeviceTestHelper

Returns an instance to manage audio device test during or before a video SDK session.

Returns: If the function succeeds, it will return a ZMVideoSDKAudioDeviceTestHelper instance, otherwise returns nil.

◆ getAudioHelper

- (ZMVideoSDKAudioHelper *) getAudioHelper

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

Returns: If the function succeeds, it will return a ZMVideoSDKAudioHelper instance, otherwise returns nil.

◆ getAudioSettingHelper

- (ZMVideoSDKAudioSettingHelper *) getAudioSettingHelper

Returns an instance to manage audio setting during or before a video SDK session.

Returns: If the function succeeds, it will return a ZMVideoSDKAudioSettingHelper instance, otherwise returns nil.

◆ getBroadcastStreamingController

- (ZMVideoSDKBroadcastStreamingController *_Nullable) getBroadcastStreamingController

Gets the broadcast streaming controller object.

Returns: The broadcast streaming controller object if available; otherwise, nil.

◆ getBroadcastStreamingViewer

- (ZMVideoSDKBroadcastStreamingViewer *_Nullable) getBroadcastStreamingViewer

Gets the broadcast streaming viewer object.

Returns: The broadcast streaming viewer object if available; otherwise, nil.

◆ getChatHelper

- (ZMVideoSDKChatHelper *) getChatHelper

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

Returns: If the function succeeds, it will return a ZMVideoSDKChatHelper instance, otherwise returns nil.

◆ getCmdChannel

- (ZMVideoSDKCmdChannel *) getCmdChannel

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

Returns: If the function succeeds, it will return a ZMVideoSDKCmdChannel instance, otherwise returns nil.

◆ getCRCHelper

- (ZMVideoSDKCRCHelper *) getCRCHelper

Get crc helper object.

Returns: If the function succeeds, it will return a ZMVideoSDKCRCHelper instance, otherwise returns nil.

◆ getIncomingLiveStreamHelper

- (ZMVideoSDKIncomingLiveStreamHelper *) getIncomingLiveStreamHelper

Get incoming live stream helper object.

Returns: If the function succeeds, it will return a ZMVideoSDKIncomingLiveStreamHelper instance, otherwise returns nil.

◆ getLiveStreamHelper

- (ZMVideoSDKLiveStreamHelper *) getLiveStreamHelper

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

Returns: If the function succeeds, it will return a ZMVideoSDKLiveStreamHelper instance, otherwise returns nil.

◆ getLiveTranscriptionHelper

- (ZMVideoSDKLiveTranscriptionHelper *) getLiveTranscriptionHelper

Get live transcription helper object.

Returns: If the function succeeds, it will return a ZMVideoSDKLiveTranscriptionHelper instance, otherwise returns nil.

◆ getNetworkConnectionHelper

- (ZMVideoSDKNetworkConnectionHelper *) getNetworkConnectionHelper

Returns an instance to manage network connection during or before a video SDK session.

Returns: If the function succeeds, it will return a ZMVideoSDKNetworkConnectionHelper instance, otherwise returns nil.

◆ getPhoneHelper

- (ZMVideoSDKPhoneHelper *) getPhoneHelper

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

Returns: If the function succeeds, it will return a ZMVideoSDKPhoneHelper instance, otherwise returns nil.

◆ getRealTimeMediaStreamsHelper

- (ZMVideoSDKRTMSHelper *_Nullable) getRealTimeMediaStreamsHelper

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

Returns: If the function succeeds, it will return a ZMVideoSDKRTMSHelper instance, otherwise returns nil.

◆ getRecordingHelper

- (ZMVideoSDKRecordingHelper *) getRecordingHelper

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

Returns: If the function succeeds, it will return a ZMVideoSDKRecordingHelper instance, otherwise returns nil.

◆ getSDKVersion

- (NSString *_Nullable) getSDKVersion

Returns Zoom SDK internal version.

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

◆ getSessionInfo

- (ZMVideoSDKSession *) getSessionInfo

Returns the current session information.

Returns: If the function succeeds, it will return a session object, otherwise returns nil.

◆ getShareHelper

- (ZMVideoSDKShareHelper *) getShareHelper

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

Returns: If the function succeeds, it will return a ZMVideoSDKShareHelper instance, otherwise returns nil.

◆ getShareSettingHelper

- (ZMVideoSDKShareSettingHelper *) getShareSettingHelper

Get share setting helper object.

Returns: If the function succeeds, it will return a ZMVideoSDKShareSettingHelper instance, otherwise returns nil.

◆ getSubSessionHelper

- (ZMVideoSDKSubSessionHelper *_Nullable) getSubSessionHelper

Get the subsession helper object.

Returns: If the function succeeds, it will return a ZMVideoSDKSubSessionHelper instance, otherwise returns nil.

Note: Only host and manager can call this interface.

◆ getUserHelper

- (ZMVideoSDKUserHelper *) getUserHelper

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

Returns: If the function succeeds, it will return a ZMVideoSDKUserHelper instance, otherwise returns nil.

◆ getVideoHelper

- (ZMVideoSDKVideoHelper *) getVideoHelper

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

Returns: If the function succeeds, it will return a ZMVideoSDKVideoHelper instance, otherwise returns nil.

◆ getVideoSettingHelper

- (ZMVideoSDKVideoSettingHelper *) getVideoSettingHelper

Get video setting helper object.

Returns: If the function succeeds, it will return a ZMVideoSDKVideoSettingHelper instance, otherwise returns nil.

◆ initialize:

- (ZMVideoSDKErrors) initialize: (ZMVideoSDKInitParams *) params

Initialize the Zoom Video SDK with the appropriate parameters.

Parameters

params An initialization parameter object containing all required configuration fields.

Returns: If the function succeeds, it will return ZMVideoSDKErrors_Success.

◆ isInSession

- (BOOL) isInSession

Check if there is an active session between participants.

Returns: YES means in session, otherwise not.

◆ joinSession:

- (ZMVideoSDKSession *_Nullable) joinSession: (ZMVideoSDKSessionContext *) params

Call this method to join a session with the appropriate ZMVideoSDKSessionContext 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

params It is a session context object, contain all params to join session.

Returns: If the function succeeds, the return value is the pointer of session object, otherwise returns nil.

◆ leaveSession:

- (ZMVideoSDKErrors) 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 listener to confirm whether the SDK actually left.

Parameters

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

Returns: If the function succeeds, it will return ZMVideoSDKErrors_Success.

◆ removeListener:

- (void) removeListener: (id< ZMVideoSDKDelegate >) listener

Unregister a listener for session events.

Parameters

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

◆ sharedVideoSDK

+ (ZMVideoSDK *) sharedVideoSDK

Returns ZMVideoSDK instance.

Returns: ZMVideoSDK instance.

Instance Methods

Class Methods

Detailed Description

Method Documentation

◆ addListener:

◆ cleanAllExportedLogs

◆ cleanUp

◆ exportLog

◆ getAudioDeviceTestHelper

◆ getAudioHelper

◆ getAudioSettingHelper

◆ getBroadcastStreamingController

◆ getBroadcastStreamingViewer

◆ getChatHelper

◆ getCmdChannel

◆ getCRCHelper

◆ getIncomingLiveStreamHelper

◆ getLiveStreamHelper

◆ getLiveTranscriptionHelper

◆ getNetworkConnectionHelper

◆ getPhoneHelper

◆ getRealTimeMediaStreamsHelper

◆ getRecordingHelper

◆ getSDKVersion

◆ getSessionInfo

◆ getShareHelper

◆ getShareSettingHelper

◆ getSubSessionHelper

◆ getUserHelper

◆ getVideoHelper

◆ getVideoSettingHelper

◆ initialize:

◆ isInSession

◆ joinSession:

◆ leaveSession:

◆ removeListener:

◆ sharedVideoSDK