zoom_video_sdk_def.h File Reference

Zoom Video SDK Common Definition File. More...

#include <iostream>
#include "zoom_video_sdk_platform.h"
#include "zoom_sdk_raw_data_def.h"

Go to the source code of this file.

Data Structures
struct	ZoomVideoSDKExtendParams
	The extended parameters for Zoom Video SDK initialization. More...
struct	ZoomVideoSDKInitParams
	The initialization parameters for Zoom Video SDK. More...
struct	ZoomVideoSDKVideoOption
	Video option used by ZoomVideoSDKSessionContext. More...
struct	ZoomVideoSDKAudioOption
	Aduio option used by ZoomVideoSDKSessionContext. More...
struct	ZoomVideoSDKSessionContext
	Configuration context for joining a Zoom Video SDK session. More...
struct	FileTransferProgress
	The progress information of an ongoing file transfer. More...
struct	ZoomVideoSDKFileStatus
	The status and progress of a file transfer in Zoom Video SDK. More...
class	IZoomVideoSDKFileTransferBaseInfo
	Retrieving basic information about a file transfer in the Zoom Video SDK. More...
class	IZoomVideoSDKSendFile
	Interface for managing a file that is being sent in the Zoom Video SDK. Inherits from IZoomVideoSDKFileTransferBaseInfo. More...
class	IZoomVideoSDKReceiveFile
	Interface for managing a file that is being received in the Zoom Video SDK. Inherits from IZoomVideoSDKFileTransferBaseInfo. More...

Macros
#define	ZOOM_VIDEO_SDK_NAMESPACE   ZOOMVIDEOSDK
#define	BEGIN_ZOOM_VIDEO_SDK_NAMESPACE   namespace ZOOM_VIDEO_SDK_NAMESPACE {
#define	END_ZOOM_VIDEO_SDK_NAMESPACE   };
#define	USING_ZOOM_VIDEO_SDK_NAMESPACE   using namespace ZOOM_VIDEO_SDK_NAMESPACE;

