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:
	Initializes the Zoom Video SDK with the appropriate parameters.

(void)	- cleanUp
	Clean up Zoom Video SDK.

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

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

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

(ZMVideoSDKErrors)	- leaveSession:
	Leaves a session previously joined through joinSession method call. When successful, the SDK attempts 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
	Checks 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
	Gets video setting helper object.

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

(ZMVideoSDKCRCHelper *)	- getCRCHelper
	Gets crc helper object.

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

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

(ZMVideoSDKSubSessionHelper *_Nullable)	- getSubSessionHelper
	Gets 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

Registers 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 returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ cleanUp

- (void) cleanUp

Clean up Zoom Video SDK.

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

◆ getAudioDeviceTestHelper

- (ZMVideoSDKAudioDeviceTestHelper *) getAudioDeviceTestHelper

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

Returns: If the function succeeds, it returns a ZMVideoSDKAudioDeviceTestHelper instance. Otherwise, this function fails and 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 returns a ZMVideoSDKAudioHelper instance. Otherwise, this function fails and 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 returns a ZMVideoSDKAudioSettingHelper instance. Otherwise, this function fails and returns nil.

◆ getBroadcastStreamingController

- (ZMVideoSDKBroadcastStreamingController *_Nullable) getBroadcastStreamingController

Gets the broadcast streaming controller object.

Returns: The broadcast streaming controller object if available. Otherwise, this function fails and returns nil.

◆ getBroadcastStreamingViewer

- (ZMVideoSDKBroadcastStreamingViewer *_Nullable) getBroadcastStreamingViewer

Gets the broadcast streaming viewer object.

Returns: The broadcast streaming viewer object if available. Otherwise, this function fails and returns nil.

◆ getChatHelper

- (ZMVideoSDKChatHelper *) getChatHelper

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

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

◆ getCmdChannel

- (ZMVideoSDKCmdChannel *) getCmdChannel

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

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

◆ getCRCHelper

- (ZMVideoSDKCRCHelper *) getCRCHelper

Gets crc helper object.

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

◆ getIncomingLiveStreamHelper

- (ZMVideoSDKIncomingLiveStreamHelper *) getIncomingLiveStreamHelper

Gets incoming live stream helper object.

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

◆ getLiveStreamHelper

- (ZMVideoSDKLiveStreamHelper *) getLiveStreamHelper

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

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

◆ getLiveTranscriptionHelper

- (ZMVideoSDKLiveTranscriptionHelper *) getLiveTranscriptionHelper

Gets live transcription helper object.

Returns: If the function succeeds, it returns a ZMVideoSDKLiveTranscriptionHelper instance. Otherwise, this function fails and 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 returns a ZMVideoSDKNetworkConnectionHelper instance. Otherwise, this function fails and returns nil.

◆ getPhoneHelper

- (ZMVideoSDKPhoneHelper *) getPhoneHelper

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

Returns: If the function succeeds, it returns a ZMVideoSDKPhoneHelper instance. Otherwise, this function fails and 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 returns a ZMVideoSDKRTMSHelper instance. Otherwise, this function fails and returns nil.

◆ getRecordingHelper

- (ZMVideoSDKRecordingHelper *) getRecordingHelper

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

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

◆ getSDKVersion

- (NSString *_Nullable) getSDKVersion

Returns Zoom SDK internal version.

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

◆ getSessionInfo

- (ZMVideoSDKSession *) getSessionInfo

Returns the current session information.

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

◆ getShareHelper

- (ZMVideoSDKShareHelper *) getShareHelper

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

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

◆ getShareSettingHelper

- (ZMVideoSDKShareSettingHelper *) getShareSettingHelper

Gets share setting helper object.

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

◆ getSubSessionHelper

- (ZMVideoSDKSubSessionHelper *_Nullable) getSubSessionHelper

Gets the subsession helper object.

Returns: If the function succeeds, it returns a ZMVideoSDKSubSessionHelper instance. Otherwise, this function fails and 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 returns a ZMVideoSDKUserHelper instance. Otherwise, this function fails and returns nil.

◆ getVideoHelper

- (ZMVideoSDKVideoHelper *) getVideoHelper

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

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

◆ getVideoSettingHelper

- (ZMVideoSDKVideoSettingHelper *) getVideoSettingHelper

Gets video setting helper object.

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

◆ initialize:

- (ZMVideoSDKErrors) initialize: (ZMVideoSDKInitParams *) params

Initializes 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 returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ isInSession

- (BOOL) isInSession

Checks if there is an active session between participants.

Returns: YES if in session. Otherwise, NO.

◆ joinSession:

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

Joins a session with the appropriate ZMVideoSDKSessionContext parameters. When successful, the SDK attempts to join a session. Use the callbacks in the listener to confirm whether the SDK actually joined.

Parameters

params A session context object containing all parameters to join the session.

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

◆ leaveSession:

- (ZMVideoSDKErrors) leaveSession: (BOOL) end

Leaves a session previously joined through joinSession method call. When successful, the SDK attempts 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 returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ removeListener:

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

Unregisters 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: If the function succeeds, it returns ZMVideoSDK instance. Otherwise, this function fails and returns nil.

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