ZoomVideoSDKRecordingHelper Class Reference

Class for using cloud recording in the session. See[ZoomVideoSDK.h#getRecordingHelper]. More...

#include <ZoomVideoSDKRecordingHelper.h>

Inherits NSObject.

Instance Methods
(ZoomVideoSDKError)	- canStartRecording
	Checks if the current user meets the requirements to start cloud recording.
(ZoomVideoSDKError)	- startCloudRecording
	Start cloud recording.
(ZoomVideoSDKError)	- stopCloudRecording
	Stop cloud recording.
(ZoomVideoSDKError)	- pauseCloudRecording
	Pause the ongoing cloud recording.
(ZoomVideoSDKError)	- resumeCloudRecording
	Resume the previously paused cloud recording.
(ZoomVideoSDKRecordingStatus)	- getCloudRecordingStatus
	Get the current status of cloud recording.

Detailed Description

Class for using cloud recording in the session. See[ZoomVideoSDK.h#getRecordingHelper].

Definition at line 33 of file ZoomVideoSDKRecordingHelper.h.

Method Documentation

canStartRecording

- (ZoomVideoSDKError) canStartRecording

Checks if the current user meets the requirements to start cloud recording.

Returns

Errors_Success if the current user meets the requirements to start cloud recording. Otherwise, the current user does not meeting the requirements to start recording. See error codes defined in [ZoomVideoSDKError].

Note

The following are the prerequisites to use the helper class: A cloud recording add-on plan. Cloud recording feature enabled on the Web portal.

getCloudRecordingStatus

- (ZoomVideoSDKRecordingStatus) getCloudRecordingStatus

Get the current status of cloud recording.

Returns

cloud recording status value defined in [ZoomVideoSDKRecordingStatus].

pauseCloudRecording

- (ZoomVideoSDKError) pauseCloudRecording

Pause the ongoing cloud recording.

Returns

Errors_Success if the pause cloud recording request was successful. Otherwise, the pause cloud recording request failed. See error codes defined in [ZoomVideoSDKError].

resumeCloudRecording

- (ZoomVideoSDKError) resumeCloudRecording

Resume the previously paused cloud recording.

Returns

Errors_Success if the resume cloud recording request was successful. Otherwise, the resume cloud recording request failed. See error codes defined in [ZoomVideoSDKError].

startCloudRecording

- (ZoomVideoSDKError) startCloudRecording

Start cloud recording.

Returns

Errors_Successif the start cloud recording request was successful. Otherwise, the start cloud recording request failed. See error codes defined in [ZoomVideoSDKError].

stopCloudRecording

- (ZoomVideoSDKError) stopCloudRecording

Stop cloud recording.

Returns

Errors_Success if the stop cloud recording request was successful. Otherwise, the stop cloud recording request failed. See error codes defined in [ZoomVideoSDKError].