Meeting SDK for Windows API Reference
Loading...
Searching...
No Matches
zoom_sdk_def.h File Reference

ZOOM windows SDK Common Definition File. More...

#include <tchar.h>

Go to the source code of this file.

Data Structures

struct  tagWndPosition
 The position of the window. The coordinate of position is that of monitor when the parent window is null. If the the parent window is not null, the position coordinate is that of the parent window. More...
 
struct  tagCustomizedLanguageInfo
 The custom resource information used by the SDK. More...
 
struct  tagConfigurableOptions
 
struct  tagZoomSDKRenderOptions
 Video render options. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066515.. More...
 
struct  tagRawDataOptions
 Rawdata options. More...
 
struct  tagInitParam
 Initialize the SDK Parameter. More...
 
class  IZoomLastError
 Error mechanism interface provided by the SDK. This feature is gradually improved, so some errors may not be supported. More...
 
class  IList< T >
 
struct  ZoomSDKColor
 Zoom SDK color. The standard RGB color model has a value range of 0-255. More...
 

Macros

#define TLS_KEY_DEF   uint32_t
 
#define PLATFORM_IMPORT   __declspec(dllimport)
 
#define PLATFORM_EXPORT   __declspec(dllexport)
 
#define SDK_API
 
#define ZOOM_SDK_NAMESPACE   ZOOMSDK
 
#define BEGIN_ZOOM_SDK_NAMESPACE   namespace ZOOM_SDK_NAMESPACE {
 
#define END_ZOOM_SDK_NAMESPACE   };
 
#define USING_ZOOM_SDK_NAMESPACE   using namespace ZOOM_SDK_NAMESPACE;
 
#define ENABLE_CUSTOMIZED_UI_FLAG   (1 << 5)
 SDK configuration options.
 
#define SDK_NULL_AUDIO_FILE_HANDLE   (0xffffffff)
 

Typedefs

typedef wchar_t zchar_t
 
typedef struct tagWndPosition WndPosition
 The position of the window. The coordinate of position is that of monitor when the parent window is null. If the the parent window is not null, the position coordinate is that of the parent window.
 
typedef struct tagCustomizedLanguageInfo CustomizedLanguageInfo
 The custom resource information used by the SDK.
 
typedef struct tagConfigurableOptions ConfigurableOptions
 
typedef struct tagZoomSDKRenderOptions ZoomSDKRenderOptions
 Video render options. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066515..
 
typedef struct tagRawDataOptions RawDataOptions
 Rawdata options.
 
typedef struct tagInitParam InitParam
 Initialize the SDK Parameter.
 

Enumerations

enum  SDKError {
  SDKERR_SUCCESS = 0 , SDKERR_NO_IMPL , SDKERR_WRONG_USAGE , SDKERR_INVALID_PARAMETER ,
  SDKERR_MODULE_LOAD_FAILED , SDKERR_MEMORY_FAILED , SDKERR_SERVICE_FAILED , SDKERR_UNINITIALIZE ,
  SDKERR_UNAUTHENTICATION , SDKERR_NORECORDINGINPROCESS , SDKERR_TRANSCODER_NOFOUND , SDKERR_VIDEO_NOTREADY ,
  SDKERR_NO_PERMISSION , SDKERR_UNKNOWN , SDKERR_OTHER_SDK_INSTANCE_RUNNING , SDKERR_INTERNAL_ERROR ,
  SDKERR_NO_AUDIODEVICE_ISFOUND , SDKERR_NO_VIDEODEVICE_ISFOUND , SDKERR_TOO_FREQUENT_CALL , SDKERR_FAIL_ASSIGN_USER_PRIVILEGE ,
  SDKERR_MEETING_DONT_SUPPORT_FEATURE , SDKERR_MEETING_NOT_SHARE_SENDER , SDKERR_MEETING_YOU_HAVE_NO_SHARE , SDKERR_MEETING_VIEWTYPE_PARAMETER_IS_WRONG ,
  SDKERR_MEETING_ANNOTATION_IS_OFF , SDKERR_SETTING_OS_DONT_SUPPORT , SDKERR_EMAIL_LOGIN_IS_DISABLED , SDKERR_HARDWARE_NOT_MEET_FOR_VB ,
  SDKERR_NEED_USER_CONFIRM_RECORD_DISCLAIMER , SDKERR_NO_SHARE_DATA , SDKERR_SHARE_CANNOT_SUBSCRIBE_MYSELF , SDKERR_NOT_IN_MEETING ,
  SDKERR_NOT_JOIN_AUDIO , SDKERR_HARDWARE_DONT_SUPPORT , SDKERR_DOMAIN_DONT_SUPPORT , SDKERR_MEETING_REMOTE_CONTROL_IS_OFF ,
  SDKERR_FILETRANSFER_ERROR
}
 Enumeration of common errors of SDK. More...
 
