IRecordingHelper.h

Go to the documentation of this file.

 
#ifndef ZRC_IRECORDINGHELPER_H
#define ZRC_IRECORDINGHELPER_H
 
#include "ZRCSDKTypes.h"
 
NS_ZRCSDK_BEG
 
enum MeetingRecordingError
{
    MeetingRecordingErrorSuccess = 0,          
    MeetingRecordingErrorUnknown = 1,          
    MeetingRecordingErrorStorageFull = 2,      
    MeetingRecordingErrorKMSKeyNotReady = 3    
};
 
enum RecordingRequestType
{
    RecordingRequestTypeUnknown = -1,    
    RecordingRequestTypeStart = 0,       
    RecordingRequestTypeStop = 1,        
    RecordingRequestTypePause = 2,       
    RecordingRequestTypeResume = 3       
};
 
enum RecordingPermissionType
{
    RecordingPermissionTypeUnknown = -1,                 
    RecordingPermissionTypeLocalRecording = 0,           
    RecordingPermissionTypeRequestLocalRecording = 1,    
    RecordingPermissionTypeRequestCloudRecording = 2,    
};
 
enum RecordingType
{
    RecordingTypeUnknown = -1,    
    RecordingTypeLocal = 0,       
    RecordingTypeCloud = 1,       
};
 
struct MeetingRecordingInfo
{
    bool isMeetingBeingRecorded = false;    
    bool canIRecord = false;                
    bool amIRecording = false;              
    bool isConnectingToCMR = false;         
    bool isCMRPaused = false;               
    bool isCMRInProgress = false;           
    bool isRecordingOnCloud = false;        
    bool hasLocalRecording = false;         
};
 
struct RecordingRequestInfo
{
    RecordingType recordingType = RecordingTypeUnknown;    
    std::string   senderName;                              
};
 
struct RecordPermissionInfo
{
    RecordingPermissionType type = RecordingPermissionTypeUnknown;    
    bool                    isEnable = false;                         
    bool                    isLocked = false;                         
};
 
class IRecordingHelperSink
{
public:
    virtual ~IRecordingHelperSink() {}
 
    virtual void OnUpdateMeetingRecordingInfo(const MeetingRecordingInfo& recordingInfo) = 0;
 
    virtual void OnMeetingCloudRecordingErrorNotification(bool show, MeetingRecordingError errorCode, bool hasCMREdit, uint64_t gracePeriodDate) = 0;
 
    virtual void OnMeetingCloudRecordingErrorNotification(bool result, const std::string& reason) = 0;
 
    virtual void OnNeedPromptStartRecordingDisclaimerUpdate(bool need) = 0;
 
    virtual void OnQueryMeetingCloudRecordingNotification(MeetingRecordingError errorCode, bool hasCMREdit) = 0;
 
    virtual void OnUpdateMeetingUserRecordingStatus(int32_t userID, bool canRecord, bool isRecording, bool isLocalRecordingDisabled) = 0;
 
    virtual void OnSetRecordingNotificationEmailNotification(int32_t result) = 0;
 
    virtual void OnSetMeetingRecordingResult(int32_t result, const std::string& recordingNotificationEmail, RecordingRequestType type) = 0;
 
    virtual void OnUpdateRecordingPermission(const std::vector<RecordPermissionInfo>& info) = 0;
 
    virtual void OnReceiveRecordingRequest(const RecordingRequestInfo& info) = 0;
};
 
class IRecordingHelper
{
public:
    virtual ~IRecordingHelper() {}
 
    virtual ZRCSDKError RegisterSink(IRecordingHelperSink* pSink) = 0;
 
    virtual ZRCSDKError DeregisterSink(IRecordingHelperSink* pSink) = 0;
 
    virtual ZRCSDKError ConfirmRecordingError() = 0;
 
    virtual ZRCSDKError IsNeedPromptStartRecordingDisclaimer(bool& need) = 0;
 
    virtual ZRCSDKError PromptStartRecordingDisclaimer() = 0;
 
    virtual ZRCSDKError IsMeetingCMRNoStorage(bool& full) = 0;
 
    virtual ZRCSDKError QueryMeetingRecordingStorage() = 0;
 
    virtual ZRCSDKError SetMeetingRecordingNotificationEmail(const std::string& email) = 0;
 
    virtual ZRCSDKError StartMeetingCloudRecording() = 0;
 
    virtual ZRCSDKError StopMeetingCloudRecording() = 0;
 
    virtual ZRCSDKError PauseMeetingCloudRecording() = 0;
 
    virtual ZRCSDKError ResumeMeetingCloudRecording() = 0;
 
    virtual ZRCSDKError AllowUserRecording(int32_t userID, bool allow) = 0;
 
    virtual ZRCSDKError ResponseToRecordingRequest(bool agree, bool isPersist) = 0;
 
    virtual ZRCSDKError ChangeRecordingPermission(RecordingPermissionType type, bool enable) = 0;
 
    virtual ZRCSDKError GetRecoringPemissionInfo(std::vector<RecordPermissionInfo>& permissionInfo) = 0;
};
 
NS_ZRCSDK_END
#endif    //ZRC_IRECORDINGHELPER_H