Meeting SDK for Linux API Reference
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
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>
24
25#if defined(__linux__)
26enum TranscodingStatus
27{
28 Transcoding_Start,
29 Transcoding_Inprogress,
30 Transcoding_End,
31 Transcoding_Error_LowDiskSpace,
32 Transcoding_Error_UnknownSources,
33 Transcoding_Error_WrongFile,
34 Transcoding_Error_Unknown,
35};
36
37typedef enum
38{
39 REC_TYPE_VIDEO = 0,
40 REC_TYPE_SHARE,
41}LocalRecordingSubscribeType;
42
43typedef enum LocalRecordingResolution
44{
45 LocalRecordingResolution_90P = 0,
46 LocalRecordingResolution_180P,
47 LocalRecordingResolution_360P,
48 LocalRecordingResolution_720P,
49 LocalRecordingResolution_1080P,
50 LocalRecordingResolution_NoUse = 100
51}LocalRecordingResolution;
52#endif
53
64
74
82
85{
86public:
90 virtual const zchar_t* GetRequestId() = 0;
91
94 virtual unsigned int GetRequesterId() = 0;
95
98 virtual const zchar_t* GetRequesterName() = 0;
99
102
105};
106
110{
111public:
115 virtual unsigned int GetRequesterId() = 0;
116
119 virtual const zchar_t* GetRequesterName() = 0;
120
122 virtual SDKError Start() = 0;
123
126 virtual SDKError Deny(bool bDenyAll) = 0;
127};
128
131{
132public:
136 virtual unsigned int GetRequestUserId() = 0;
137
140 virtual const zchar_t* GetTipString() = 0;
141
146
151 virtual SDKError AgreeToEnableAndStart(bool bAllMeetings) = 0;
152
157 virtual SDKError Decline(bool bDenyAll) = 0;
158};
159
162{
163public:
165
168 virtual const zchar_t* GetTipString() = 0;
169
174 virtual SDKError ActionConfirm(bool bAllMeetings) = 0;
175
179 virtual SDKError ActionCancel() = 0;
180};
181
182#if defined(WIN32)
183class ICustomizedLocalRecordingLayoutHelper;
184#endif
188{
189public:
191
194 virtual void onRecordingStatus(RecordingStatus status) = 0;
195
198 virtual void onCloudRecordingStatus(RecordingStatus status) = 0;
199
202 virtual void onRecordPrivilegeChanged(bool bCanRec) = 0;
203
207
211
215
219
220#if defined(WIN32)
226 virtual void onRecording2MP4Done(bool bsuccess, int iResult, const zchar_t* szPath) = 0;
227
231 virtual void onRecording2MP4Processing(int iPercentage) = 0;
232
236 virtual void onCustomizedLocalRecordingSourceNotification(ICustomizedLocalRecordingLayoutHelper* layout_helper) = 0;
237#endif
238
241 virtual void onCloudRecordingStorageFull(time_t gracePeriodDate) = 0;
242
246
250#if defined(__linux__)
251 virtual void onTranscodingStatusChanged(TranscodingStatus status,const zchar_t* path) = 0;
252#endif
253};
254
258{
259public:
265
270
275
280
285 virtual SDKError StartRecording(time_t& startTimestamp) = 0;
286
291 virtual SDKError StopRecording(time_t& stopTimestamp) = 0;
292
299 virtual SDKError CanStartRecording(bool cloud_recording, unsigned int userid) = 0;
300
303 virtual bool IsSmartRecordingEnabled() = 0;
304
308
313
318
323
328
333 virtual SDKError IsSupportLocalRecording(unsigned int userid) = 0;
334
339 virtual SDKError AllowLocalRecording(unsigned int userid) = 0;
340
345 virtual SDKError DisAllowLocalRecording(unsigned int userid) = 0;
346#if defined(WIN32)
351 virtual SDKError RequestCustomizedLocalRecordingSource() = 0;
352#endif
357
362
367
372
373
378
383
388
393#if defined(__linux__)
394 virtual SDKError SubscribeLocalrecordingResource(unsigned int sourceId, LocalRecordingSubscribeType type,LocalRecordingResolution resolution) = 0;
395 virtual SDKError UnSubscribeLocalrecordingResource(unsigned int sourceId, LocalRecordingSubscribeType type) = 0;
396#endif
397};
399#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.
@ Recording_Stop
Stop recording on local computer or on cloud.
@ Recording_Fail
Saving the recording failed.
@ Recording_Start
Start recording on local computer or on cloud.
@ Recording_DiskFull
There is no more space to store both local and cloud recording.
@ Recording_Connecting
Connecting, only for cloud recording.
@ Recording_Pause
Pause recording on local or on cloud.
RequestStartCloudRecordingStatus
Request host to start cloud recording status.
@ RequestStartCloudRecording_Granted
host grants the request.
@ RequestStartCloudRecording_Denied
host denies the request.
@ RequestStartCloudRecording_TimedOut
the request for cloud recording timed out.
RequestLocalRecordingStatus
Request local recording privilege status. Here are more detailed structural descriptions.
@ RequestLocalRecording_Denied
host deny the request.
@ RequestLocalRecording_Granted
host grant the request.
@ RequestLocalRecording_Timeout
the request local recording timeout.
LocalRecordingRequestPrivilegeStatus
@ LocalRecordingRequestPrivilege_None
@ LocalRecordingRequestPrivilege_AllowRequest
allow participant to send privilege requests.
@ LocalRecordingRequestPrivilege_AutoDeny
host auto-deny all privilege requests.
@ LocalRecordingRequestPrivilege_AutoGrant
host auto-allow all privilege requests.
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
#define BEGIN_ZOOM_SDK_NAMESPACE
char zchar_t
SDKError
SDK error types. Here are more detailed structural descriptions.