enum  SDK_LANGUAGE_ID {
  LANGUAGE_Unknown = 0 , LANGUAGE_English , LANGUAGE_Chinese_Simplified , LANGUAGE_Chinese_Traditional ,
  LANGUAGE_Japanese , LANGUAGE_Spanish , LANGUAGE_German , LANGUAGE_French ,
  LANGUAGE_Portuguese , LANGUAGE_Russian , LANGUAGE_Korean , LANGUAGE_Vietnamese ,
  LANGUAGE_Italian , LANGUAGE_Polish , LANGUAGE_Turkish , LANGUAGE_Indonesian ,
  LANGUAGE_Dutch , LANGUAGE_Swedish
}
 Enumeration of the text resource type used by the SDK. More...
 
enum  ZoomSDKRawDataMemoryMode { ZoomSDKRawDataMemoryModeStack , ZoomSDKRawDataMemoryModeHeap }
 Enumeration of memory modes for raw data handling. More...
 
enum  CustomizedLanguageType { CustomizedLanguage_None , CustomizedLanguage_FilePath , CustomizedLanguage_Content }
 Custom resource type used by the SDK. More...
 
enum  SDK_APP_Locale { SDK_APP_Locale_Default , SDK_APP_Locale_CN }
 Enumeration of locale type. More...
 
enum  ZoomSDKVideoRenderMode {
  ZoomSDKVideoRenderMode_None = 0 , ZoomSDKVideoRenderMode_Auto , ZoomSDKVideoRenderMode_D3D11EnableFLIP , ZoomSDKVideoRenderMode_D3D11 ,
  ZoomSDKVideoRenderMode_D3D9 , ZoomSDKVideoRenderMode_GDI
}
 Enumeration of video render mode. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066515.. More...
 
enum  ZoomSDKRenderPostProcessing { ZoomSDKRenderPostProcessing_None = 0 , ZoomSDKRenderPostProcessing_Auto , ZoomSDKRenderPostProcessing_Enable , ZoomSDKRenderPostProcessing_Disable }
 Enumeration of render post processing mode. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066515.. More...
 
enum  ZoomSDKVideoCaptureMethod { ZoomSDKVideoCaptureMethod_None = 0 , ZoomSDKVideoCaptureMethod_Auto , ZoomSDKVideoCaptureMethod_DirectSHow , ZoomSDKVideoCaptureMethod_MediaFoundation }
 Enumeration of video capturing mode. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066515.. More...
 
enum  ShareType {
  SHARE_TYPE_UNKNOWN , SHARE_TYPE_AS , SHARE_TYPE_DS , SHARE_TYPE_WB ,
  SHARE_TYPE_AIRHOST , SHARE_TYPE_CAMERA , SHARE_TYPE_DATA , SHARE_TYPE_VIDEO_FILE ,
  SHARE_TYPE_FRAME , SHARE_TYPE_DOCUMENT , SHARE_TYPE_COMPUTER_AUDIO
}
 Enumeration of types of shared content. More...
 
