Meeting SDK for Windows API Reference
Loading...
Searching...
No Matches
meeting_recording_interface.h
Go to the documentation of this file.
1
6#ifndef _MEETING_Recording_INTERFACE_H_
7#define _MEETING_Recording_INTERFACE_H_
8#include "zoom_sdk_def.h"
9#include <time.h>
30
31#if defined(__linux__)
32enum TranscodingStatus
33{
34 Transcoding_Start,
35 Transcoding_Inprogress,
36 Transcoding_End,
37 Transcoding_Error_LowDiskSpace,
38 Transcoding_Error_UnknownSources,
39 Transcoding_Error_WrongFile,
40 Transcoding_Error_Unknown,
41};
42
43typedef enum
44{
45 REC_TYPE_VIDEO = 0,
46 REC_TYPE_SHARE,
47}LocalRecordingSubscribeType;
48
49typedef enum LocalRecordingResolution
50{
51 LocalRecordingResolution_90P = 0,
52 LocalRecordingResolution_180P,
53 LocalRecordingResolution_360P,
54 LocalRecordingResolution_720P,
55 LocalRecordingResolution_1080P,
56 LocalRecordingResolution_NoUse = 100
57}LocalRecordingResolution;
58#endif
59
73
86
102{
103public:
109 virtual const zchar_t* GetRequestId() = 0;
110
115 virtual unsigned int GetRequesterId() = 0;
116
121 virtual const zchar_t* GetRequesterName() = 0;
122
128
134};
135
143{
144public:
150 virtual unsigned int GetRequesterId() = 0;
151
156 virtual const zchar_t* GetRequesterName() = 0;
157
162 virtual SDKError Start() = 0;
163
169 virtual SDKError Deny(bool bDenyAll) = 0;
170};
171
177{
178public:
184 virtual unsigned int GetRequestUserId() = 0;
185
190 virtual const zchar_t* GetTipString() = 0;
191
197
203 virtual SDKError AgreeToEnableAndStart(bool bAllMeetings) = 0;
204
210 virtual SDKError Decline(bool bDenyAll) = 0;
211};
212
218{
219public:
225 virtual const zchar_t* GetTipString() = 0;
226
232 virtual SDKError ActionConfirm(bool bAllMeetings) = 0;
233
238 virtual SDKError ActionCancel() = 0;
239};
240
241#if defined(WIN32)
243#endif
249{
250public:
256 virtual void onRecordingStatus(RecordingStatus status) = 0;
257
262 virtual void onCloudRecordingStatus(RecordingStatus status) = 0;
263
268 virtual void onRecordPrivilegeChanged(bool bCanRec) = 0;
269
275
281
287
293
294#if defined(WIN32)
302 virtual void onRecording2MP4Done(bool bsuccess, int iResult, const zchar_t* szPath) = 0;
303
309 virtual void onRecording2MP4Processing(int iPercentage) = 0;
310
316 virtual void onCustomizedLocalRecordingSourceNotification(ICustomizedLocalRecordingLayoutHelper* layout_helper) = 0;
317
318#endif
323 virtual void onCloudRecordingStorageFull(time_t gracePeriodDate) = 0;
324
330
336#if defined(__linux__)
337 virtual void onTranscodingStatusChanged(TranscodingStatus status,const zchar_t* path) = 0;
338#endif
339};
340
346{
347public:
354
360
366
372
378 virtual SDKError StartRecording(time_t& startTimestamp) = 0;
379
385 virtual SDKError StopRecording(time_t& stopTimestamp) = 0;
386
394 virtual SDKError CanStartRecording(bool cloud_recording, unsigned int userid) = 0;
395
400 virtual bool IsSmartRecordingEnabled() = 0;
401
407
413
419
425
431
437 virtual SDKError IsSupportLocalRecording(unsigned int userid) = 0;
438
444 virtual SDKError AllowLocalRecording(unsigned int userid) = 0;
445
451 virtual SDKError DisAllowLocalRecording(unsigned int userid) = 0;
452
453#if defined(WIN32)
459 virtual SDKError RequestCustomizedLocalRecordingSource() = 0;
460
461#endif
467
473
479
485
486
492
498
504
510
511#if defined(__linux__)
512 virtual SDKError SubscribeLocalrecordingResource(unsigned int sourceId, LocalRecordingSubscribeType type,LocalRecordingResolution resolution) = 0;
513 virtual SDKError UnSubscribeLocalrecordingResource(unsigned int sourceId, LocalRecordingSubscribeType type) = 0;
514#endif
515};
517#endif
Meeting recording controller interface.
virtual SDKError IsSupportLocalRecording(unsigned int userid)=0
Determines if the user owns the authority to enable the local recording.
virtual bool IsSmartRecordingEnabled()=0
Determines if the smart recording feature is enabled in the meeting.
virtual SDKError EnableSmartRecording()=0
Enables the smart recording feature.
virtual SDKError StartRecording(time_t &startTimestamp)=0
Starts recording.
virtual SDKError PauseCloudRecording()=0
Pause cloud recording.
virtual SDKError CanStartRecording(bool cloud_recording, unsigned int userid)=0
Determines if the specified user is enabled to start recording.
virtual SDKError RequestStartCloudRecording()=0
Sends a request to ask the host to start cloud recording.
virtual SDKError StopRawRecording()=0
Stops rawdata recording.
virtual SDKError StopCloudRecording()=0
Stops cloud recording.
virtual RecordingStatus GetCloudRecordingStatus()=0
Gets current cloud recording.
virtual SDKError DisAllowLocalRecording(unsigned int userid)=0
Abrogate the authority of the specified user for local recoding.
virtual SDKError CanStartRawRecording()=0
Determines if the specified user is enabled to start raw recording.
virtual SDKError SetEvent(IMeetingRecordingCtrlEvent *pEvent)=0
Sets meeting recording callback event handler.
virtual SDKError StartCloudRecording()=0
Starts cloud recording.
virtual SDKError ResumeCloudRecording()=0
Resume cloud recording.
virtual SDKError AllowLocalRecording(unsigned int userid)=0
Give the specified user authority for local recording.
virtual SDKError CanAllowDisAllowLocalRecording()=0
Determines if the current user own the authority to change the recording permission of the others.
virtual bool CanEnableSmartRecordingFeature()=0
Whether the current user can enable the smart recording feature.
virtual SDKError PauseRecording()=0
Pause recording.
virtual SDKError RequestLocalRecordingPrivilege()=0
Sends a request to enable the SDK to start local recording.
virtual SDKError ResumeRecording()=0
Resume recording.
virtual SDKError IsSupportRequestLocalRecordingPrivilege()=0
Determines if the user owns the authority to enable the local recording.
virtual SDKError StopRecording(time_t &stopTimestamp)=0
Stops recording.
virtual SDKError StartRawRecording()=0
Starts rawdata recording.
Meeting recording callback event.
virtual void onRecordPrivilegeChanged(bool bCanRec)=0
Callback event that the recording authority changes.
virtual void onLocalRecordingPrivilegeRequestStatus(RequestLocalRecordingStatus status)=0
Callback event that the status of request local recording privilege.
virtual void onCloudRecordingStatus(RecordingStatus status)=0
Callback event that the status of cloud recording changes.
virtual void onSmartRecordingEnableActionCallback(ISmartRecordingEnableActionHandler *handler)=0
Callback event received when you call EnableSmartRecording . You can use the handler to confirm or ca...
virtual void onCloudRecordingStorageFull(time_t gracePeriodDate)=0
Callback event that the cloud recording storage is full.
virtual void onStartCloudRecordingRequested(IRequestStartCloudRecordingHandler *handler)=0
Callback event received only by the host when a user requests to start cloud recording.
virtual void onEnableAndStartSmartRecordingRequested(IRequestEnableAndStartSmartRecordingHandler *handler)=0
Callback event received only by the host when a user requests to enable and start smart cloud recordi...
virtual void onRecordingStatus(RecordingStatus status)=0
Callback event that the status of my local recording changes.
virtual void onLocalRecordingPrivilegeRequested(IRequestLocalRecordingPrivilegeHandler *handler)=0
Callback event when a user requests local recording privilege.
virtual void onRequestCloudRecordingResponse(RequestStartCloudRecordingStatus status)=0
Callback event for when the host responds to a cloud recording permission request.
Enables and start smart cloud recording request handler.
virtual SDKError StartCloudRecordingWithoutEnableSmartRecording()=0
Starts normal cloud recording without enabling smart recording.
virtual unsigned int GetRequestUserId()=0
Gets the user ID who requests to enable and start smart cloud recording.
virtual SDKError Decline(bool bDenyAll)=0
Decline the request to start cloud recording.
virtual const zchar_t * GetTipString()=0
Gets the legal tip that you should agree to handle the user request.
virtual SDKError AgreeToEnableAndStart(bool bAllMeetings)=0
Agrees to the legal notice to enable and start smart cloud recording.
Process after the host receives the requirement from the user to give the local recording privilege.
virtual const zchar_t * GetRequestId()=0
Gets the request ID.
virtual SDKError DenyLocalRecordingPrivilege()=0
Denies the user permission to start local recording and then destroys this instance.
virtual unsigned int GetRequesterId()=0
Gets the user ID who requested privilege.
virtual const zchar_t * GetRequesterName()=0
Gets the user name who requested privileges.
virtual SDKError GrantLocalRecordingPrivilege()=0
Grants the user permission to start local recording and then destroys this instance.
Object to handle a user's request to start cloud recording.
virtual const zchar_t * GetRequesterName()=0
Gets the user name who requested that the host start cloud recording.
virtual SDKError Start()=0
Accepts the request to start cloud recording and then destroys the IRequestCloudRecordingHandler inst...
virtual unsigned int GetRequesterId()=0
Gets the user ID who requested that the host start cloud recording.
virtual SDKError Deny(bool bDenyAll)=0
Denies the request to start cloud recording and then destroys the IRequestCloudRecordingHandler insta...
Enables and start smart recording.
virtual SDKError ActionCancel()=0
Cancel enabling and starting the smart recording.
virtual const zchar_t * GetTipString()=0
Gets the legal tip to enable smart recording.
virtual SDKError ActionConfirm(bool bAllMeetings)=0
Confirm enabling and starting the smart recording.
RecordingStatus
Enumeration of recording status. Here are more detailed structural descriptions.
RequestStartCloudRecordingStatus
Enumeration of request host to start cloud recording status.
@ RequestStartCloudRecording_Granted
@ RequestStartCloudRecording_Denied
@ RequestStartCloudRecording_TimedOut
RequestLocalRecordingStatus
Enumeration of request local recording privilege status. Here are more detailed structural descriptio...
@ RequestLocalRecording_Denied
@ RequestLocalRecording_Granted
@ RequestLocalRecording_Timeout
LocalRecordingRequestPrivilegeStatus
@ LocalRecordingRequestPrivilege_None
@ LocalRecordingRequestPrivilege_AllowRequest
@ LocalRecordingRequestPrivilege_AutoDeny
@ LocalRecordingRequestPrivilege_AutoGrant
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
#define BEGIN_ZOOM_SDK_NAMESPACE
char zchar_t
SDKError
Enumeration of common errors of SDK.