Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKMeetingRecordController Class Reference

Controller to manage meeting recording features. More...

#include <ZoomSDKMeetingRecordController.h>

Inherits NSObject.

Instance Methods

(ZoomSDKError- canStartRecording:
 Determines if the current user is enabled to start recording.
(ZoomSDKError- canAllowDisallowRecording
 Determines if the current user owns the authority to change the recording permission of the others.
(ZoomSDKError- startCloudRecording:
 Starts cloud recording.
(ZoomSDKError- startRecording:
 Starts recording on the local computer.
(ZoomSDKError- stopRecording:
 Stops recording on the local computer.
(ZoomSDKError- isSupportLocalRecording:
 Determines if the user owns the authority to enable the local recording.
(ZoomSDKError- allowLocalRecording:User:
 Give the specified user authority for local recording.
(ZoomSDKError- requestCustomizedLocalRecordingNotification:
 Sets whether to enable custom local recording notification.
(ZoomSDKError- pauseCloudRecording
 Pause cloud recording.
(ZoomSDKError- resumeCloudRecording
 Resume cloud recording.
(ZoomSDKError- pauseLocalRecording
 Pause local recording.
(ZoomSDKError- resumeLocalRecording
 Resume local recording.
(ZoomSDKError- startRawRecording
 Starts rawdata recording.
(ZoomSDKError- stopRawRecording
 Stops rawdata recording.
(ZoomSDKError- canStartRawRecording
 Determines if the specified user is enabled to start raw recording.
(ZoomSDKRecordingStatus- getCloudRecordingStatus
 Gets current cloud recording status.
(ZoomSDKError- isSupportRequestLocalRecordingPrivilege
 Determines if the user owns the authority to enable the local recording.
(ZoomSDKError- requestStartCloudRecording
 Sends a request to ask the host to start cloud recording.
(ZoomSDKError- requestLocalRecordingPrivilege
 Sends a request to enable the SDK to start local recording.
(BOOL) - isSmartRecordingEnabled
 Determines if the smart recording feature is enabled in the meeting.
(BOOL) - canEnableSmartRecordingFeature
 Whether the current user can enable the smart recording feature.
(ZoomSDKError- enableSmartRecording
 Enables the smart recording feature.

Protected Attributes

id< ZoomSDKMeetingRecordDelegate_delegate

Properties

id< ZoomSDKMeetingRecordDelegatedelegate
 Delegate to receive recording events.

Detailed Description

Controller to manage meeting recording features.

Definition at line 316 of file ZoomSDKMeetingRecordController.h.

Method Documentation

◆ allowLocalRecording:User:

- (ZoomSDKError) allowLocalRecording: (BOOL) allow
User: (unsigned int) userid 

Give the specified user authority for local recording.

Parameters
allowYES if allowing user to record on the local computer, NO otherwise.
useridSpecify the user ID.
Returns
If the specified user is enabled to start local recording, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ canAllowDisallowRecording

- (ZoomSDKError) canAllowDisallowRecording

Determines if the current user owns the authority to change the recording permission of the others.

Returns
If the user own the authority, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

References canAllowDisallowRecording.

Referenced by canAllowDisallowRecording.

◆ canEnableSmartRecordingFeature

- (BOOL) canEnableSmartRecordingFeature

Whether the current user can enable the smart recording feature.

Returns
YES if the current user can enable the smart recording feature. Otherwise, NO.

References canEnableSmartRecordingFeature.

Referenced by canEnableSmartRecordingFeature.

◆ canStartRawRecording

- (ZoomSDKError) canStartRawRecording

Determines if the specified user is enabled to start raw recording.

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

References canStartRawRecording.

Referenced by canStartRawRecording.

◆ canStartRecording:

- (ZoomSDKError) canStartRecording: (BOOL) isCloud

Determines if the current user is enabled to start recording.

Parameters
isCloudYES to determine whether to enable the cloud recording, NO local recording.
Returns
If the value of cloud_recording is set to YES and the cloud recording is enabled, it returns ZoomSDKError_Success. If the value of cloud_recording is set to NO and the local recording is enabled, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ enableSmartRecording

- (ZoomSDKError) enableSmartRecording

Enables the smart recording feature.

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

References enableSmartRecording.

Referenced by enableSmartRecording.

◆ getCloudRecordingStatus

- (ZoomSDKRecordingStatus) getCloudRecordingStatus

Gets current cloud recording status.

Returns
The recording status.

References getCloudRecordingStatus.

Referenced by getCloudRecordingStatus.

◆ isSmartRecordingEnabled

- (BOOL) isSmartRecordingEnabled

Determines if the smart recording feature is enabled in the meeting.

Returns
YES if the feature enabled. Otherwise, NO.

References isSmartRecordingEnabled.

Referenced by isSmartRecordingEnabled.

◆ isSupportLocalRecording:

- (ZoomSDKError) isSupportLocalRecording: (unsigned int) userid

Determines if the user owns the authority to enable the local recording.

Parameters
useridSpecify the user ID.
Returns
If the specified user is enabled to start local recording, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ isSupportRequestLocalRecordingPrivilege

- (ZoomSDKError) isSupportRequestLocalRecordingPrivilege

Determines if the user owns the authority to enable the local recording.

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

References isSupportRequestLocalRecordingPrivilege.

Referenced by isSupportRequestLocalRecordingPrivilege.

◆ pauseCloudRecording

- (ZoomSDKError) pauseCloudRecording

Pause cloud recording.

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

References pauseCloudRecording.

Referenced by pauseCloudRecording.

◆ pauseLocalRecording

- (ZoomSDKError) pauseLocalRecording

Pause local recording.

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

References pauseLocalRecording.

Referenced by pauseLocalRecording.

◆ requestCustomizedLocalRecordingNotification:

- (ZoomSDKError) requestCustomizedLocalRecordingNotification: (BOOL) request

Sets whether to enable custom local recording notification.

Parameters
requestYES to receive callback of onCustomizedRecordingSourceReceived, NO otherwise.
Returns
If the specified user is enabled to start local recording, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ requestLocalRecordingPrivilege

- (ZoomSDKError) requestLocalRecordingPrivilege

Sends a request to enable the SDK to start local recording.

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

References requestLocalRecordingPrivilege.

Referenced by requestLocalRecordingPrivilege.

◆ requestStartCloudRecording

- (ZoomSDKError) requestStartCloudRecording

Sends a request to ask the host to start cloud recording.

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

References requestStartCloudRecording.

Referenced by requestStartCloudRecording.

◆ resumeCloudRecording

- (ZoomSDKError) resumeCloudRecording

Resume cloud recording.

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

References resumeCloudRecording.

Referenced by resumeCloudRecording.

◆ resumeLocalRecording

- (ZoomSDKError) resumeLocalRecording

Resume local recording.

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

References resumeLocalRecording.

Referenced by resumeLocalRecording.

◆ startCloudRecording:

- (ZoomSDKError) startCloudRecording: (BOOL) start

Starts cloud recording.

Parameters
startSet it to YES to start cloud recording, NO to stop recording.
Returns
If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ startRawRecording

- (ZoomSDKError) startRawRecording

Starts rawdata recording.

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

References startRawRecording.

Referenced by startRawRecording.

◆ startRecording:

- (ZoomSDKError) startRecording: (time_t *) startTimestamp

Starts recording on the local computer.

Parameters
startTimestampThe timestamps when start recording.
Returns
If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ stopRawRecording

- (ZoomSDKError) stopRawRecording

Stops rawdata recording.

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

References stopRawRecording.

Referenced by stopRawRecording.

◆ stopRecording:

- (ZoomSDKError) stopRecording: (time_t *) stopTimestamp

Stops recording on the local computer.

Parameters
stopTimestampThe timestamps when stop recording.
Returns
If the function succeeds, it returns SDKErr_Success. Otherwise, this function returns an error.

Field Documentation

◆ _delegate

- (id<ZoomSDKMeetingRecordDelegate>) _delegate
protected

Definition at line 318 of file ZoomSDKMeetingRecordController.h.

Property Documentation

◆ delegate

- (id<ZoomSDKMeetingRecordDelegate>) delegate
readwritenonatomicassign

Delegate to receive recording events.

Definition at line 323 of file ZoomSDKMeetingRecordController.h.