enum  LastErrorType {
  LastErrorType_None , LastErrorType_Auth , LastErrorType_Login , LastErrorType_Meeting ,
  LastErrorType_System
}
 Enumeration of the last error types of the SDK. More...
 
enum  FrameDataFormat { FrameDataFormat_I420_LIMITED , FrameDataFormat_I420_FULL }
 Enumeration of video frame data format. More...
 
enum  ZoomSDKAudioChannel { ZoomSDKAudioChannel_Mono , ZoomSDKAudioChannel_Stereo }
 Enumeration of the audio modes. More...
 
enum  CannotShareReasonType {
  CannotShareReasonType_None , CannotShareReasonType_Locked , CannotShareReasonType_Disabled , CannotShareReasonType_Other_Screen_Sharing ,
  CannotShareReasonType_Other_WB_Sharing , CannotShareReasonType_Need_Grab_Myself_Screen_Sharing , CannotShareReasonType_Need_Grab_Other_Screen_Sharing , CannotShareReasonType_Need_Grab_Audio_Sharing ,
  CannotShareReasonType_Need_Grap_WB_Sharing , CannotShareReasonType_Reach_Maximum , CannotShareReasonType_Have_Share_From_Mainsession , CannotShareReasonType_Other_DOCS_Sharing ,
  CannotShareReasonType_Need_Grab_DOCS_Sharing , CannotShareReasonType_UnKnown
}
 Enumeration of reasons why sharing is not allowed. More...
 
enum  SharingStatus {
  Sharing_Self_Send_Begin , Sharing_Self_Send_End , Sharing_Self_Send_Pure_Audio_Begin , Sharing_Self_Send_Pure_Audio_End ,
  Sharing_Other_Share_Begin , Sharing_Other_Share_End , Sharing_Other_Share_Pure_Audio_Begin , Sharing_Other_Share_Pure_Audio_End ,
  Sharing_View_Other_Sharing , Sharing_Pause , Sharing_Resume
}
 Enumeration of sharing status. More...
 

Variables

const RECT _SDK_TEST_VIDEO_INIT_RECT = {0,0,0,0}
 

Detailed Description

ZOOM windows SDK Common Definition File.

SDK utility Definition of ZOOM windows.

Definition in file zoom_sdk_def.h.

Macro Definition Documentation

◆ BEGIN_ZOOM_SDK_NAMESPACE

#define BEGIN_ZOOM_SDK_NAMESPACE   namespace ZOOM_SDK_NAMESPACE {

Definition at line 35 of file zoom_sdk_def.h.

◆ ENABLE_CUSTOMIZED_UI_FLAG

#define ENABLE_CUSTOMIZED_UI_FLAG   (1 << 5)

SDK configuration options.

Note
This structure is used only for the SDK initialization to configure the custom resource file and choose whether to use the UI mode.

Definition at line 236 of file zoom_sdk_def.h.

◆ END_ZOOM_SDK_NAMESPACE

#define END_ZOOM_SDK_NAMESPACE   };

Definition at line 36 of file zoom_sdk_def.h.

◆ PLATFORM_EXPORT

#define PLATFORM_EXPORT   __declspec(dllexport)

Definition at line 25 of file zoom_sdk_def.h.

◆ PLATFORM_IMPORT

#define PLATFORM_IMPORT   __declspec(dllimport)

Definition at line 24 of file zoom_sdk_def.h.

◆ SDK_API

#define SDK_API

Definition at line 31 of file zoom_sdk_def.h.

◆ SDK_NULL_AUDIO_FILE_HANDLE

#define SDK_NULL_AUDIO_FILE_HANDLE   (0xffffffff)

Definition at line 490 of file zoom_sdk_def.h.

◆ TLS_KEY_DEF

#define TLS_KEY_DEF   uint32_t

Definition at line 11 of file zoom_sdk_def.h.

◆ USING_ZOOM_SDK_NAMESPACE

#define USING_ZOOM_SDK_NAMESPACE   using namespace ZOOM_SDK_NAMESPACE;

