Zoom Rooms Controller SDK Reference 6.5.0
Loading...
Searching...
No Matches
IRecordingHelperSink Class Referenceabstract

Meeting Recording helper event callback. More...

#include <IRecordingHelper.h>

Public Member Functions

virtual ~IRecordingHelperSink ()
 
virtual void OnUpdateMeetingRecordingInfo (const MeetingRecordingInfo &recordingInfo)=0
 Meeting recording info update notification.
 
virtual void OnMeetingCloudRecordingErrorNotification (bool show, MeetingRecordingError errorCode, bool hasCMREdit, uint64_t gracePeriodDate)=0
 Meeting cloud recording error notification.
 
virtual void OnMeetingCloudRecordingErrorNotification (bool result, const std::string &reason)=0
 Request to recording error notification.
 
virtual void OnNeedPromptStartRecordingDisclaimerUpdate (bool need)=0
 Need prompt start recording disclaimer update notification.
 
virtual void OnQueryMeetingCloudRecordingNotification (MeetingRecordingError errorCode, bool hasCMREdit)=0
 Query meeting cloud recording result notification.
 
virtual void OnUpdateMeetingUserRecordingStatus (int32_t userID, bool canRecord, bool isRecording, bool isLocalRecordingDisabled)=0
 Meeting user recording status update notification.
 
virtual void OnSetRecordingNotificationEmailNotification (int32_t result)=0
 Set recording notification email notification.
 
virtual void OnSetMeetingRecordingResult (int32_t result, const std::string &recordingNotificationEmail, RecordingRequestType type)=0
 Request recording action response.
 
virtual void OnUpdateRecordingPermission (const std::vector< RecordPermissionInfo > &info)=0
 Recording permission changed notification.
 
virtual void OnReceiveRecordingRequest (const RecordingRequestInfo &info)=0
 Participants request to start cloud recording or local recording notification.
 

Detailed Description

Meeting Recording helper event callback.

Definition at line 94 of file IRecordingHelper.h.

Constructor & Destructor Documentation

◆ ~IRecordingHelperSink()

virtual IRecordingHelperSink::~IRecordingHelperSink ( )
inlinevirtual

Definition at line 97 of file IRecordingHelper.h.

97{}

Member Function Documentation

◆ OnMeetingCloudRecordingErrorNotification() [1/2]

virtual void IRecordingHelperSink::OnMeetingCloudRecordingErrorNotification ( bool  result,
const std::string &  reason 
)
pure virtual

Request to recording error notification.

Since
6.3.5
Zoom Rooms minimum version
6.3.0
Parameters
resultTRUE indicates success.
reasonThe detail reason, success if empty string.

◆ OnMeetingCloudRecordingErrorNotification() [2/2]

virtual void IRecordingHelperSink::OnMeetingCloudRecordingErrorNotification ( bool  show,
MeetingRecordingError  errorCode,
bool  hasCMREdit,
uint64_t  gracePeriodDate 
)
pure virtual

Meeting cloud recording error notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
showTRUE indicates to show the error.
errorCodeError code, see MeetingRecordingError enum.
hasCMREditTRUE indicates account is a admin role.
gracePeriodDateGrace period date, format in "MMM d, yyyy".

◆ OnNeedPromptStartRecordingDisclaimerUpdate()

virtual void IRecordingHelperSink::OnNeedPromptStartRecordingDisclaimerUpdate ( bool  need)
pure virtual

Need prompt start recording disclaimer update notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
needTRUE indicates you need to PromptStartRecordingDisclaimer() before starting recording.

◆ OnQueryMeetingCloudRecordingNotification()

virtual void IRecordingHelperSink::OnQueryMeetingCloudRecordingNotification ( MeetingRecordingError  errorCode,
bool  hasCMREdit 
)
pure virtual

Query meeting cloud recording result notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
errorCodeError code, see MeetingRecordingError enum.
hasCMREditTRUE indicates account is a admin role.

◆ OnReceiveRecordingRequest()

virtual void IRecordingHelperSink::OnReceiveRecordingRequest ( const RecordingRequestInfo info)
pure virtual

Participants request to start cloud recording or local recording notification.

Since
6.3.5
Zoom Rooms minimum version
6.3.0
Parameters
infoDetail request info.

◆ OnSetMeetingRecordingResult()

virtual void IRecordingHelperSink::OnSetMeetingRecordingResult ( int32_t  result,
const std::string &  recordingNotificationEmail,
RecordingRequestType  type 
)
pure virtual

Request recording action response.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
result[0] success done the request type.
recordingNotificationEmailThe set email, success if not empty string.
typeThe requested type, see RecordingRequestType enum.

◆ OnSetRecordingNotificationEmailNotification()

virtual void IRecordingHelperSink::OnSetRecordingNotificationEmailNotification ( int32_t  result)
pure virtual

Set recording notification email notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
result[0] success. Otherwise fail.

◆ OnUpdateMeetingRecordingInfo()

virtual void IRecordingHelperSink::OnUpdateMeetingRecordingInfo ( const MeetingRecordingInfo recordingInfo)
pure virtual

Meeting recording info update notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
recordingInfoThe current meeting recording info.

◆ OnUpdateMeetingUserRecordingStatus()

virtual void IRecordingHelperSink::OnUpdateMeetingUserRecordingStatus ( int32_t  userID,
bool  canRecord,
bool  isRecording,
bool  isLocalRecordingDisabled 
)
pure virtual

Meeting user recording status update notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
userIDUser ID.
canRecordTRUE indicates the user can start recording.
isRecordingTRUE indicates the user is recording.
isLocalRecordingDisabledTRUE indicates the user is disabled from local recording.

◆ OnUpdateRecordingPermission()

virtual void IRecordingHelperSink::OnUpdateRecordingPermission ( const std::vector< RecordPermissionInfo > &  info)
pure virtual

Recording permission changed notification.

Since
6.3.5
Zoom Rooms minimum version
6.3.0
Parameters
infoDetail permission info