Windows SDK API Reference
Loading...
Searching...
No Matches
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
30{
63};
64
70{
86};
87
92typedef struct tagWndPosition
93{
94 int left;
95 int top;
97 HWND hParent;
99 {
100 left = 0;
101 top = 0;
102 hSelfWnd = NULL;
103 hParent = NULL;
104 }
106
112{
116};
117
123{
124 const char* langName;
125 const char* langInfo;
128 {
129 langName = NULL;
130 langInfo = NULL;
132 }
133
135
141#define ENABLE_CUSTOMIZED_UI_FLAG (1 << 5)
143{
146 const wchar_t* sdkPathPostfix;
148 {
150 sdkPathPostfix = NULL;
151 }
152
154
160{
163};
164
166{
170
172{
179};
180
182{
187};
188
190{
195};
196
198{
203 {
207 }
209
210typedef struct tagRawDataOptions
211{
217 {
222 }
224
229typedef struct tagInitParam
230{
231 const wchar_t* strWebDomain;
232 const wchar_t* strBrandingName;
233 const wchar_t* strSupportUrl;
236 unsigned int uiWindowIconBigID;
240 unsigned int uiLogFileSize;
247 {
248 strWebDomain = NULL;
249 strBrandingName = NULL;
250 strSupportUrl = NULL;
251 hResInstance = (void*)-1;
255 enableGenerateDump = false;
256 enableLogByDefault = false;
257 uiLogFileSize = 5;
260 }
262
268{
276};
277
283{
289};
290
294{
295public:
298 virtual LastErrorType GetErrorType() const = 0 ;
301 virtual UINT64 GetErrorCode() const = 0;
302
305 virtual const wchar_t* GetErrorDescription() const = 0;
306 virtual ~IZoomLastError(){};
307};
308template<class T>
309class IList
310{
311public:
312 virtual ~IList(){};
313 virtual int GetCount() = 0;
314 virtual T GetItem(int index) = 0;
315};
316#define SDK_NULL_AUDIO_FILE_HANDLE (0xffffffff)
317const RECT _SDK_TEST_VIDEO_INIT_RECT = {0,0,0,0};
318
320
321#endif
virtual int GetCount()=0
virtual ~IList()
Definition: zoom_sdk_def.h:312
virtual T GetItem(int index)=0
Error mechanism interface provided by the SDK This feature is gradually improved, so some errors may ...
Definition: zoom_sdk_def.h:294
virtual LastErrorType GetErrorType() const =0
Get the last error type.
virtual ~IZoomLastError()
Definition: zoom_sdk_def.h:306
virtual const wchar_t * GetErrorDescription() const =0
Get the description for the last error.
virtual UINT64 GetErrorCode() const =0
Get the last error code.
The custom resource information used by the SDK. Here are more detailed structural descriptions.
SDK configuration options.
Definition: zoom_sdk_def.h:143
const wchar_t * sdkPathPostfix
Definition: zoom_sdk_def.h:146
CustomizedLanguageInfo customizedLang
Definition: zoom_sdk_def.h:144
int optionalFeatures
The custom resource information.
Definition: zoom_sdk_def.h:145
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:125
CustomizedLanguageType langType
Use the custom resource type.
Definition: zoom_sdk_def.h:126
const char * langName
Resource name.
Definition: zoom_sdk_def.h:124
Initialize the SDK Parameter. Here are more detailed structural descriptions.
Definition: zoom_sdk_def.h:230
bool permonitor_awareness_mode
Definition: zoom_sdk_def.h:243
void * hResInstance
Resource module handle.
Definition: zoom_sdk_def.h:234
RawDataOptions rawdataOpts
Definition: zoom_sdk_def.h:245
SDK_LANGUAGE_ID emLanguageID
The ID of the SDK language.
Definition: zoom_sdk_def.h:237
const wchar_t * strBrandingName
Branding name.
Definition: zoom_sdk_def.h:232
bool enableGenerateDump
Enable generate dump file if the app crashed.
Definition: zoom_sdk_def.h:238
bool enableLogByDefault
Enable log feature.
Definition: zoom_sdk_def.h:239
ZoomSDKRenderOptions renderOpts
Definition: zoom_sdk_def.h:244
ConfigurableOptions obConfigOpts
The configuration options of the SDK.
Definition: zoom_sdk_def.h:241
unsigned int uiWindowIconSmallID
The ID of the small icon on the window.
Definition: zoom_sdk_def.h:235
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:240
const wchar_t * strSupportUrl
Support URL.
Definition: zoom_sdk_def.h:233
unsigned int uiWindowIconBigID
The ID of the big Icon on the window.
Definition: zoom_sdk_def.h:236
const wchar_t * strWebDomain
Web domain.
Definition: zoom_sdk_def.h:231
SDK_APP_Locale locale
Definition: zoom_sdk_def.h:242
ZoomSDKRawDataMemoryMode videoRawdataMemoryMode
Definition: zoom_sdk_def.h:213
ZoomSDKRawDataMemoryMode shareRawdataMemoryMode
Definition: zoom_sdk_def.h:214
ZoomSDKRawDataMemoryMode audioRawdataMemoryMode
Definition: zoom_sdk_def.h:215
bool enableRawdataIntermediateMode
false – YUV420data, true – intermediate data
Definition: zoom_sdk_def.h:212
The position of the window. The coordinate of position is that of monitor when the parent window is n...
Definition: zoom_sdk_def.h:93
HWND hSelfWnd
Specifies the window handle of the window itself.
Definition: zoom_sdk_def.h:96
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:97
int top
Specifies the Y-axis coordinate of the top-left of the window.
Definition: zoom_sdk_def.h:95
int left
Specifies the X-axis coordinate of the top-left corner of the window.
Definition: zoom_sdk_def.h:94
ZoomSDKVideoCaptureMethod videoCaptureMethod
Definition: zoom_sdk_def.h:201
ZoomSDKVideoRenderMode videoRenderMode
Definition: zoom_sdk_def.h:199
ZoomSDKRenderPostProcessing renderPostProcessing
Definition: zoom_sdk_def.h:200
struct tagZoomSDKRenderOptions ZoomSDKRenderOptions
struct tagRawDataOptions RawDataOptions
struct tagInitParam InitParam
SDK_APP_Locale
SDK_APP locale type. Here are more detailed structural descriptions.
Definition: zoom_sdk_def.h:160
@ SDK_APP_Locale_Default
Definition: zoom_sdk_def.h:161
@ SDK_APP_Locale_CN
Definition: zoom_sdk_def.h:162
LastErrorType
The last error types of the SDK. Here are more detailed structural descriptions.
Definition: zoom_sdk_def.h:283
@ LastErrorType_Auth
Error during verification.
Definition: zoom_sdk_def.h:285
@ LastErrorType_Login
Error during login.
Definition: zoom_sdk_def.h:286
@ LastErrorType_System
The associated error with the SDK bottom layer.
Definition: zoom_sdk_def.h:288
@ LastErrorType_Meeting
The associated error with the meeting.
Definition: zoom_sdk_def.h:287
@ LastErrorType_None
No error.
Definition: zoom_sdk_def.h:284
ZoomSDKVideoRenderMode
Definition: zoom_sdk_def.h:172
@ ZoomSDKVideoRenderMode_None
Definition: zoom_sdk_def.h:173
@ ZoomSDKVideoRenderMode_D3D11
Definition: zoom_sdk_def.h:176
@ ZoomSDKVideoRenderMode_Auto
Definition: zoom_sdk_def.h:174
@ ZoomSDKVideoRenderMode_D3D9
Definition: zoom_sdk_def.h:177
@ ZoomSDKVideoRenderMode_GDI
Definition: zoom_sdk_def.h:178
@ ZoomSDKVideoRenderMode_D3D11EnableFLIP
Definition: zoom_sdk_def.h:175
struct tagWndPosition WndPosition
#define END_ZOOM_SDK_NAMESPACE
Definition: zoom_sdk_def.h:21
ZoomSDKVideoCaptureMethod
Definition: zoom_sdk_def.h:190
@ ZoomSDKVideoCaptureMethod_DirectSHow
Definition: zoom_sdk_def.h:193
@ ZoomSDKVideoCaptureMethod_Auto
Definition: zoom_sdk_def.h:192
@ ZoomSDKVideoCaptureMethod_None
Definition: zoom_sdk_def.h:191
@ ZoomSDKVideoCaptureMethod_MediaFoundation
Definition: zoom_sdk_def.h:194
@ CustomizedLanguage_None
No use of the custom resource.
Definition: zoom_sdk_def.h:113
@ CustomizedLanguage_Content
Use the specified content to assign the custom resource.
Definition: zoom_sdk_def.h:115
@ CustomizedLanguage_FilePath
Use the specified file path to assign the custom resource.
Definition: zoom_sdk_def.h:114
struct tagCustomizedLanguageInfo CustomizedLanguageInfo
SDK_LANGUAGE_ID
The text resource type used by the SDK. Here are more detailed structural descriptions.
Definition: zoom_sdk_def.h:70
@ LANGUAGE_Russian
In Russian.
Definition: zoom_sdk_def.h:80
@ LANGUAGE_French
In French.
Definition: zoom_sdk_def.h:78
@ LANGUAGE_Chinese_Traditional
In traditional Chinese.
Definition: zoom_sdk_def.h:74
@ LANGUAGE_Spanish
In Spanish.
Definition: zoom_sdk_def.h:76
@ LANGUAGE_Japanese
In Japanese.
Definition: zoom_sdk_def.h:75
@ LANGUAGE_Vietnamese
In Vietnamese.
Definition: zoom_sdk_def.h:82
@ LANGUAGE_Polish
In Polish.
Definition: zoom_sdk_def.h:84
@ LANGUAGE_English
In English.
Definition: zoom_sdk_def.h:72
@ LANGUAGE_Italian
In Italian.
Definition: zoom_sdk_def.h:83
@ LANGUAGE_German
In German.
Definition: zoom_sdk_def.h:77
@ LANGUAGE_Portuguese
In Portuguese.
Definition: zoom_sdk_def.h:79
@ LANGUAGE_Chinese_Simplified
In simplified Chinese.
Definition: zoom_sdk_def.h:73
@ LANGUAGE_Korean
In Korean.
Definition: zoom_sdk_def.h:81
@ LANGUAGE_Unknow
For initialization.
Definition: zoom_sdk_def.h:71
@ LANGUAGE_Turkish
In Turkish.
Definition: zoom_sdk_def.h:85
ZoomSDKRenderPostProcessing
Definition: zoom_sdk_def.h:182
@ ZoomSDKRenderPostProcessing_Enable
Definition: zoom_sdk_def.h:185
@ ZoomSDKRenderPostProcessing_Disable
Definition: zoom_sdk_def.h:186
@ ZoomSDKRenderPostProcessing_None
Definition: zoom_sdk_def.h:183
@ ZoomSDKRenderPostProcessing_Auto
Definition: zoom_sdk_def.h:184
#define BEGIN_ZOOM_SDK_NAMESPACE
Definition: zoom_sdk_def.h:20
const RECT _SDK_TEST_VIDEO_INIT_RECT
Definition: zoom_sdk_def.h:317
struct tagConfigurableOptions ConfigurableOptions
ShareType
Definition: zoom_sdk_def.h:268
@ SHARE_TYPE_AIRHOST
Type of sharing data from the device connected WIFI.
Definition: zoom_sdk_def.h:273
@ SHARE_TYPE_DATA
Type of sharing the data.
Definition: zoom_sdk_def.h:275
@ SHARE_TYPE_DS
Type of sharing the desktop.
Definition: zoom_sdk_def.h:271
@ SHARE_TYPE_AS
Type of sharing the application.
Definition: zoom_sdk_def.h:270
@ SHARE_TYPE_UNKNOWN
Type unknown.
Definition: zoom_sdk_def.h:269
@ SHARE_TYPE_CAMERA
Type of sharing the camera.
Definition: zoom_sdk_def.h:274
@ SHARE_TYPE_WB
Type of sharing the white-board.
Definition: zoom_sdk_def.h:272
ZoomSDKRawDataMemoryMode
Definition: zoom_sdk_def.h:166
@ ZoomSDKRawDataMemoryModeStack
Definition: zoom_sdk_def.h:167
@ ZoomSDKRawDataMemoryModeHeap
Definition: zoom_sdk_def.h:168
SDKError
SDK error types. Here are more detailed structural descriptions.
Definition: zoom_sdk_def.h:30
@ SDKERR_UNINITIALIZE
Not initialized before the usage.
Definition: zoom_sdk_def.h:38
@ SDKERR_NO_AUDIODEVICE_ISFOUND
No audio device found.
Definition: zoom_sdk_def.h:47
@ SDKERR_NOT_IN_MEETING
Definition: zoom_sdk_def.h:62
@ SDKERR_SUCCESS
Success.
Definition: zoom_sdk_def.h:31
@ SDKERR_INTERNAL_ERROR
SDK internal error.
Definition: zoom_sdk_def.h:46
@ SDKERR_VIDEO_NOTREADY
The video service is not ready.
Definition: zoom_sdk_def.h:42
@ SDKERR_SETTING_OS_DONT_SUPPORT
Current OS doesn't support the setting.
Definition: zoom_sdk_def.h:56
@ SDKERR_HARDWARE_NOT_MEET_FOR_VB
Computer doesn't meet the minimum requirements to use virtual background feature.
Definition: zoom_sdk_def.h:58
@ SDKERR_NO_PERMISSION
No permission.
Definition: zoom_sdk_def.h:43
@ SDKERR_TRANSCODER_NOFOUND
Transcoder module is not found.
Definition: zoom_sdk_def.h:41
@ SDKERR_UNKNOWN
Unknown error.
Definition: zoom_sdk_def.h:44
@ SDKERR_MEMORY_FAILED
No memory is allocated.
Definition: zoom_sdk_def.h:36
@ SDKERR_SHARE_CANNOT_SUBSCRIBE_MYSELF
Definition: zoom_sdk_def.h:61
@ SDKERR_NO_VIDEODEVICE_ISFOUND
No video device found.
Definition: zoom_sdk_def.h:48
@ SDKERR_EMAIL_LOGIN_IS_DISABLED
Email login is disable.
Definition: zoom_sdk_def.h:57
@ SDKERR_NO_SHARE_DATA
There is no raw data of sharing.
Definition: zoom_sdk_def.h:60
@ SDKERR_TOO_FREQUENT_CALL
API calls too frequently.
Definition: zoom_sdk_def.h:49
@ SDKERR_NEED_USER_CONFIRM_RECORD_DISCLAIMER
Need process disclaimer.
Definition: zoom_sdk_def.h:59
@ SDKERR_INVALID_PARAMETER
Wrong parameter.
Definition: zoom_sdk_def.h:34
@ SDKERR_NO_IMPL
This feature is currently invalid.
Definition: zoom_sdk_def.h:32
@ SDKERR_NORECORDINGINPROCESS
No recording in process.
Definition: zoom_sdk_def.h:40
@ SDKERR_UNAUTHENTICATION
Not authorized before the usage.
Definition: zoom_sdk_def.h:39
@ SDKERR_FAIL_ASSIGN_USER_PRIVILEGE
User can't be assigned with new privilege.
Definition: zoom_sdk_def.h:50
@ SDKERR_WRONG_USAGE
Incorrect usage of the feature.
Definition: zoom_sdk_def.h:33
@ SDKERR_MEETING_VIEWTYPE_PARAMETER_IS_WRONG
Incorrect ViewType parameters.
Definition: zoom_sdk_def.h:54
@ SDKERR_MODULE_LOAD_FAILED
Loading module failed.
Definition: zoom_sdk_def.h:35
@ SDKERR_MEETING_NOT_SHARE_SENDER
The current user is not the presenter.
Definition: zoom_sdk_def.h:52
@ SDKERR_OTHER_SDK_INSTANCE_RUNNING
The other instance of the SDK is in process.
Definition: zoom_sdk_def.h:45
@ SDKERR_MEETING_ANNOTATION_IS_OFF
Annotation is disabled.
Definition: zoom_sdk_def.h:55
@ SDKERR_SERVICE_FAILED
Internal service error.
Definition: zoom_sdk_def.h:37
@ SDKERR_MEETING_DONT_SUPPORT_FEATURE
The current meeting doesn't support the feature.
Definition: zoom_sdk_def.h:51
@ SDKERR_MEETING_YOU_HAVE_NO_SHARE
There is no sharing.
Definition: zoom_sdk_def.h:53