Meeting SDK for Linux 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
127
132};
133
141{
142public:
148 virtual unsigned int GetRequesterId() = 0;
149
154 virtual const zchar_t* GetRequesterName() = 0;
155
159 virtual SDKError Start() = 0;
160
165 virtual SDKError Deny(bool bDenyAll) = 0;
166};
167
173{
174public:
180 virtual unsigned int GetRequestUserId() = 0;
181
186 virtual const zchar_t* GetTipString() = 0;
187
193
199 virtual SDKError AgreeToEnableAndStart(bool bAllMeetings) = 0;
200
206 virtual SDKError Decline(bool bDenyAll) = 0;
207};
208
214{
215public:
221 virtual const zchar_t* GetTipString() = 0;
222
228 virtual SDKError ActionConfirm(bool bAllMeetings) = 0;
229
234 virtual SDKError ActionCancel() = 0;
235};
236
237#if defined(WIN32)
238class ICustomizedLocalRecordingLayoutHelper;
239#endif
245{
246public:
252 virtual void onRecordingStatus(RecordingStatus status) = 0;
253
258 virtual void onCloudRecordingStatus(RecordingStatus status) = 0;
259
264 virtual void onRecordPrivilegeChanged(bool bCanRec) = 0;
265
271
277
283
289
290#if defined(WIN32)
298 virtual void onRecording2MP4Done(bool bsuccess, int iResult, const zchar_t* szPath) = 0;
299
305 virtual void onRecording2MP4Processing(int iPercentage) = 0;
306
312 virtual void onCustomizedLocalRecordingSourceNotification(ICustomizedLocalRecordingLayoutHelper* layout_helper) = 0;
313
314#endif
319 virtual void onCloudRecordingStorageFull(time_t gracePeriodDate) = 0;
320
326
332#if defined(__linux__)
333 virtual void onTranscodingStatusChanged(TranscodingStatus status,const zchar_t* path) = 0;
334#endif
335};
336
342{
343public:
350
356
362
368
374 virtual SDKError StartRecording(time_t& startTimestamp) = 0;
375
381 virtual SDKError StopRecording(time_t& stopTimestamp) = 0;
382
391 virtual SDKError CanStartRecording(bool cloud_recording, unsigned int userid) = 0;
392
397 virtual bool IsSmartRecordingEnabled() = 0;
398
404
410
416
422
428
434 virtual SDKError IsSupportLocalRecording(unsigned int userid) = 0;
435
441 virtual SDKError AllowLocalRecording(unsigned int userid) = 0;
442
448 virtual SDKError DisAllowLocalRecording(unsigned int userid) = 0;
449
450#if defined(WIN32)
456 virtual SDKError RequestCustomizedLocalRecordingSource() = 0;
457
458#endif
464
470
476
482
483
489
495
501
507
508#if defined(__linux__)
509 virtual SDKError SubscribeLocalrecordingResource(unsigned int sourceId, LocalRecordingSubscribeType type,LocalRecordingResolution resolution) = 0;
510 virtual SDKError UnSubscribeLocalrecordingResource(unsigned int sourceId, LocalRecordingSubscribeType type) = 0;
511#endif
512};
514#endif
Meeting recording controller interface.
virtual SDKError IsSupportLocalRecording(unsigned int userid)=0
Determine if the user owns the authority to enable the local recording.
virtual bool IsSmartRecordingEnabled()=0
Determine if the smart recording feature is enabled in the meeting.
virtual SDKError EnableSmartRecording()=0
Enable the smart recording feature.
virtual SDKError StartRecording(time_t &startTimestamp)=0
Start recording.
virtual SDKError PauseCloudRecording()=0
Pause cloud recording.
virtual SDKError CanStartRecording(bool cloud_recording, unsigned int userid)=0
Determine if the specified user is enabled to start recording.
virtual SDKError RequestStartCloudRecording()=0
Send a request to ask the host to start cloud recording.
virtual SDKError StopRawRecording()=0
Stop rawdata recording.
virtual SDKError StopCloudRecording()=0
Stop cloud recording.
virtual RecordingStatus GetCloudRecordingStatus()=0
Get current cloud recording.
virtual SDKError DisAllowLocalRecording(unsigned int userid)=0
Abrogate the authority of the specified user for local recoding.
virtual SDKError CanStartRawRecording()=0
Determine if the specified user is enabled to start raw recording.
virtual SDKError SetEvent(IMeetingRecordingCtrlEvent *pEvent)=0
Set meeting recording callback event handler.
virtual SDKError StartCloudRecording()=0
Start 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
Determine 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
Send a request to enable the SDK to start local recording.
virtual SDKError ResumeRecording()=0
Resume recording.
virtual SDKError IsSupportRequestLocalRecordingPrivilege()=0
Determine if the user owns the authority to enable the local recording.
virtual SDKError StopRecording(time_t &stopTimestamp)=0
Stop recording.
virtual SDKError StartRawRecording()=0
Start 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 can...
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.
Enable and start smart cloud recording request handler.
virtual SDKError StartCloudRecordingWithoutEnableSmartRecording()=0
Start normal cloud recording without enabling smart recording.
virtual unsigned int GetRequestUserId()=0
Get 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
Get the legal tip that you should agree to handle the user request.
virtual SDKError AgreeToEnableAndStart(bool bAllMeetings)=0
Agree 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
Get the request ID.
virtual SDKError DenyLocalRecordingPrivilege()=0
Denies the user permission to start local recording and finally self-destroy.
virtual unsigned int GetRequesterId()=0
Get the user ID who requested privilege.
virtual const zchar_t * GetRequesterName()=0
Get the user name who requested privileges.
virtual SDKError GrantLocalRecordingPrivilege()=0
Allows the user to start local recording and finally self-destroy.
Object to handle a user's request to start cloud recording.
virtual const zchar_t * GetRequesterName()=0
Get the user name who requested that the host start cloud recording.
virtual SDKError Start()=0
Accept the request to start cloud recording and then destroys the IRequestCloudRecordingHandler insta...
virtual unsigned int GetRequesterId()=0
Get the user ID who requested that the host start cloud recording.
virtual SDKError Deny(bool bDenyAll)=0
Deny the request to start cloud recording and then destroys the IRequestCloudRecordingHandler instanc...
virtual SDKError ActionCancel()=0
Cancel enabling and starting the smart recording.
virtual const zchar_t * GetTipString()=0
Get the legal tip to enable smart recording.
virtual SDKError ActionConfirm(bool bAllMeetings)=0
Confirm enabling and starting the smart recording.
RecordingStatus
Recording status. Here are more detailed structural descriptions.
RequestStartCloudRecordingStatus
Request host to start cloud recording status.
@ RequestStartCloudRecording_Granted
@ RequestStartCloudRecording_Denied
@ RequestStartCloudRecording_TimedOut
RequestLocalRecordingStatus
Request local recording privilege status. Here are more detailed structural descriptions.
@ 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.