Definition at line 37 of file zoom_sdk_def.h.

◆ ZOOM_SDK_NAMESPACE

#define ZOOM_SDK_NAMESPACE   ZOOMSDK

Definition at line 34 of file zoom_sdk_def.h.

Typedef Documentation

◆ ConfigurableOptions

◆ CustomizedLanguageInfo

The custom resource information used by the SDK.

◆ InitParam

typedef struct tagInitParam InitParam

Initialize the SDK Parameter.

◆ RawDataOptions

Rawdata options.

◆ WndPosition

typedef struct tagWndPosition WndPosition

The position of the window. The coordinate of position is that of monitor when the parent window is null. If the the parent window is not null, the position coordinate is that of the parent window.

◆ zchar_t

typedef wchar_t zchar_t

Definition at line 10 of file zoom_sdk_def.h.

◆ ZoomSDKRenderOptions

Enumeration Type Documentation

◆ CannotShareReasonType

Enumeration of reasons why sharing is not allowed.

Enumerator
CannotShareReasonType_None 

For initialization.

CannotShareReasonType_Locked 

Only the host is allowed to share.

CannotShareReasonType_Disabled 

Sharing is disabled.

CannotShareReasonType_Other_Screen_Sharing 

Another participant is currently sharing their screen.

CannotShareReasonType_Other_WB_Sharing 

Another participant is currently sharing their whiteboard.

CannotShareReasonType_Need_Grab_Myself_Screen_Sharing 

The user is sharing screen, and can grab. To grab, call EnableGrabShareWithoutReminder(true) before starting the share.

CannotShareReasonType_Need_Grab_Other_Screen_Sharing 

Another is sharing their screen, and can grab. To grab, call EnableGrabShareWithoutReminder(true) before starting share.

CannotShareReasonType_Need_Grab_Audio_Sharing 

Another is sharing pure computer audio, and can grab. To grab, call EnableGrabShareWithoutReminder(true) before starting share.

CannotShareReasonType_Need_Grap_WB_Sharing 

Other or myself is sharing whiteboard, and can Grab. To grab, call EnableGrabShareWithoutReminder(true) before starting share.

CannotShareReasonType_Reach_Maximum 

The meeting has reached the maximum allowed screen share sessions.

CannotShareReasonType_Have_Share_From_Mainsession 

Other share screen in main session.

CannotShareReasonType_Other_DOCS_Sharing 

Another participant is sharing their zoom docs.

CannotShareReasonType_Need_Grab_DOCS_Sharing 

Other or myself is sharing docs, and can grab. To grab, call EnableGrabShareWithoutReminder(true) before starting share.

CannotShareReasonType_UnKnown 

UnKnown reason.

Definition at line 519 of file zoom_sdk_def.h.

520{
521
523
525
527
529
531
533
535
537
539
541
543
545
547
549};
@ CannotShareReasonType_Other_WB_Sharing
@ CannotShareReasonType_Other_Screen_Sharing
@ CannotShareReasonType_Need_Grab_DOCS_Sharing
@ CannotShareReasonType_Need_Grap_WB_Sharing
@ CannotShareReasonType_Locked
@ CannotShareReasonType_UnKnown
@ CannotShareReasonType_Other_DOCS_Sharing
@ CannotShareReasonType_Need_Grab_Other_Screen_Sharing
@ CannotShareReasonType_Need_Grab_Audio_Sharing
@ CannotShareReasonType_Need_Grab_Myself_Screen_Sharing
@ CannotShareReasonType_None
@ CannotShareReasonType_Reach_Maximum
@ CannotShareReasonType_Disabled
@ CannotShareReasonType_Have_Share_From_Mainsession

◆ CustomizedLanguageType

Custom resource type used by the SDK.

Enumerator
CustomizedLanguage_None 

No use of the custom resource.

CustomizedLanguage_FilePath 

Use the specified file path to assign the custom resource.

CustomizedLanguage_Content 

Use the specified content to assign the custom resource.