Enumerations
enum	ZoomVideoSDKErrors {   ZoomVideoSDKErrors_Success = 0 , ZoomVideoSDKErrors_Wrong_Usage , ZoomVideoSDKErrors_Internal_Error , ZoomVideoSDKErrors_Uninitialize ,   ZoomVideoSDKErrors_Memory_Error , ZoomVideoSDKErrors_Load_Module_Error , ZoomVideoSDKErrors_UnLoad_Module_Error , ZoomVideoSDKErrors_Invalid_Parameter ,   ZoomVideoSDKErrors_Call_Too_Frequently , ZoomVideoSDKErrors_No_Impl , ZoomVideoSDKErrors_Dont_Support_Feature , ZoomVideoSDKErrors_Unknown ,   ZoomVideoSDKErrors_Remove_Folder_Fail , ZoomVideoSDKErrors_Auth_Error = 1001 , ZoomVideoSDKErrors_Auth_Empty_Key_or_Secret , ZoomVideoSDKErrors_Auth_Wrong_Key_or_Secret ,   ZoomVideoSDKErrors_Auth_DoesNot_Support_SDK , ZoomVideoSDKErrors_Auth_Disable_SDK , ZoomVideoSDKErrors_JoinSession_NoSessionName = 1500 , ZoomVideoSDKErrors_JoinSession_NoSessionToken ,   ZoomVideoSDKErrors_JoinSession_NoUserName , ZoomVideoSDKErrors_JoinSession_Invalid_SessionName , ZoomVideoSDKErrors_JoinSession_Invalid_Password , ZoomVideoSDKErrors_JoinSession_Invalid_SessionToken ,   ZoomVideoSDKErrors_JoinSession_SessionName_TooLong , ZoomVideoSDKErrors_JoinSession_Token_MismatchedSessionName , ZoomVideoSDKErrors_JoinSession_Token_NoSessionName , ZoomVideoSDKErrors_JoinSession_Token_RoleType_EmptyOrWrong ,   ZoomVideoSDKErrors_JoinSession_Token_UserIdentity_TooLong , ZoomVideoSDKErrors_SessionModule_Not_Found = 2001 , ZoomVideoSDKErrors_SessionService_Invalid , ZoomVideoSDKErrors_Session_Join_Failed ,   ZoomVideoSDKErrors_Session_No_Rights , ZoomVideoSDKErrors_Session_Already_In_Progress , ZoomVideoSDKErrors_Session_Dont_Support_SessionType , ZoomVideoSDKErrors_Session_Reconnecting ,   ZoomVideoSDKErrors_Session_Disconnecting , ZoomVideoSDKErrors_Session_Not_Started , ZoomVideoSDKErrors_Session_Need_Password , ZoomVideoSDKErrors_Session_Password_Wrong ,   ZoomVideoSDKErrors_Session_Remote_DB_Error , ZoomVideoSDKErrors_Session_Invalid_Param , ZoomVideoSDKErrors_Session_Client_Incompatible , ZoomVideoSDKErrors_Session_Account_FreeMinutesExceeded ,   ZoomVideoSDKErrors_Session_Audio_Error = 3000 , ZoomVideoSDKErrors_Session_Audio_No_Microphone , ZoomVideoSDKErrors_Session_Audio_No_Speaker , ZoomVideoSDKErrors_Session_Video_Error = 4000 ,   ZoomVideoSDKErrors_Session_Video_Device_Error , ZoomVideoSDKErrors_Session_Live_Stream_Error = 5000 , ZoomVideoSDKErrors_Session_Phone_Error = 5500 , ZoomVideoSDKErrors_RAWDATA_MALLOC_FAILED = 6001 ,   ZoomVideoSDKErrors_RAWDATA_NOT_IN_Session , ZoomVideoSDKErrors_RAWDATA_NO_LICENSE , ZoomVideoSDKErrors_RAWDATA_VIDEO_MODULE_NOT_READY , ZoomVideoSDKErrors_RAWDATA_VIDEO_MODULE_ERROR ,   ZoomVideoSDKErrors_RAWDATA_VIDEO_DEVICE_ERROR , ZoomVideoSDKErrors_RAWDATA_NO_VIDEO_DATA , ZoomVideoSDKErrors_RAWDATA_SHARE_MODULE_NOT_READY , ZoomVideoSDKErrors_RAWDATA_SHARE_MODULE_ERROR ,   ZoomVideoSDKErrors_RAWDATA_NO_SHARE_DATA , ZoomVideoSDKErrors_RAWDATA_AUDIO_MODULE_NOT_READY , ZoomVideoSDKErrors_RAWDATA_AUDIO_MODULE_ERROR , ZoomVideoSDKErrors_RAWDATA_NO_AUDIO_DATA ,   ZoomVideoSDKErrors_RAWDATA_PREPROCESS_RAWDATA_ERROR , ZoomVideoSDKErrors_RAWDATA_NO_DEVICE_RUNNING , ZoomVideoSDKErrors_RAWDATA_INIT_DEVICE , ZoomVideoSDKErrors_RAWDATA_VIRTUAL_DEVICE ,   ZoomVideoSDKErrors_RAWDATA_CANNOT_CHANGE_VIRTUAL_DEVICE_IN_PREVIEW , ZoomVideoSDKErrors_RAWDATA_INTERNAL_ERROR , ZoomVideoSDKErrors_RAWDATA_SEND_TOO_MUCH_DATA_IN_SINGLE_TIME , ZoomVideoSDKErrors_RAWDATA_SEND_TOO_FREQUENTLY ,   ZoomVideoSDKErrors_RAWDATA_VIRTUAL_MIC_IS_TERMINATE , ZoomVideoSDKErrors_Session_Share_Error = 7001 , ZoomVideoSDKErrors_Session_Share_Module_Not_Ready , ZoomVideoSDKErrors_Session_Share_You_Are_Not_Sharing ,   ZoomVideoSDKErrors_Session_Share_Type_Is_Not_Support , ZoomVideoSDKErrors_Session_Share_Internal_Error , ZoomVideoSDKErrors_Dont_Support_Multi_Stream_Video_User , ZoomVideoSDKErrors_Fail_Assign_User_Privilege ,   ZoomVideoSDKErrors_No_Recording_In_Process , ZoomVideoSDKErrors_Set_Virtual_Background_Fail , ZoomVideoSDKErrors_Session_Share_Camera_Video_Not_Start , ZoomVideoSDKErrors_Session_Share_Camera_Conflict_With_Video_Effects ,   ZoomVideoSDKErrors_Filetransfer_UnknowError = 7500 , ZoomVideoSDKErrors_Filetransfer_FileTypeBlocked , ZoomVideoSDKErrors_Filetransfer_FileSizelimited , ZoomVideoSDKErrors_Spotlight_NotEnoughUsers = 7600 ,   ZoomVideoSDKErrors_Spotlight_ToMuchSpotlightedUsers , ZoomVideoSDKErrors_Spotlight_UserCannotBeSpotlighted , ZoomVideoSDKErrors_Spotlight_UserWithoutVideo , ZoomVideoSDKErrors_Spotlight_UserNotSpotlighted }
	Enumeration of common Zoom Video SDK errors. More...
enum	ZoomVideoSDKSessionLeaveReason {   ZoomVideoSDKSessionLeaveReason_Unknown = 0 , ZoomVideoSDKSessionLeaveReason_BySelf , ZoomVideoSDKSessionLeaveReason_KickByHost , ZoomVideoSDKSessionLeaveReason_EndByHost ,   ZoomVideoSDKSessionLeaveReason_NetworkError }
	Enumeration of session leave reasons in Zoom Video SDK. More...
enum	ZoomVideoSDKShareStatus {   ZoomVideoSDKShareStatus_None , ZoomVideoSDKShareStatus_Start , ZoomVideoSDKShareStatus_Pause , ZoomVideoSDKShareStatus_Resume ,   ZoomVideoSDKShareStatus_Stop }
	Enumeration of sharing status in Zoom Video SDK. More...
enum	ZoomVideoSDKShareType { ZoomVideoSDKShareType_None , ZoomVideoSDKShareType_Normal , ZoomVideoSDKShareType_PureAudio , ZoomVideoSDKShareType_Camera }
	Enumeration of sharing types in Zoom Video SDK. More...
enum	ZoomVideoSDKLiveStreamStatus {   ZoomVideoSDKLiveStreamStatus_None , ZoomVideoSDKLiveStreamStatus_InProgress , ZoomVideoSDKLiveStreamStatus_Connecting , ZoomVideoSDKLiveStreamStatus_FailedTimeout ,   ZoomVideoSDKLiveStreamStatus_StartFailed , ZoomVideoSDKLiveStreamStatus_Ended }
	Enumeration of live streaming status in Zoom Video SDK. More...
enum	ZoomVideoSDKRawDataMemoryMode { ZoomVideoSDKRawDataMemoryModeStack = 0 , ZoomVideoSDKRawDataMemoryModeHeap }
	Enumeration of raw data memory mode in Zoom Video SDK. More...
