ZOOM Windows SDK  5.2.42037.1112
zoom_sdk_def.h
Go to the documentation of this file.
1 
6 #ifndef _ZOOM_SDK_DEF_H_
7 #define _ZOOM_SDK_DEF_H_
8 #include <tchar.h>
9 #define PLATFORM_IMPORT __declspec(dllimport)
10 #define PLATFORM_EXPORT __declspec(dllexport)
11 #ifdef ZOOM_SDK_DLL_EXPORT
12 #define SDK_API PLATFORM_EXPORT
13 #elif defined ZOOM_SDK_DLL_IMPORT
14 #define SDK_API PLATFORM_IMPORT
15 #else
16 #define SDK_API
17 #endif
18 
19 #define ZOOM_SDK_NAMESPACE ZOOMSDK
20 #define BEGIN_ZOOM_SDK_NAMESPACE namespace ZOOM_SDK_NAMESPACE {
21 #define END_ZOOM_SDK_NAMESPACE };
22 #define USING_ZOOM_SDK_NAMESPACE using namespace ZOOM_SDK_NAMESPACE;
23 
24 BEGIN_ZOOM_SDK_NAMESPACE
30 {
59 };
60 
66 {
80 };
81 
86 typedef struct tagWndPosition
87 {
88  int left;
89  int top;
90  HWND hSelfWnd;
91  HWND hParent;
93  {
94  left = 0;
95  top = 0;
96  hSelfWnd = NULL;
97  hParent = NULL;
98  }
100 
106 {
110 };
111 
117 {
118  const char* langName;
119  const char* langInfo;
122  {
123  langName = NULL;
124  langInfo = NULL;
126  }
127 
129 
135 #define ENABLE_CUSTOMIZED_UI_FLAG (1 << 5)
137 {
138  CustomizedLanguageInfo customizedLang;
140  const wchar_t* sdkPathPostfix;
142  {
143  optionalFeatures = 0;
144  sdkPathPostfix = NULL;
145  }
146 
148 
154 {
155  SDK_APP_Locale_Default,
156  SDK_APP_Locale_CN,
157 };
158 
159 enum ZoomSDKRawDataMemoryMode
160 {
161  ZoomSDKRawDataMemoryModeStack,
162  ZoomSDKRawDataMemoryModeHeap
163 };
164 
165 enum ZoomSDKVideoRenderMode
166 {
167  ZoomSDKVideoRenderMode_None = 0,
168  ZoomSDKVideoRenderMode_Auto,
169  ZoomSDKVideoRenderMode_D3D11EnableFLIP,
170  ZoomSDKVideoRenderMode_D3D11,
171  ZoomSDKVideoRenderMode_D3D9,
172  ZoomSDKVideoRenderMode_GDI,
173 };
174 
175 enum ZoomSDKRenderPostProcessing
176 {
177  ZoomSDKRenderPostProcessing_None = 0,
178  ZoomSDKRenderPostProcessing_Auto,
179  ZoomSDKRenderPostProcessing_Enable,
180  ZoomSDKRenderPostProcessing_Disable,
181 };
182 
183 enum ZoomSDKVideoCaptureMethod
184 {
185  ZoomSDKVideoCaptureMethod_None = 0,
186  ZoomSDKVideoCaptureMethod_Auto,
187  ZoomSDKVideoCaptureMethod_DirectSHow,
188  ZoomSDKVideoCaptureMethod_MediaFoundation,
189 };
190 
192 {
193  ZoomSDKVideoRenderMode videoRenderMode;
194  ZoomSDKRenderPostProcessing renderPostProcessing;
195  ZoomSDKVideoCaptureMethod videoCaptureMethod;
197  {
198  videoRenderMode = ZoomSDKVideoRenderMode_None;
199  renderPostProcessing = ZoomSDKRenderPostProcessing_Auto;
200  videoCaptureMethod = ZoomSDKVideoCaptureMethod_Auto;
201  }
203 
204 typedef struct tagRawDataOptions
205 {
207  ZoomSDKRawDataMemoryMode videoRawdataMemoryMode;
208  ZoomSDKRawDataMemoryMode shareRawdataMemoryMode;
209  ZoomSDKRawDataMemoryMode audioRawdataMemoryMode;
211  {
213  videoRawdataMemoryMode = ZoomSDKRawDataMemoryModeStack;
214  shareRawdataMemoryMode = ZoomSDKRawDataMemoryModeStack;
215  audioRawdataMemoryMode = ZoomSDKRawDataMemoryModeStack;
216  }
218 
223 typedef struct tagInitParam
224 {
225  const wchar_t* strWebDomain;
226  const wchar_t* strBrandingName;
227  const wchar_t* strSupportUrl;
229  unsigned int uiWindowIconSmallID;
230  unsigned int uiWindowIconBigID;
234  unsigned int uiLogFileSize;
236  SDK_APP_Locale locale;
237  bool permonitor_awareness_mode;
238  ZoomSDKRenderOptions renderOpts;
239  RawDataOptions rawdataOpts;
240  tagInitParam()
241  {
242  strWebDomain = NULL;
243  strBrandingName = NULL;
244  strSupportUrl = NULL;
245  hResInstance = (void*)-1;
247  uiWindowIconBigID = 0;
249  enableGenerateDump = false;
250  enableLogByDefault = false;
251  uiLogFileSize = 5;
252  locale = SDK_APP_Locale_Default;
253  permonitor_awareness_mode = true;
254  }
255 }InitParam;
256 
262 {
268 };
269 
273 {
274 public:
277  virtual LastErrorType GetErrorType() const = 0 ;
280  virtual UINT64 GetErrorCode() const = 0;
281 
284  virtual const wchar_t* GetErrorDescription() const = 0;
285  virtual ~IZoomLastError(){};
286 };
287 template<class T>
288 class IList
289 {
290 public:
291  virtual ~IList(){};
292  virtual int GetCount() = 0;
293  virtual T GetItem(int index) = 0;
294 };
295 #define SDK_NULL_AUDIO_FILE_HANDLE (0xffffffff)
296 const RECT _SDK_TEST_VIDEO_INIT_RECT = {0,0,0,0};
297 
298 END_ZOOM_SDK_NAMESPACE
299 
300 #endif
LastErrorType
The last error types of the SDK. Here are more detailed structural descriptions.
Definition: zoom_sdk_def.h:261
The associated error with the SDK bottom layer.
Definition: zoom_sdk_def.h:267
Email login is disable.
Definition: zoom_sdk_def.h:57
Initialize the SDK Parameter. Here are more detailed structural descriptions.
Definition: zoom_sdk_def.h:223
The associated error with the meeting.
Definition: zoom_sdk_def.h:266
virtual const wchar_t * GetErrorDescription() const =0
Get the description for the last error.
No error.
Definition: zoom_sdk_def.h:263
In German.
Definition: zoom_sdk_def.h:73
SDK configuration options.
Definition: zoom_sdk_def.h:136
The other instance of the SDK is in process.
Definition: zoom_sdk_def.h:45
No permission.
Definition: zoom_sdk_def.h:43
bool enableGenerateDump
Enable generate dump file if the app crashed.
Definition: zoom_sdk_def.h:232
void * hResInstance
Resource module handle.
Definition: zoom_sdk_def.h:228
int optionalFeatures
The custom resource information.
Definition: zoom_sdk_def.h:139
ConfigurableOptions obConfigOpts
The configuration options of the SDK.
Definition: zoom_sdk_def.h:235
Definition: zoom_sdk_def.h:288
Incorrect usage of the feature.
Definition: zoom_sdk_def.h:33
In Italian.
Definition: zoom_sdk_def.h:79
In Japanese.
Definition: zoom_sdk_def.h:71
There is no sharing.
Definition: zoom_sdk_def.h:53
Definition: zoom_sdk_def.h:116
Wrong parameter.
Definition: zoom_sdk_def.h:34
The custom resource information used by the SDK. Here are more detailed structural descriptions...
In English.
Definition: zoom_sdk_def.h:68
int top
Specifies the Y-axis coordinate of the top-left of the window.
Definition: zoom_sdk_def.h:89
In Vietnamese.
Definition: zoom_sdk_def.h:78
The current user is not the presenter.
Definition: zoom_sdk_def.h:52
Definition: zoom_sdk_def.h:191
int left
Specifies the X-axis coordinate of the top-left corner of the window.
Definition: zoom_sdk_def.h:88
Use the specified file path to assign the custom resource.
Definition: zoom_sdk_def.h:108
virtual LastErrorType GetErrorType() const =0
Get the last error type.
const char * langInfo
The value should be the full path of the resource file when the langType value is CustomizedLanguage_...
Definition: zoom_sdk_def.h:119
SDKError
SDK error types. Here are more detailed structural descriptions.
Definition: zoom_sdk_def.h:29
This feature is currently invalid.
Definition: zoom_sdk_def.h:32
For initialization.
Definition: zoom_sdk_def.h:67
Transcoder module is not found.
Definition: zoom_sdk_def.h:41
SDK_LANGUAGE_ID emLanguageID
The ID of the SDK language.
Definition: zoom_sdk_def.h:231
User can&#39;t be assigned with new privilege.
Definition: zoom_sdk_def.h:50
HWND hParent
Specifies the window handle of the parent window. If the value is NULL, the position coordinate is th...
Definition: zoom_sdk_def.h:91
API calls too frequently.
Definition: zoom_sdk_def.h:49
Success.
Definition: zoom_sdk_def.h:31
In French.
Definition: zoom_sdk_def.h:74
No memory is allocated.
Definition: zoom_sdk_def.h:36
In traditional Chinese.
Definition: zoom_sdk_def.h:70
Internal service error.
Definition: zoom_sdk_def.h:37
unsigned int uiLogFileSize
Size of a log file in M(megabyte). The default size is 5M. There are 5 log files in total and the fil...
Definition: zoom_sdk_def.h:234
Not initialized before the usage.
Definition: zoom_sdk_def.h:38
HWND hSelfWnd
Specifies the window handle of the window itself.
Definition: zoom_sdk_def.h:90
unsigned int uiWindowIconSmallID
The ID of the small icon on the window.
Definition: zoom_sdk_def.h:229
Annotation is disabled.
Definition: zoom_sdk_def.h:55
Definition: zoom_sdk_def.h:204
Error during verification.
Definition: zoom_sdk_def.h:264
Current OS doesn&#39;t support the setting.
Definition: zoom_sdk_def.h:56
Loading module failed.
Definition: zoom_sdk_def.h:35
const wchar_t * strSupportUrl
Support URL.
Definition: zoom_sdk_def.h:227
CustomizedLanguageType langType
Use the custom resource type.
Definition: zoom_sdk_def.h:120
No recording in process.
Definition: zoom_sdk_def.h:40
In Portuguese.
Definition: zoom_sdk_def.h:75
In Korean.
Definition: zoom_sdk_def.h:77
No audio device found.
Definition: zoom_sdk_def.h:47
Use the specified content to assign the custom resource.
Definition: zoom_sdk_def.h:109
The current meeting doesn&#39;t support the feature.
Definition: zoom_sdk_def.h:51
No use of the custom resource.
Definition: zoom_sdk_def.h:107
unsigned int uiWindowIconBigID
The ID of the big Icon on the window.
Definition: zoom_sdk_def.h:230
In Russian.
Definition: zoom_sdk_def.h:76
The position of the window. The coordinate of position is that of monitor when the parent window is n...
Definition: zoom_sdk_def.h:86
Not authorized before the usage.
Definition: zoom_sdk_def.h:39
SDK_APP_Locale
SDK_APP locale type. Here are more detailed structural descriptions.
Definition: zoom_sdk_def.h:153
virtual UINT64 GetErrorCode() const =0
Get the last error code.
bool enableLogByDefault
Enable log feature.
Definition: zoom_sdk_def.h:233
const wchar_t * strBrandingName
Branding name.
Definition: zoom_sdk_def.h:226
The video service is not ready.
Definition: zoom_sdk_def.h:42
In simplified Chinese.
Definition: zoom_sdk_def.h:69
No video device found.
Definition: zoom_sdk_def.h:48
Error during login.
Definition: zoom_sdk_def.h:265
Unknown error.
Definition: zoom_sdk_def.h:44
const wchar_t * strWebDomain
Web domain.
Definition: zoom_sdk_def.h:225
SDK internal error.
Definition: zoom_sdk_def.h:46
const char * langName
Resource name.
Definition: zoom_sdk_def.h:118
SDK_LANGUAGE_ID
The text resource type used by the SDK. Here are more detailed structural descriptions.
Definition: zoom_sdk_def.h:65
Computer doesn&#39;t meet the minimum requirements to use virtual background feature. ...
Definition: zoom_sdk_def.h:58
In Spanish.
Definition: zoom_sdk_def.h:72
Error mechanism interface provided by the SDK This feature is gradually improved, so some errors may ...
Definition: zoom_sdk_def.h:272
bool enableRawdataIntermediateMode
false – YUV420data, true – intermediate data
Definition: zoom_sdk_def.h:206
Incorrect ViewType parameters.
Definition: zoom_sdk_def.h:54