Definition at line 202 of file zoom_sdk_def.h.

203{
204
206
208
210};
@ CustomizedLanguage_None
@ CustomizedLanguage_Content
@ CustomizedLanguage_FilePath

◆ FrameDataFormat

Enumeration of video frame data format.

Enumerator
FrameDataFormat_I420_LIMITED 

I420 format with limited (TV) range color space.

FrameDataFormat_I420_FULL 

I420 format with full (PC) range color space.

Definition at line 497 of file zoom_sdk_def.h.

498{
499
501
503};
@ FrameDataFormat_I420_FULL
@ FrameDataFormat_I420_LIMITED

◆ LastErrorType

Enumeration of the last error types of the SDK.

Enumerator
LastErrorType_None 

No error.

LastErrorType_Auth 

Error during verification.

LastErrorType_Login 

Error during login.

LastErrorType_Meeting 

The associated error with the meeting.

LastErrorType_System 

The associated error with the SDK bottom layer.

Definition at line 443 of file zoom_sdk_def.h.

444{
445
447
449
451
453
455};
@ LastErrorType_Auth
@ LastErrorType_Login
@ LastErrorType_System
@ LastErrorType_Meeting
@ LastErrorType_None

◆ SDK_APP_Locale

Enumeration of locale type.

Enumerator
SDK_APP_Locale_Default 
SDK_APP_Locale_CN 

Definition at line 255 of file zoom_sdk_def.h.

256{
259};
@ SDK_APP_Locale_Default
@ SDK_APP_Locale_CN

◆ SDK_LANGUAGE_ID

Enumeration of the text resource type used by the SDK.

Enumerator
LANGUAGE_Unknown 

For initialization.

LANGUAGE_English 

In English.

LANGUAGE_Chinese_Simplified 

In simplified Chinese.

LANGUAGE_Chinese_Traditional 

In traditional Chinese.

LANGUAGE_Japanese 

In Japanese.

LANGUAGE_Spanish 

In Spanish.

LANGUAGE_German 

In German.

LANGUAGE_French 

In French.

LANGUAGE_Portuguese 

In Portuguese.

LANGUAGE_Russian 

In Russian.

LANGUAGE_Korean 

In Korean.

LANGUAGE_Vietnamese 

In Vietnamese.

LANGUAGE_Italian 

In Italian.

LANGUAGE_Polish 

In Polish.

LANGUAGE_Turkish 

In Turkish.

LANGUAGE_Indonesian 

In Indonesian.

LANGUAGE_Dutch 

In Dutch.

LANGUAGE_Swedish 

In Swedish.

Definition at line 125 of file zoom_sdk_def.h.

126{
127
129
131
133
135
137
139
141
143
145
147
149
151
153
155
157
159
161
163};
@ LANGUAGE_Russian
@ LANGUAGE_French
@ LANGUAGE_Chinese_Traditional
@ LANGUAGE_Spanish
@ LANGUAGE_Unknown
@ LANGUAGE_Dutch
@ LANGUAGE_Japanese
@ LANGUAGE_Vietnamese
@ LANGUAGE_Polish
@ LANGUAGE_English
@ LANGUAGE_Italian
@ LANGUAGE_Swedish
@ LANGUAGE_German
@ LANGUAGE_Portuguese
@ LANGUAGE_Indonesian
@ LANGUAGE_Chinese_Simplified
@ LANGUAGE_Korean
@ LANGUAGE_Turkish

◆ SDKError

enum SDKError

Enumeration of common errors of SDK.

Enumerator
SDKERR_SUCCESS 

Success.

SDKERR_NO_IMPL 

The feature is currently invalid.

SDKERR_WRONG_USAGE 

Incorrect usage of the feature.

SDKERR_INVALID_PARAMETER 

Wrong parameter.

SDKERR_MODULE_LOAD_FAILED 

Loading module failed.

SDKERR_MEMORY_FAILED 

No memory is allocated.

SDKERR_SERVICE_FAILED 

Internal service error.