enum	ZoomVideoSDKRawDataType { RAW_DATA_TYPE_VIDEO = 0 , RAW_DATA_TYPE_SHARE }
	Enumeration of raw data types in Zoom Video SDK. More...
enum	ZoomVideoSDKCameraControlRequestType { ZoomVideoSDKCameraControlRequestType_RequestControl = 0 , ZoomVideoSDKCameraControlRequestType_GiveUpControl }
	Enumeration of camera control request types in Zoom Video SDK. More...
enum	ZoomVideoSDKRemoteControlStatus {   ZoomVideoSDKRemoteControlStatus_None = 0 , ZoomVideoSDKRemoteControlStatus_CanRequestControl , ZoomVideoSDKRemoteControlStatus_RequestDenied , ZoomVideoSDKRemoteControlStatus_GotControl ,   ZoomVideoSDKRemoteControlStatus_LostControl , ZoomVideoSDKRemoteControlStatus_ControlStart , ZoomVideoSDKRemoteControlStatus_ControlStop , ZoomVideoSDKRemoteControlStatus_GiveControlTo ,   ZoomVideoSDKRemoteControlStatus_ControlRevoked , ZoomVideoSDKRemoteControlStatus_ControlledBy , ZoomVideoSDKRemoteControlStatus_NotControlled }
	Enumeration of remote control status in Zoom Video SDK. More...
enum	RecordingStatus { Recording_Start , Recording_Stop , Recording_DiskFull , Recording_Pause }
	Enumeration representing the status of recording. More...
enum	ZoomVideoSDK_TESTMIC_STATUS { ZoomVideoSDKMic_CanTest = 0 , ZoomVideoSDKMic_Recording , ZoomVideoSDKMic_CanPlay }
	Enumeration of the microphone test status in Zoom Video SDK. More...
enum	FrameDataFormat { FrameDataFormat_I420_LIMITED , FrameDataFormat_I420_FULL }
	Enumeration of specifying the format of frame data. More...
enum	FileTransferStatus {   FileTransferState_None = 0 , FileTransferState_ReadyToTransfer , FileTransferState_Transfering , FileTransferState_TransferFailed ,   FileTransferState_TransferDone }
	Enumeration representing the status of a file transfer. More...
enum	ZoomVideoSDKAudioChannel { ZoomVideoSDKAudioChannel_Mono , ZoomVideoSDKAudioChannel_Stereo }
	Enumeration of audio channel type in Zoom Video SDK. More...
enum	ZoomVideoSDKSessionType { ZoomVideoSDKSessionType_MainSession = 0 , ZoomVideoSDKSessionType_SubSession }
	Enumeration of Zoom Video SDK session types. More...

Detailed Description

Zoom Video SDK Common Definition File.

Definition in file zoom_video_sdk_def.h.

Macro Definition Documentation

BEGIN_ZOOM_VIDEO_SDK_NAMESPACE

#define BEGIN_ZOOM_VIDEO_SDK_NAMESPACE   namespace ZOOM_VIDEO_SDK_NAMESPACE {

Definition at line 14 of file zoom_video_sdk_def.h.

END_ZOOM_VIDEO_SDK_NAMESPACE

#define END_ZOOM_VIDEO_SDK_NAMESPACE   };

Definition at line 15 of file zoom_video_sdk_def.h.

USING_ZOOM_VIDEO_SDK_NAMESPACE

#define USING_ZOOM_VIDEO_SDK_NAMESPACE   using namespace ZOOM_VIDEO_SDK_NAMESPACE;

Definition at line 16 of file zoom_video_sdk_def.h.

ZOOM_VIDEO_SDK_NAMESPACE

#define ZOOM_VIDEO_SDK_NAMESPACE   ZOOMVIDEOSDK

Definition at line 13 of file zoom_video_sdk_def.h.

Enumeration Type Documentation

FileTransferStatus

enum FileTransferStatus

Enumeration representing the status of a file transfer.

Enumerator
FileTransferState_None	No file transfer activity is currently occurring.
FileTransferState_ReadyToTransfer	The file is ready to begin transfer.
FileTransferState_Transfering	The file transfer is currently in progress.
FileTransferState_TransferFailed	The file transfer has failed.
FileTransferState_TransferDone	The file transfer completed successfully.

Definition at line 584 of file zoom_video_sdk_def.h.

{
 
    FileTransferState_None = 0, 
 
    FileTransferState_ReadyToTransfer, 
 
    FileTransferState_Transfering, 
 
    FileTransferState_TransferFailed, 
 
    FileTransferState_TransferDone, 
}FileTransferStatus;

FrameDataFormat

enum FrameDataFormat

Enumeration of specifying the format of frame data.

Enumerator
FrameDataFormat_I420_LIMITED	I420 format with limited (TV) range. Commonly used in video broadcasting and streaming.
FrameDataFormat_I420_FULL	I420 format with full (PC) range. Provides full-range color values, typically used in computer graphics.

Definition at line 567 of file zoom_video_sdk_def.h.

{
 
    FrameDataFormat_I420_LIMITED,
 
    FrameDataFormat_I420_FULL,
};

RecordingStatus

enum RecordingStatus

Enumeration representing the status of recording.

Enumerator
Recording_Start	The recording has successfully started or resumed.
Recording_Stop	The recording has been stopped.
Recording_DiskFull	The recording failed due to insufficient disk space.
Recording_Pause	The recording has been paused.

Definition at line 346 of file zoom_video_sdk_def.h.

