Zoom Rooms Controller SDK Reference 6.5.0
Loading...
Searching...
No Matches
IRecordingHelper.h File Reference

Meeting Recording interfaces. More...

#include "ZRCSDKTypes.h"

Go to the source code of this file.

Data Structures

struct  MeetingRecordingInfo
 Meeting recording information. More...
 
struct  RecordingRequestInfo
 Meeting recording request info. More...
 
struct  RecordPermissionInfo
 RecordPermissionInfo. More...
 
class  IRecordingHelperSink
 Meeting Recording helper event callback. More...
 
class  IRecordingHelper
 Meeting Recording helper interface. More...
 

Enumerations

enum  MeetingRecordingError { MeetingRecordingErrorSuccess = 0 , MeetingRecordingErrorUnknown = 1 , MeetingRecordingErrorStorageFull = 2 , MeetingRecordingErrorKMSKeyNotReady = 3 }
 Recording error code. Here are more detailed structural descriptions. More...
 
enum  RecordingRequestType {
  RecordingRequestTypeUnknown = -1 , RecordingRequestTypeStart = 0 , RecordingRequestTypeStop = 1 , RecordingRequestTypePause = 2 ,
  RecordingRequestTypeResume = 3
}
 Recording request type. Here are more detailed structural descriptions. More...
 
enum  RecordingPermissionType { RecordingPermissionTypeUnknown = -1 , RecordingPermissionTypeLocalRecording = 0 , RecordingPermissionTypeRequestLocalRecording = 1 , RecordingPermissionTypeRequestCloudRecording = 2 }
 Recording Permission Type Here are more detailed structural descriptions. More...
 
enum  RecordingType { RecordingTypeUnknown = -1 , RecordingTypeLocal = 0 , RecordingTypeCloud = 1 }
 Recording Type Here are more detailed structural descriptions. More...
 

Detailed Description

Meeting Recording interfaces.

Since
Added in ZRC SDK 6.0.0

Definition in file IRecordingHelper.h.

Enumeration Type Documentation

◆ MeetingRecordingError

Recording error code. Here are more detailed structural descriptions.

Enumerator
MeetingRecordingErrorSuccess 

Success.

MeetingRecordingErrorUnknown 

Unclassified error reason.

MeetingRecordingErrorStorageFull 

Cloud storage is full.

MeetingRecordingErrorKMSKeyNotReady 

Encryption key is not ready.

Definition at line 17 of file IRecordingHelper.h.

18{
23};
@ MeetingRecordingErrorStorageFull
Cloud storage is full.
@ MeetingRecordingErrorUnknown
Unclassified error reason.
@ MeetingRecordingErrorSuccess
Success.
@ MeetingRecordingErrorKMSKeyNotReady
Encryption key is not ready.

◆ RecordingPermissionType

Recording Permission Type Here are more detailed structural descriptions.

Enumerator
RecordingPermissionTypeUnknown 

Init.

RecordingPermissionTypeLocalRecording 

Participant record to computer.

RecordingPermissionTypeRequestLocalRecording 

Request to record to computer.

RecordingPermissionTypeRequestCloudRecording 

Request host to start cloud recording.

Definition at line 42 of file IRecordingHelper.h.

43{
48};
@ RecordingPermissionTypeUnknown
Init.
@ RecordingPermissionTypeLocalRecording
Participant record to computer.
@ RecordingPermissionTypeRequestLocalRecording
Request to record to computer.
@ RecordingPermissionTypeRequestCloudRecording
Request host to start cloud recording.

◆ RecordingRequestType

Recording request type. Here are more detailed structural descriptions.

Enumerator
RecordingRequestTypeUnknown 

Init.

RecordingRequestTypeStart 

Start recording.

RecordingRequestTypeStop 

Stop recording.

RecordingRequestTypePause 

Pause recording.

RecordingRequestTypeResume 

Resume recording.

Definition at line 29 of file IRecordingHelper.h.

30{
36};
@ RecordingRequestTypeUnknown
Init.
@ RecordingRequestTypeStop
Stop recording.
@ RecordingRequestTypeStart
Start recording.
@ RecordingRequestTypeResume
Resume recording.
@ RecordingRequestTypePause
Pause recording.

◆ RecordingType

Recording Type Here are more detailed structural descriptions.

Enumerator
RecordingTypeUnknown 

Init.

RecordingTypeLocal 

Local recording.

RecordingTypeCloud 

Cloud recording.

Definition at line 54 of file IRecordingHelper.h.

55{
59};
@ RecordingTypeLocal
Local recording.
@ RecordingTypeUnknown
Init.
@ RecordingTypeCloud
Cloud recording.