SDKERR_UNINITIALIZE 

Not initialized before the usage.

SDKERR_UNAUTHENTICATION 

Not authorized before the usage.

SDKERR_NORECORDINGINPROCESS 

No recording in process.

SDKERR_TRANSCODER_NOFOUND 

Transcoder module is not found.

SDKERR_VIDEO_NOTREADY 

The video service is not ready.

SDKERR_NO_PERMISSION 

No permission.

SDKERR_UNKNOWN 

Unknown error.

SDKERR_OTHER_SDK_INSTANCE_RUNNING 

The other instance of the SDK is in process.

SDKERR_INTERNAL_ERROR 

SDK internal error.

SDKERR_NO_AUDIODEVICE_ISFOUND 

No audio device found.

SDKERR_NO_VIDEODEVICE_ISFOUND 

No video device found.

SDKERR_TOO_FREQUENT_CALL 

API calls too frequently.

SDKERR_FAIL_ASSIGN_USER_PRIVILEGE 

User can't be assigned with new privilege.

SDKERR_MEETING_DONT_SUPPORT_FEATURE 

The current meeting doesn't support the feature.

SDKERR_MEETING_NOT_SHARE_SENDER 

The current user is not the presenter.

SDKERR_MEETING_YOU_HAVE_NO_SHARE 

There is no sharing.

SDKERR_MEETING_VIEWTYPE_PARAMETER_IS_WRONG 

Incorrect ViewType parameters.

SDKERR_MEETING_ANNOTATION_IS_OFF 

Annotation is disabled.

SDKERR_SETTING_OS_DONT_SUPPORT 

Current OS doesn't support the setting.

SDKERR_EMAIL_LOGIN_IS_DISABLED 

Email login is disable.

SDKERR_HARDWARE_NOT_MEET_FOR_VB 

Computer doesn't meet the minimum requirements to use virtual background feature.

SDKERR_NEED_USER_CONFIRM_RECORD_DISCLAIMER 

Need process disclaimer.

SDKERR_NO_SHARE_DATA 

There is no raw data of sharing.

SDKERR_SHARE_CANNOT_SUBSCRIBE_MYSELF 

Share can not subscribe myself.

SDKERR_NOT_IN_MEETING 

Not in meeting.

SDKERR_NOT_JOIN_AUDIO 

Not Joining audio.

SDKERR_HARDWARE_DONT_SUPPORT 

The current device doesn't support the feature.

SDKERR_DOMAIN_DONT_SUPPORT 

Domain not support.

SDKERR_MEETING_REMOTE_CONTROL_IS_OFF 

Remote control is disabled.

SDKERR_FILETRANSFER_ERROR 

File transfer fail.

Definition at line 43 of file zoom_sdk_def.h.