{
 
    Recording_Start,
 
    Recording_Stop,
 
    Recording_DiskFull,
 
    Recording_Pause,
};

ZoomVideoSDK_TESTMIC_STATUS

enum ZoomVideoSDK_TESTMIC_STATUS

Enumeration of the microphone test status in Zoom Video SDK.

Enumerator
ZoomVideoSDKMic_CanTest	Test the mic via TestMicStartRecording. It is useless to call TestMicStopTesting/TestMicPlayRecording in this status.
ZoomVideoSDKMic_Recording	Test the mic via TestMicStopTesting/TestMicPlayRecording. It is useless to call TestMicStartRecording in this status.
ZoomVideoSDKMic_CanPlay	Test the mic via TestMicStopTesting/TestMicPlayRecording. It is useless call TestMicStartRecording in this status.

Definition at line 361 of file zoom_video_sdk_def.h.

{
 
    ZoomVideoSDKMic_CanTest = 0,
 
    ZoomVideoSDKMic_Recording,
 
    ZoomVideoSDKMic_CanPlay,
}ZoomVideoSDK_TESTMIC_STATUS;

ZoomVideoSDKAudioChannel

enum ZoomVideoSDKAudioChannel

Enumeration of audio channel type in Zoom Video SDK.

Enumerator
ZoomVideoSDKAudioChannel_Mono	Mono audio channel.
ZoomVideoSDKAudioChannel_Stereo	Stereo audio channel.

Definition at line 725 of file zoom_video_sdk_def.h.

{
 
    ZoomVideoSDKAudioChannel_Mono,
 
    ZoomVideoSDKAudioChannel_Stereo,
};

ZoomVideoSDKCameraControlRequestType

enum ZoomVideoSDKCameraControlRequestType

Enumeration of camera control request types in Zoom Video SDK.

Enumerator
ZoomVideoSDKCameraControlRequestType_RequestControl	Request camera control.
ZoomVideoSDKCameraControlRequestType_GiveUpControl	Give up camera control.

Definition at line 305 of file zoom_video_sdk_def.h.

{
 
    ZoomVideoSDKCameraControlRequestType_RequestControl = 0,
 
    ZoomVideoSDKCameraControlRequestType_GiveUpControl
    
}ZoomVideoSDKCameraControlRequestType;

ZoomVideoSDKErrors

enum ZoomVideoSDKErrors

Enumeration of common Zoom Video SDK errors.

