Package us.zoom.sdk

Interface ZoomVideoSDKRecordingHelper

public interface ZoomVideoSDKRecordingHelper

Helper class for using cloud recording in the session. SeeZoomVideoSDK.getRecordingHelper()

Method Summary

Modifier and Type	Method	Description
int	canStartRecording()	Checks if the current user meets the requirements to start cloud recording.
ZoomVideoSDKRecordingStatus	getCloudRecordingStatus()	Get the current status of cloud recording.
int	pauseCloudRecording()	Pause the ongoing cloud recording.
int	resumeCloudRecording()	Resume the previously paused cloud recording.
int	startCloudRecording()	Start cloud recording.
int	stopCloudRecording()	Stop cloud recording.

Method Details

canStartRecording

int canStartRecording()

Checks if the current user meets the requirements to start cloud recording. The following are the prerequisites to use the helper class:

• A cloud recording add-on plan
• Cloud recording feature enabled on the Web portal

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

startCloudRecording

int startCloudRecording()

Start cloud recording. Since cloud recording involves asynchronous operations, a return value of Errors_Success does not guarantee that the recording will start. See ZoomVideoSDKDelegate.onCloudRecordingStatus(us.zoom.sdk.ZoomVideoSDKRecordingStatus, us.zoom.sdk.ZoomVideoSDKRecordingConsentHandler) for information on how to confirm that recording has commenced.

Returns:

Errors_Success if the start cloud recording request was successful. Otherwise, the start cloud recording request failed. See error codes defined in ZoomVideoSDKErrors.

stopCloudRecording

int stopCloudRecording()

Stop cloud recording. Since cloud recording involves asynchronous operations, a return value of Errors_Success does not guarantee that the recording will stop. See ZoomVideoSDKDelegate.onCloudRecordingStatus(us.zoom.sdk.ZoomVideoSDKRecordingStatus, us.zoom.sdk.ZoomVideoSDKRecordingConsentHandler) for information on how to confirm that recording has ended.

Returns:

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

pauseCloudRecording

int pauseCloudRecording()

Pause the ongoing cloud recording. Since cloud recording involves asynchronous operations, a return value of Errors_Success does not guarantee that the recording will pause. See ZoomVideoSDKDelegate.onCloudRecordingStatus(us.zoom.sdk.ZoomVideoSDKRecordingStatus, us.zoom.sdk.ZoomVideoSDKRecordingConsentHandler) for information on how to confirm that recording has paused.

Returns:

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

resumeCloudRecording

int resumeCloudRecording()

Resume the previously paused cloud recording. Since cloud recording involves asynchronous operations, a return value of Errors_Success does not guarantee that the recording will resume. See ZoomVideoSDKDelegate.onCloudRecordingStatus(us.zoom.sdk.ZoomVideoSDKRecordingStatus, us.zoom.sdk.ZoomVideoSDKRecordingConsentHandler) for information on how to confirm that recording has resumed.

Returns:

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

getCloudRecordingStatus

ZoomVideoSDKRecordingStatus getCloudRecordingStatus()

Get the current status of cloud recording.

Returns:

cloud recording status value defined in ZoomVideoSDKRecordingStatus.