44{
45
47
49
51
53
55
57
59
61
63
65
67
69
71
73
75
77
79
81
83
85
87
89
91
93
95
97
99
101
103
105
107
109
111
113
115
117
119
120};
@ SDKERR_UNINITIALIZE
@ SDKERR_NO_AUDIODEVICE_ISFOUND
@ SDKERR_NOT_IN_MEETING
@ SDKERR_SUCCESS
@ SDKERR_INTERNAL_ERROR
@ SDKERR_FILETRANSFER_ERROR
@ SDKERR_VIDEO_NOTREADY
@ SDKERR_SETTING_OS_DONT_SUPPORT
@ SDKERR_HARDWARE_NOT_MEET_FOR_VB
@ SDKERR_NO_PERMISSION
@ SDKERR_TRANSCODER_NOFOUND
@ SDKERR_UNKNOWN
@ SDKERR_MEMORY_FAILED
@ SDKERR_SHARE_CANNOT_SUBSCRIBE_MYSELF
@ SDKERR_NO_VIDEODEVICE_ISFOUND
@ SDKERR_EMAIL_LOGIN_IS_DISABLED
@ SDKERR_DOMAIN_DONT_SUPPORT
@ SDKERR_NO_SHARE_DATA
@ SDKERR_TOO_FREQUENT_CALL
@ SDKERR_NEED_USER_CONFIRM_RECORD_DISCLAIMER
@ SDKERR_INVALID_PARAMETER
@ SDKERR_NOT_JOIN_AUDIO
@ SDKERR_NO_IMPL
@ SDKERR_NORECORDINGINPROCESS
@ SDKERR_UNAUTHENTICATION
@ SDKERR_FAIL_ASSIGN_USER_PRIVILEGE
@ SDKERR_WRONG_USAGE
@ SDKERR_MEETING_VIEWTYPE_PARAMETER_IS_WRONG
@ SDKERR_MODULE_LOAD_FAILED
@ SDKERR_MEETING_REMOTE_CONTROL_IS_OFF
@ SDKERR_MEETING_NOT_SHARE_SENDER
@ SDKERR_OTHER_SDK_INSTANCE_RUNNING
@ SDKERR_MEETING_ANNOTATION_IS_OFF
@ SDKERR_SERVICE_FAILED
@ SDKERR_HARDWARE_DONT_SUPPORT
@ SDKERR_MEETING_DONT_SUPPORT_FEATURE
@ SDKERR_MEETING_YOU_HAVE_NO_SHARE

◆ ShareType

enum ShareType

Enumeration of types of shared content.

Enumerator
SHARE_TYPE_UNKNOWN 

Type unknown.

SHARE_TYPE_AS 

Type of sharing the application.

SHARE_TYPE_DS 

Type of sharing the desktop.

SHARE_TYPE_WB 

Type of sharing the white-board.

SHARE_TYPE_AIRHOST 

Type of sharing data from the device connected WIFI.

SHARE_TYPE_CAMERA 

Type of sharing the camera.

SHARE_TYPE_DATA 

Type of sharing the data.

SHARE_TYPE_VIDEO_FILE 

Type of sharing the video file.

SHARE_TYPE_FRAME 

Type of sharing the frame.

SHARE_TYPE_DOCUMENT 

Type of sharing the document.

SHARE_TYPE_COMPUTER_AUDIO 

Type of sharing the computer audio.

Definition at line 414 of file zoom_sdk_def.h.

415{
416
418
420
422
424
426
428
430
432
434
436
438};
@ SHARE_TYPE_AIRHOST
@ SHARE_TYPE_DATA
@ SHARE_TYPE_FRAME
@ SHARE_TYPE_COMPUTER_AUDIO
@ SHARE_TYPE_DS
@ SHARE_TYPE_DOCUMENT
@ SHARE_TYPE_AS
@ SHARE_TYPE_UNKNOWN
@ SHARE_TYPE_VIDEO_FILE
@ SHARE_TYPE_CAMERA
@ SHARE_TYPE_WB

◆ SharingStatus

Enumeration of sharing status.

Enumerator
Sharing_Self_Send_Begin 

Begin to share by the user himself.

Sharing_Self_Send_End 

Stop sharing by the user.

Sharing_Self_Send_Pure_Audio_Begin 

Begin to share pure audio by the user himself.

Sharing_Self_Send_Pure_Audio_End 

Stop sharing pure audio by the user.

Sharing_Other_Share_Begin 

Others begin to share.

Sharing_Other_Share_End 

Others stop sharing.

Sharing_Other_Share_Pure_Audio_Begin 

Others begin to share pure audio.

Sharing_Other_Share_Pure_Audio_End 

Others stop sharing pure audio.

Sharing_View_Other_Sharing 

View the sharing of others.

Sharing_Pause 

Pause sharing.

Sharing_Resume 

Resume sharing.

Definition at line 554 of file zoom_sdk_def.h.