Enumerator
ZoomVideoSDKErrors_Success	Success.
ZoomVideoSDKErrors_Wrong_Usage	Incorrect usage of the feature.
ZoomVideoSDKErrors_Internal_Error	Internal SDK error.
ZoomVideoSDKErrors_Uninitialize	SDK is not initialized before usage.
ZoomVideoSDKErrors_Memory_Error	No memory is allocated or memory allocation failed.
ZoomVideoSDKErrors_Load_Module_Error	Failed to load module.
ZoomVideoSDKErrors_UnLoad_Module_Error	Failed to unload module.
ZoomVideoSDKErrors_Invalid_Parameter	Invalid parameter passed to a function.
ZoomVideoSDKErrors_Call_Too_Frequently	API is being called too frequently.
ZoomVideoSDKErrors_No_Impl	The requested feature is not implemented.
ZoomVideoSDKErrors_Dont_Support_Feature	The current session does not support the feature.
ZoomVideoSDKErrors_Unknown	Unknown error occurred.
ZoomVideoSDKErrors_Remove_Folder_Fail	Failed to remove folder.
ZoomVideoSDKErrors_Auth_Error	General authorization failure.
ZoomVideoSDKErrors_Auth_Empty_Key_or_Secret	Authorization failed due to missing key or secret.
ZoomVideoSDKErrors_Auth_Wrong_Key_or_Secret	Authorization failed due to invalid key or secret.
ZoomVideoSDKErrors_Auth_DoesNot_Support_SDK	Authorization does not support SDK.
ZoomVideoSDKErrors_Auth_Disable_SDK	Authorization disable SDK.
ZoomVideoSDKErrors_JoinSession_NoSessionName	Session name is missing when joining session.
ZoomVideoSDKErrors_JoinSession_NoSessionToken	Session token is missing when joining session.
ZoomVideoSDKErrors_JoinSession_NoUserName	User name is missing when joining session.
ZoomVideoSDKErrors_JoinSession_Invalid_SessionName	Session name is invalid.
ZoomVideoSDKErrors_JoinSession_Invalid_Password	Session password is invalid.
ZoomVideoSDKErrors_JoinSession_Invalid_SessionToken	Session token is invalid.
ZoomVideoSDKErrors_JoinSession_SessionName_TooLong	Session name exceeds the allowed length.
ZoomVideoSDKErrors_JoinSession_Token_MismatchedSessionName	Token does not match the session name.
ZoomVideoSDKErrors_JoinSession_Token_NoSessionName	Token does not include session name.
ZoomVideoSDKErrors_JoinSession_Token_RoleType_EmptyOrWrong	Token has empty or invalid role type.
ZoomVideoSDKErrors_JoinSession_Token_UserIdentity_TooLong	Token includes a user identity that is too long.
ZoomVideoSDKErrors_SessionModule_Not_Found	Failed to find session module.
ZoomVideoSDKErrors_SessionService_Invalid	Invalid session service.
ZoomVideoSDKErrors_Session_Join_Failed	Failed to join the session.
ZoomVideoSDKErrors_Session_No_Rights	User does not have the rights to join the session.
ZoomVideoSDKErrors_Session_Already_In_Progress	Session is already in progress.
ZoomVideoSDKErrors_Session_Dont_Support_SessionType	The current session type is not supported.
ZoomVideoSDKErrors_Session_Reconnecting	SDK is reconnecting to the session.
ZoomVideoSDKErrors_Session_Disconnecting	SDK is disconnecting from the session.
ZoomVideoSDKErrors_Session_Not_Started	Session has not started yet.
ZoomVideoSDKErrors_Session_Need_Password	Session requires a password.
ZoomVideoSDKErrors_Session_Password_Wrong	Incorrect session password.
ZoomVideoSDKErrors_Session_Remote_DB_Error	Error from remote database.
ZoomVideoSDKErrors_Session_Invalid_Param	Invalid session parameter.
ZoomVideoSDKErrors_Session_Client_Incompatible	Client is incompatible with the session.
ZoomVideoSDKErrors_Session_Account_FreeMinutesExceeded	Session ended due to exceeding free minutes.
ZoomVideoSDKErrors_Session_Audio_Error	Audio module error.
ZoomVideoSDKErrors_Session_Audio_No_Microphone	No microphone detected.
ZoomVideoSDKErrors_Session_Audio_No_Speaker	No speaker detected.
ZoomVideoSDKErrors_Session_Video_Error	General video error.
ZoomVideoSDKErrors_Session_Video_Device_Error	Video device error.
ZoomVideoSDKErrors_Session_Live_Stream_Error	Live stream error.
ZoomVideoSDKErrors_Session_Phone_Error	Phone connection error.
ZoomVideoSDKErrors_RAWDATA_MALLOC_FAILED	Failed to allocate memory for raw data.
ZoomVideoSDKErrors_RAWDATA_NOT_IN_Session	Not in a session for raw data access.
ZoomVideoSDKErrors_RAWDATA_NO_LICENSE	No raw data license available.
ZoomVideoSDKErrors_RAWDATA_VIDEO_MODULE_NOT_READY	Video module not ready for raw data.
ZoomVideoSDKErrors_RAWDATA_VIDEO_MODULE_ERROR	Video module error.
ZoomVideoSDKErrors_RAWDATA_VIDEO_DEVICE_ERROR	Video device error.
ZoomVideoSDKErrors_RAWDATA_NO_VIDEO_DATA	No video data available.
ZoomVideoSDKErrors_RAWDATA_SHARE_MODULE_NOT_READY	Share module not ready.
ZoomVideoSDKErrors_RAWDATA_SHARE_MODULE_ERROR	Share module error.
ZoomVideoSDKErrors_RAWDATA_NO_SHARE_DATA	No shared data available.
ZoomVideoSDKErrors_RAWDATA_AUDIO_MODULE_NOT_READY	Audio module not ready.
ZoomVideoSDKErrors_RAWDATA_AUDIO_MODULE_ERROR	Audio module error.
ZoomVideoSDKErrors_RAWDATA_NO_AUDIO_DATA	No audio data available.
ZoomVideoSDKErrors_RAWDATA_PREPROCESS_RAWDATA_ERROR	Raw data preprocessing error.
ZoomVideoSDKErrors_RAWDATA_NO_DEVICE_RUNNING	No media device is currently running.
ZoomVideoSDKErrors_RAWDATA_INIT_DEVICE	Failed to initialize media device.
ZoomVideoSDKErrors_RAWDATA_VIRTUAL_DEVICE	Using a virtual device.
ZoomVideoSDKErrors_RAWDATA_CANNOT_CHANGE_VIRTUAL_DEVICE_IN_PREVIEW	Cannot change virtual device during preview.
ZoomVideoSDKErrors_RAWDATA_INTERNAL_ERROR	Internal raw data error.
ZoomVideoSDKErrors_RAWDATA_SEND_TOO_MUCH_DATA_IN_SINGLE_TIME	Sending too much raw data in a single call.
ZoomVideoSDKErrors_RAWDATA_SEND_TOO_FREQUENTLY	Sending raw data too frequently.
ZoomVideoSDKErrors_RAWDATA_VIRTUAL_MIC_IS_TERMINATE	Virtual microphone has been terminated.
ZoomVideoSDKErrors_Session_Share_Error	General share error.
ZoomVideoSDKErrors_Session_Share_Module_Not_Ready	Share module is not ready.
ZoomVideoSDKErrors_Session_Share_You_Are_Not_Sharing	You are not sharing.
ZoomVideoSDKErrors_Session_Share_Type_Is_Not_Support	Share type is not supported.
ZoomVideoSDKErrors_Session_Share_Internal_Error	Internal sharing error.
ZoomVideoSDKErrors_Dont_Support_Multi_Stream_Video_User	Multi-stream video users are not supported.
ZoomVideoSDKErrors_Fail_Assign_User_Privilege	Failed to assign user privilege.
ZoomVideoSDKErrors_No_Recording_In_Process	No recording in process.
ZoomVideoSDKErrors_Set_Virtual_Background_Fail	Failed to set virtual background.
ZoomVideoSDKErrors_Session_Share_Camera_Video_Not_Start	Failed to start camera share due to video not started.
ZoomVideoSDKErrors_Session_Share_Camera_Conflict_With_Video_Effects	Camera share conflicts with video effects.
ZoomVideoSDKErrors_Filetransfer_UnknowError	Unknown file transfer error.
ZoomVideoSDKErrors_Filetransfer_FileTypeBlocked	File type is blocked for transfer.
ZoomVideoSDKErrors_Filetransfer_FileSizelimited	File size exceeds the transfer limit.
ZoomVideoSDKErrors_Spotlight_NotEnoughUsers	Not enough users for spotlighting.
ZoomVideoSDKErrors_Spotlight_ToMuchSpotlightedUsers	Too many users are spotlighted.
ZoomVideoSDKErrors_Spotlight_UserCannotBeSpotlighted	User cannot be spotlighted.
ZoomVideoSDKErrors_Spotlight_UserWithoutVideo	User does not have video to be spotlighted.
ZoomVideoSDKErrors_Spotlight_UserNotSpotlighted	User is not currently spotlighted.

