Video SDK for iOS API Reference
Loading...
Searching...
No Matches
ZoomVideoSDKRecordingHelper Class Reference

Class for using cloud recording in the session. More...

#include <ZoomVideoSDKRecordingHelper.h>

Inherits NSObject.

Instance Methods

(ZoomVideoSDKError- canStartRecording
 Checks if the current user meets the requirements to start cloud recording.
 
(ZoomVideoSDKError- startCloudRecording
 Starts cloud recording.
 
(ZoomVideoSDKError- stopCloudRecording
 Stops cloud recording.
 
(ZoomVideoSDKError- pauseCloudRecording
 Pauses the ongoing cloud recording.
 
(ZoomVideoSDKError- resumeCloudRecording
 Resumes the previously paused cloud recording.
 
(ZoomVideoSDKRecordingStatus- getCloudRecordingStatus
 Gets the current status of cloud recording.
 

Detailed Description

Class for using cloud recording in the session.

Definition at line 35 of file ZoomVideoSDKRecordingHelper.h.

Method Documentation

◆ canStartRecording

- (ZoomVideoSDKError) canStartRecording

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

Returns
If the function succeeds, it returns Errors_Success. Otherwise, this function returns an error.
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

Gets the current status of cloud recording.

Returns
Cloud recording status value defined in [ZoomVideoSDKRecordingStatus].

◆ pauseCloudRecording

- (ZoomVideoSDKError) pauseCloudRecording

Pauses the ongoing cloud recording.

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

◆ resumeCloudRecording

- (ZoomVideoSDKError) resumeCloudRecording

Resumes the previously paused cloud recording.

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

◆ startCloudRecording

- (ZoomVideoSDKError) startCloudRecording

Starts cloud recording.

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

◆ stopCloudRecording

- (ZoomVideoSDKError) stopCloudRecording

Stops cloud recording.

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