555{
556
558
560
562
564
566
568
570
572
574
576
578};
@ Sharing_Other_Share_Pure_Audio_Begin
@ Sharing_Self_Send_Begin
@ Sharing_Self_Send_Pure_Audio_End
@ Sharing_View_Other_Sharing
@ Sharing_Self_Send_Pure_Audio_Begin
@ Sharing_Other_Share_Pure_Audio_End
@ Sharing_Pause
@ Sharing_Resume
@ Sharing_Self_Send_End
@ Sharing_Other_Share_Begin
@ Sharing_Other_Share_End

◆ ZoomSDKAudioChannel

Enumeration of the audio modes.

Enumerator
ZoomSDKAudioChannel_Mono 

Single channel audio.

ZoomSDKAudioChannel_Stereo 

Stereo audio.

Definition at line 508 of file zoom_sdk_def.h.

509{
510
512
514};
@ ZoomSDKAudioChannel_Stereo
@ ZoomSDKAudioChannel_Mono

◆ ZoomSDKRawDataMemoryMode

Enumeration of memory modes for raw data handling.

Enumerator
ZoomSDKRawDataMemoryModeStack 

Use stack memory.

ZoomSDKRawDataMemoryModeHeap 

Use heap memory.

Definition at line 168 of file zoom_sdk_def.h.

169{
170
172
174};
@ ZoomSDKRawDataMemoryModeStack
@ ZoomSDKRawDataMemoryModeHeap

◆ ZoomSDKRenderPostProcessing

Enumeration of render post processing mode. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066515..

Enumerator
ZoomSDKRenderPostProcessing_None 

For initialization.

ZoomSDKRenderPostProcessing_Auto 

Auto mode.

ZoomSDKRenderPostProcessing_Enable 

Enable post processing.

ZoomSDKRenderPostProcessing_Disable 

Disable post processing.

Definition at line 283 of file zoom_sdk_def.h.

284{
285
287
289
291
293};
@ ZoomSDKRenderPostProcessing_Enable
@ ZoomSDKRenderPostProcessing_Disable
@ ZoomSDKRenderPostProcessing_None
@ ZoomSDKRenderPostProcessing_Auto

◆ ZoomSDKVideoCaptureMethod

Enumeration of video capturing mode. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066515..

Enumerator
ZoomSDKVideoCaptureMethod_None 

For initialization.

ZoomSDKVideoCaptureMethod_Auto 

Auto mode.

ZoomSDKVideoCaptureMethod_DirectSHow 

Direct show mode.

ZoomSDKVideoCaptureMethod_MediaFoundation 

Media foundation mode.

Definition at line 298 of file zoom_sdk_def.h.

299{
300
302
304
306
308};
@ ZoomSDKVideoCaptureMethod_DirectSHow
@ ZoomSDKVideoCaptureMethod_Auto
@ ZoomSDKVideoCaptureMethod_None
@ ZoomSDKVideoCaptureMethod_MediaFoundation

◆ ZoomSDKVideoRenderMode

Enumeration of video render mode. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066515..

Enumerator
ZoomSDKVideoRenderMode_None 

For initialization.

ZoomSDKVideoRenderMode_Auto 

Auto mode.

ZoomSDKVideoRenderMode_D3D11EnableFLIP 

D3D11EnableFLIP mode.

ZoomSDKVideoRenderMode_D3D11 

D3D11 mode.

ZoomSDKVideoRenderMode_D3D9 

D3D9 mode.

ZoomSDKVideoRenderMode_GDI 

GDI mode.

Definition at line 264 of file zoom_sdk_def.h.

265{
266
268
270
272
274
276
278};
@ ZoomSDKVideoRenderMode_None
@ ZoomSDKVideoRenderMode_D3D11
@ ZoomSDKVideoRenderMode_Auto
@ ZoomSDKVideoRenderMode_D3D9
@ ZoomSDKVideoRenderMode_GDI
@ ZoomSDKVideoRenderMode_D3D11EnableFLIP

Variable Documentation

◆ _SDK_TEST_VIDEO_INIT_RECT

const RECT _SDK_TEST_VIDEO_INIT_RECT = {0,0,0,0}

Definition at line 491 of file zoom_sdk_def.h.

491{0,0,0,0};