Definition at line 22 of file zoom_video_sdk_def.h.

{ 
 
    ZoomVideoSDKErrors_Success = 0,
 
    ZoomVideoSDKErrors_Wrong_Usage,
 
    ZoomVideoSDKErrors_Internal_Error,
 
    ZoomVideoSDKErrors_Uninitialize,
 
    ZoomVideoSDKErrors_Memory_Error,
 
    ZoomVideoSDKErrors_Load_Module_Error,
 
    ZoomVideoSDKErrors_UnLoad_Module_Error,
 
    ZoomVideoSDKErrors_Invalid_Parameter,
 
    ZoomVideoSDKErrors_Call_Too_Frequently,
 
    ZoomVideoSDKErrors_No_Impl,
 
    ZoomVideoSDKErrors_Dont_Support_Feature,
 
    ZoomVideoSDKErrors_Unknown,
 
    ZoomVideoSDKErrors_Remove_Folder_Fail,
 
    ZoomVideoSDKErrors_Auth_Error = 1001,
 
    ZoomVideoSDKErrors_Auth_Empty_Key_or_Secret,
 
    ZoomVideoSDKErrors_Auth_Wrong_Key_or_Secret,
 
    ZoomVideoSDKErrors_Auth_DoesNot_Support_SDK,
 
    ZoomVideoSDKErrors_Auth_Disable_SDK,
 
    ZoomVideoSDKErrors_JoinSession_NoSessionName = 1500,
 
    ZoomVideoSDKErrors_JoinSession_NoSessionToken,
 
    ZoomVideoSDKErrors_JoinSession_NoUserName,
 
    ZoomVideoSDKErrors_JoinSession_Invalid_SessionName,
 
    ZoomVideoSDKErrors_JoinSession_Invalid_Password,
 
    ZoomVideoSDKErrors_JoinSession_Invalid_SessionToken,
 
    ZoomVideoSDKErrors_JoinSession_SessionName_TooLong,
 
    ZoomVideoSDKErrors_JoinSession_Token_MismatchedSessionName,
 
    ZoomVideoSDKErrors_JoinSession_Token_NoSessionName,
 
    ZoomVideoSDKErrors_JoinSession_Token_RoleType_EmptyOrWrong,
 
    ZoomVideoSDKErrors_JoinSession_Token_UserIdentity_TooLong,
 
    ZoomVideoSDKErrors_SessionModule_Not_Found = 2001,
 
    ZoomVideoSDKErrors_SessionService_Invalid,
 
    ZoomVideoSDKErrors_Session_Join_Failed,
 
    ZoomVideoSDKErrors_Session_No_Rights,
 
    ZoomVideoSDKErrors_Session_Already_In_Progress,
 
    ZoomVideoSDKErrors_Session_Dont_Support_SessionType,
 
    ZoomVideoSDKErrors_Session_Reconnecting,
 
    ZoomVideoSDKErrors_Session_Disconnecting,
 
    ZoomVideoSDKErrors_Session_Not_Started,
 
    ZoomVideoSDKErrors_Session_Need_Password,
 
    ZoomVideoSDKErrors_Session_Password_Wrong,
 
    ZoomVideoSDKErrors_Session_Remote_DB_Error,
 
    ZoomVideoSDKErrors_Session_Invalid_Param,
 
    ZoomVideoSDKErrors_Session_Client_Incompatible,
 
    ZoomVideoSDKErrors_Session_Account_FreeMinutesExceeded,
 
    ZoomVideoSDKErrors_Session_Audio_Error = 3000,
 
    ZoomVideoSDKErrors_Session_Audio_No_Microphone,
 
    ZoomVideoSDKErrors_Session_Audio_No_Speaker,
 
    ZoomVideoSDKErrors_Session_Video_Error = 4000,
 
    ZoomVideoSDKErrors_Session_Video_Device_Error,
 
    ZoomVideoSDKErrors_Session_Live_Stream_Error = 5000,
 
    ZoomVideoSDKErrors_Session_Phone_Error = 5500,
 
 
    ZoomVideoSDKErrors_RAWDATA_MALLOC_FAILED = 6001,
 
    ZoomVideoSDKErrors_RAWDATA_NOT_IN_Session,
 
    ZoomVideoSDKErrors_RAWDATA_NO_LICENSE,
 
    ZoomVideoSDKErrors_RAWDATA_VIDEO_MODULE_NOT_READY,
 
    ZoomVideoSDKErrors_RAWDATA_VIDEO_MODULE_ERROR,
 
    ZoomVideoSDKErrors_RAWDATA_VIDEO_DEVICE_ERROR,
 
    ZoomVideoSDKErrors_RAWDATA_NO_VIDEO_DATA,
 
    ZoomVideoSDKErrors_RAWDATA_SHARE_MODULE_NOT_READY,
 
    ZoomVideoSDKErrors_RAWDATA_SHARE_MODULE_ERROR,
 
    ZoomVideoSDKErrors_RAWDATA_NO_SHARE_DATA,
 
    ZoomVideoSDKErrors_RAWDATA_AUDIO_MODULE_NOT_READY,
 
    ZoomVideoSDKErrors_RAWDATA_AUDIO_MODULE_ERROR,
 
    ZoomVideoSDKErrors_RAWDATA_NO_AUDIO_DATA,
 
    ZoomVideoSDKErrors_RAWDATA_PREPROCESS_RAWDATA_ERROR,
 
    ZoomVideoSDKErrors_RAWDATA_NO_DEVICE_RUNNING,
 
    ZoomVideoSDKErrors_RAWDATA_INIT_DEVICE,
 
    ZoomVideoSDKErrors_RAWDATA_VIRTUAL_DEVICE,
 
    ZoomVideoSDKErrors_RAWDATA_CANNOT_CHANGE_VIRTUAL_DEVICE_IN_PREVIEW,
 
    ZoomVideoSDKErrors_RAWDATA_INTERNAL_ERROR,
 
    ZoomVideoSDKErrors_RAWDATA_SEND_TOO_MUCH_DATA_IN_SINGLE_TIME,
 
    ZoomVideoSDKErrors_RAWDATA_SEND_TOO_FREQUENTLY,
 
    ZoomVideoSDKErrors_RAWDATA_VIRTUAL_MIC_IS_TERMINATE,
 
    ZoomVideoSDKErrors_Session_Share_Error = 7001,
 
    ZoomVideoSDKErrors_Session_Share_Module_Not_Ready,
 
    ZoomVideoSDKErrors_Session_Share_You_Are_Not_Sharing,
 
    ZoomVideoSDKErrors_Session_Share_Type_Is_Not_Support,
 
    ZoomVideoSDKErrors_Session_Share_Internal_Error,
 
    ZoomVideoSDKErrors_Dont_Support_Multi_Stream_Video_User,
 
    ZoomVideoSDKErrors_Fail_Assign_User_Privilege,
 
    ZoomVideoSDKErrors_No_Recording_In_Process,
 
    ZoomVideoSDKErrors_Set_Virtual_Background_Fail,
 
    ZoomVideoSDKErrors_Session_Share_Camera_Video_Not_Start,
 
    ZoomVideoSDKErrors_Session_Share_Camera_Conflict_With_Video_Effects,
 
    ZoomVideoSDKErrors_Filetransfer_UnknowError = 7500,
 
    ZoomVideoSDKErrors_Filetransfer_FileTypeBlocked,
 
    ZoomVideoSDKErrors_Filetransfer_FileSizelimited,
 
    ZoomVideoSDKErrors_Spotlight_NotEnoughUsers = 7600,
 
    ZoomVideoSDKErrors_Spotlight_ToMuchSpotlightedUsers,
 
    ZoomVideoSDKErrors_Spotlight_UserCannotBeSpotlighted,
 
    ZoomVideoSDKErrors_Spotlight_UserWithoutVideo,
 
    ZoomVideoSDKErrors_Spotlight_UserNotSpotlighted
 
}ZoomVideoSDKErrors;

