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

#import <ZoomSDKMeetingRecordController.h>

Inherits NSObject.

Instance Methods

(ZoomSDKError- canStartRecording:
 Determine if the current user is enabled to start recording.
 
(ZoomSDKError- canAllowDisallowRecording
 Determine if the current user owns the authority to change the recording permission of the others.
 
(ZoomSDKError- startCloudRecording:
 Start cloud recording.
 
(ZoomSDKError- startRecording:
 Start recording on the local computer.
 
(ZoomSDKError- stopRecording:
 Stop recording on the local computer.
 
(ZoomSDKError- isSupportLocalRecording:
 Determine if the user owns the authority to enable the local recording.
 
(ZoomSDKError- allowLocalRecording:User:
 Give the specified user authority for local recording.
 
(ZoomSDKError- requestCustomizedLocalRecordingNotification:
 Set 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
 Start rawdata recording.
 
(ZoomSDKError- stopRawRecording
 Stop rawdata recording.
 
(ZoomSDKError- canStartRawRecording
 Determine if the specified user is enabled to start raw recording.
 
(ZoomSDKRecordingStatus- getCloudRecordingStatus
 Get current cloud recording status.
 
(ZoomSDKError- isSupportRequestLocalRecordingPrivilege
 Determine if the user owns the authority to enable the local recording.
 
(ZoomSDKError- requestStartCloudRecording
 Send a request to ask the host to start cloud recording.
 
(ZoomSDKError- requestLocalRecordingPrivilege
 Send a request to enable the SDK to start local recording.
 
(BOOL) - isSmartRecordingEnabled
 Determine if the smart recording feature is enabled in the meeting.
 
(BOOL) - canEnableSmartRecordingFeature
 Whether the current user can enable the smart recording feature.
 
(ZoomSDKError- enableSmartRecording
 Enable the smart recording feature.
 

Protected Attributes

id< ZoomSDKMeetingRecordDelegate_delegate
 

Properties

id< ZoomSDKMeetingRecordDelegatedelegate
 

Detailed Description

Definition at line 210 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 means allowing user to record on the local computer, otherwise not.
useridSpecify the user ID.
Returns
If the specified user is enabled to start local recording, the return value is ZoomSDKError_Success. Otherwise failed.

◆ canAllowDisallowRecording

- (ZoomSDKError) canAllowDisallowRecording

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

Returns
If the user own the authority, the return value is ZoomSDKError_Success. Otherwise failed.

◆ canEnableSmartRecordingFeature

- (BOOL) canEnableSmartRecordingFeature

Whether the current user can enable the smart recording feature.

Returns
YES means the current user can enable the smart recording feature.

◆ canStartRawRecording

- (ZoomSDKError) canStartRawRecording

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

Returns
If the function succeeds, the return value is ZoomSDKError_Success. Otherwise the function failed.

◆ canStartRecording:

- (ZoomSDKError) canStartRecording: (BOOL)  isCloud

Determine if the current user is enabled to start recording.

Parameters
isCloudYES means to determine whether to enable the cloud recording. NO local recording.
Returns
If the value of cloud_recording is set to TRUE and the cloud recording is enabled, the return value is ZoomSDKError_Success. If the value of cloud_recording is set to FALSE and the local recording is enabled, the return value is ZoomSDKError_Success. Otherwise failed.

◆ enableSmartRecording

- (ZoomSDKError) enableSmartRecording

Enable the smart recording feature.

Returns
If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

◆ getCloudRecordingStatus

- (ZoomSDKRecordingStatus) getCloudRecordingStatus

Get current cloud recording status.

Returns
If the function succeeds, the return value is recording status.

◆ isSmartRecordingEnabled

- (BOOL) isSmartRecordingEnabled

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

Returns
YES means that the feature enabled, NO means that the feature isn't enabled.

◆ isSupportLocalRecording:

- (ZoomSDKError) isSupportLocalRecording: (unsigned int)  userid

Determine 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, the return value is ZoomSDKError_Success. Otherwise failed.

◆ isSupportRequestLocalRecordingPrivilege

- (ZoomSDKError) isSupportRequestLocalRecordingPrivilege

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

Returns
If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

◆ pauseCloudRecording

- (ZoomSDKError) pauseCloudRecording

Pause cloud recording.

Returns
If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

◆ pauseLocalRecording

- (ZoomSDKError) pauseLocalRecording

Pause local recording.

Returns
If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

◆ requestCustomizedLocalRecordingNotification:

- (ZoomSDKError) requestCustomizedLocalRecordingNotification: (BOOL)  request

Set whether to enable custom local recording notification.

Parameters
requestSet it to YES to receive callback of onCustomizedRecordingSourceReceived.
Returns
If the specified user is enabled to start local recording, the return value is ZoomSDKError_Success. Otherwise failed.

◆ requestLocalRecordingPrivilege

- (ZoomSDKError) requestLocalRecordingPrivilege

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

Returns
If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

◆ requestStartCloudRecording

- (ZoomSDKError) requestStartCloudRecording

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

Returns
If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

◆ resumeCloudRecording

- (ZoomSDKError) resumeCloudRecording

Resume cloud recording.

Returns
If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

◆ resumeLocalRecording

- (ZoomSDKError) resumeLocalRecording

Resume local recording.

Returns
If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

◆ startCloudRecording:

- (ZoomSDKError) startCloudRecording: (BOOL)  start

Start cloud recording.

Parameters
startSet it to YES to start cloud recording, NO to stop recording.
Returns
If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

◆ startRawRecording

- (ZoomSDKError) startRawRecording

Start rawdata recording.

Returns
If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

◆ startRecording:

- (ZoomSDKError) startRecording: (time_t *)  startTimestamp

Start recording on the local computer.

Parameters
startTimestampThe timestamps when start recording.
Returns
If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

◆ stopRawRecording

- (ZoomSDKError) stopRawRecording

Stop rawdata recording.

Returns
If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

◆ stopRecording:

- (ZoomSDKError) stopRecording: (time_t *)  stopTimestamp

Stop recording on the local computer.

Parameters
stopTimestampThe timestamps when stop recording.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

Field Documentation

◆ _delegate

- (id<ZoomSDKMeetingRecordDelegate>) _delegate
protected

Definition at line 212 of file ZoomSDKMeetingRecordController.h.

Property Documentation

◆ delegate

- (id<ZoomSDKMeetingRecordDelegate>) delegate
readwritenonatomicassign

Definition at line 214 of file ZoomSDKMeetingRecordController.h.