ZoomVideoSDKLiveStreamStatus

enum ZoomVideoSDKLiveStreamStatus

Enumeration of live streaming status in Zoom Video SDK.

Enumerator
ZoomVideoSDKLiveStreamStatus_None	No live streaming activity.
ZoomVideoSDKLiveStreamStatus_InProgress	Live streaming is currently in progress.
ZoomVideoSDKLiveStreamStatus_Connecting	Live streaming is connecting.
ZoomVideoSDKLiveStreamStatus_FailedTimeout	Live streaming failed due to timeout.
ZoomVideoSDKLiveStreamStatus_StartFailed	Live streaming failed to start.
ZoomVideoSDKLiveStreamStatus_Ended	Live streaming has ended.

Definition at line 264 of file zoom_video_sdk_def.h.

{
 
    ZoomVideoSDKLiveStreamStatus_None,
 
    ZoomVideoSDKLiveStreamStatus_InProgress,
 
    ZoomVideoSDKLiveStreamStatus_Connecting,
 
    ZoomVideoSDKLiveStreamStatus_FailedTimeout,
 
    ZoomVideoSDKLiveStreamStatus_StartFailed,
 
    ZoomVideoSDKLiveStreamStatus_Ended,
}ZoomVideoSDKLiveStreamStatus;

ZoomVideoSDKRawDataMemoryMode

enum ZoomVideoSDKRawDataMemoryMode

Enumeration of raw data memory mode in Zoom Video SDK.

Enumerator
ZoomVideoSDKRawDataMemoryModeStack	Raw data is allocated on the stack.
ZoomVideoSDKRawDataMemoryModeHeap	Raw data is allocated on the heap.

Definition at line 283 of file zoom_video_sdk_def.h.

{
 
    ZoomVideoSDKRawDataMemoryModeStack = 0,
 
    ZoomVideoSDKRawDataMemoryModeHeap,
}ZoomVideoSDKRawDataMemoryMode;

ZoomVideoSDKRawDataType

enum ZoomVideoSDKRawDataType

Enumeration of raw data types in Zoom Video SDK.

Enumerator
RAW_DATA_TYPE_VIDEO	Raw video data.
RAW_DATA_TYPE_SHARE	Raw share data (e.g., screen or application).

Definition at line 294 of file zoom_video_sdk_def.h.

{
 
    RAW_DATA_TYPE_VIDEO = 0,
 
    RAW_DATA_TYPE_SHARE,
}ZoomVideoSDKRawDataType;

ZoomVideoSDKRemoteControlStatus

enum ZoomVideoSDKRemoteControlStatus

Enumeration of remote control status in Zoom Video SDK.

Enumerator
ZoomVideoSDKRemoteControlStatus_None	For initialization.
ZoomVideoSDKRemoteControlStatus_CanRequestControl	Remote control information. I can enable the remote control.
ZoomVideoSDKRemoteControlStatus_RequestDenied	Remote control information. I have received a refused information of remote control.
ZoomVideoSDKRemoteControlStatus_GotControl	The authority of remote control. I get control when remote control begins.
ZoomVideoSDKRemoteControlStatus_LostControl	The authority of remote control. I lose control when remote control ends.
ZoomVideoSDKRemoteControlStatus_ControlStart	The status of remote control. I am remotely controlling another.
ZoomVideoSDKRemoteControlStatus_ControlStop	The status of remote control. I am not remotely controlling another.
ZoomVideoSDKRemoteControlStatus_GiveControlTo	The status of remote control. I can be controlled by the specified user.
ZoomVideoSDKRemoteControlStatus_ControlRevoked	The status of remote control. I have revoked remote control.
ZoomVideoSDKRemoteControlStatus_ControlledBy	The status of remote control. I am being controlled by the specified user.
ZoomVideoSDKRemoteControlStatus_NotControlled	The status of remote control. I am not being controlled.

Definition at line 317 of file zoom_video_sdk_def.h.

{
 
    ZoomVideoSDKRemoteControlStatus_None = 0,           
 
    ZoomVideoSDKRemoteControlStatus_CanRequestControl,      
 
    ZoomVideoSDKRemoteControlStatus_RequestDenied,  
 
    ZoomVideoSDKRemoteControlStatus_GotControl,         
 
    ZoomVideoSDKRemoteControlStatus_LostControl,        
 
    ZoomVideoSDKRemoteControlStatus_ControlStart,       
 
    ZoomVideoSDKRemoteControlStatus_ControlStop,        
 
    ZoomVideoSDKRemoteControlStatus_GiveControlTo,      
 
    ZoomVideoSDKRemoteControlStatus_ControlRevoked,     
 
    ZoomVideoSDKRemoteControlStatus_ControlledBy,       
 
    ZoomVideoSDKRemoteControlStatus_NotControlled,      
};

ZoomVideoSDKSessionLeaveReason

enum ZoomVideoSDKSessionLeaveReason

Enumeration of session leave reasons in Zoom Video SDK.

Enumerator
ZoomVideoSDKSessionLeaveReason_Unknown	Unknown reason for leaving the session.
ZoomVideoSDKSessionLeaveReason_BySelf	User left the session by themselves.
ZoomVideoSDKSessionLeaveReason_KickByHost	User was removed from the session by the host.
ZoomVideoSDKSessionLeaveReason_EndByHost	Host ended the session.
ZoomVideoSDKSessionLeaveReason_NetworkError	User was disconnected due to network error.

Definition at line 215 of file zoom_video_sdk_def.h.

{
 
    ZoomVideoSDKSessionLeaveReason_Unknown = 0,
 
    ZoomVideoSDKSessionLeaveReason_BySelf,
 
    ZoomVideoSDKSessionLeaveReason_KickByHost,
 
    ZoomVideoSDKSessionLeaveReason_EndByHost,
 
    ZoomVideoSDKSessionLeaveReason_NetworkError,
}ZoomVideoSDKSessionLeaveReason;

ZoomVideoSDKSessionType

enum ZoomVideoSDKSessionType

Enumeration of Zoom Video SDK session types.

Enumerator
ZoomVideoSDKSessionType_MainSession	Main session.
ZoomVideoSDKSessionType_SubSession	Sub session.

Definition at line 736 of file zoom_video_sdk_def.h.

{
 
    ZoomVideoSDKSessionType_MainSession = 0,
 
    ZoomVideoSDKSessionType_SubSession,
};

ZoomVideoSDKShareStatus

enum ZoomVideoSDKShareStatus

Enumeration of sharing status in Zoom Video SDK.

Enumerator
ZoomVideoSDKShareStatus_None	No sharing activity.
ZoomVideoSDKShareStatus_Start	Sharing has started.
ZoomVideoSDKShareStatus_Pause	Sharing has been paused.
ZoomVideoSDKShareStatus_Resume	Sharing has resumed after being paused.
ZoomVideoSDKShareStatus_Stop	Sharing has been stopped.

Definition at line 232 of file zoom_video_sdk_def.h.

{
 
    ZoomVideoSDKShareStatus_None,
 
    ZoomVideoSDKShareStatus_Start,
 
    ZoomVideoSDKShareStatus_Pause,
 
    ZoomVideoSDKShareStatus_Resume,
 
    ZoomVideoSDKShareStatus_Stop,
}ZoomVideoSDKShareStatus;

ZoomVideoSDKShareType

enum ZoomVideoSDKShareType

Enumeration of sharing types in Zoom Video SDK.

Enumerator
ZoomVideoSDKShareType_None	No sharing type specified.
ZoomVideoSDKShareType_Normal	Application or desktop sharing.
ZoomVideoSDKShareType_PureAudio	Pure computer audio sharing.
ZoomVideoSDKShareType_Camera	Camera sharing.

Definition at line 249 of file zoom_video_sdk_def.h.

{
 
    ZoomVideoSDKShareType_None,
 
    ZoomVideoSDKShareType_Normal,
 
    ZoomVideoSDKShareType_PureAudio,
 
    ZoomVideoSDKShareType_Camera, 
}ZoomVideoSDKShareType;