|
Video SDK for Windows API Reference
|
Zoom Video SDK Common Definition File. More...
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 |
| Audio 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... | |
| struct | ZoomVideoSDKLiveStreamSetting |
| Represents the settings for a Zoom Video SDK live stream. More... | |
| struct | ZoomVideoSDKLiveStreamParams |
| Represents the parameters needed to start a Zoom Video SDK live stream. 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; |
Zoom Video SDK Common Definition File.
Definition in file zoom_video_sdk_def.h.
| #define BEGIN_ZOOM_VIDEO_SDK_NAMESPACE namespace ZOOM_VIDEO_SDK_NAMESPACE { |
Definition at line 13 of file zoom_video_sdk_def.h.
| #define END_ZOOM_VIDEO_SDK_NAMESPACE }; |
Definition at line 14 of file zoom_video_sdk_def.h.
| #define USING_ZOOM_VIDEO_SDK_NAMESPACE using namespace ZOOM_VIDEO_SDK_NAMESPACE; |
Definition at line 15 of file zoom_video_sdk_def.h.
| #define ZOOM_VIDEO_SDK_NAMESPACE ZOOMVIDEOSDK |
Definition at line 12 of file zoom_video_sdk_def.h.
| enum FileTransferStatus |
Enumeration representing the status of a file transfer.
Definition at line 644 of file zoom_video_sdk_def.h.
| enum FrameDataFormat |
Enumeration of specifying the format of frame data.
Definition at line 627 of file zoom_video_sdk_def.h.
| enum RecordingStatus |
Enumeration representing the status of recording.
Definition at line 372 of file zoom_video_sdk_def.h.
Enumeration of the microphone test status in Zoom Video SDK.
Definition at line 389 of file zoom_video_sdk_def.h.
Enumeration of audio channel type in Zoom Video SDK.
| Enumerator | |
|---|---|
| ZoomVideoSDKAudioChannel_Mono | Mono audio channel. |
| ZoomVideoSDKAudioChannel_Stereo | Stereo audio channel. |
Definition at line 785 of file zoom_video_sdk_def.h.
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 331 of file zoom_video_sdk_def.h.
| enum ZoomVideoSDKDataType |
Enumeration of the data type for network quality monitoring.
| Enumerator | |
|---|---|
| ZoomVideoSDKDataType_Unknown | Unknown data type. |
| ZoomVideoSDKDataType_Audio | Audio data type. |
| ZoomVideoSDKDataType_Video | Video data type. |
| ZoomVideoSDKDataType_Share | Share data type. |
Definition at line 910 of file zoom_video_sdk_def.h.
| 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 |
|
| ZoomVideoSDKErrors_Auth_DoesNot_Support_SDK |
|
| ZoomVideoSDKErrors_Auth_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_Account_FreeCreditExceeded | Join session failed because the account's free credit has been exceeded. |
| 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_Bluetooth_SCO_Connection_Failed | Bluetooth sco connect fail. Android Only. |
| 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_RAWDATA_INVALID_SHARE_PREPROCESSING_DATA_OBJECT | The share preprocessing data object is invalid. |
| ZoomVideoSDKErrors_RAWDATA_SHARE_PREPROCESSING_IS_STOPPED | Share preprocessing has stopped. |
| ZoomVideoSDKErrors_Session_Share_Error | General share error. |
| ZoomVideoSDKErrors_Session_Share_Module_Not_Ready |
|
| ZoomVideoSDKErrors_Session_Share_You_Are_Not_Sharing | 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_Recording_Is_Connecting | Recording is connecting. |
| ZoomVideoSDKErrors_Set_Virtual_Background_Fail |
|
| 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_Session_Share_Conflict_With_Whiteboard | Share conflicts with whiteboard share. |
| 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 21 of file zoom_video_sdk_def.h.
Enumeration of supported export formats for content, like whiteboard.
| Enumerator | |
|---|---|
| EXPORT_FORMAT_PDF | Export the content as a PDF document. |
Definition at line 834 of file zoom_video_sdk_def.h.
Enumeration of Zoom Video SDK live stream close caption options.
Definition at line 853 of file zoom_video_sdk_def.h.
Enumeration of Zoom Video SDK live stream layout types.
| Enumerator | |
|---|---|
| ZoomVideoSDKLiveStreamLayout_SpeakerView | Speaker view layout for the live stream. |
| ZoomVideoSDKLiveStreamLayout_GalleryView | Gallery view layout for the live stream. |
Definition at line 843 of file zoom_video_sdk_def.h.
Enumeration of live streaming status in Zoom Video SDK.
Definition at line 290 of file zoom_video_sdk_def.h.
Enumeration of preferred video resolution in Zoom Video SDK.
Definition at line 402 of file zoom_video_sdk_def.h.
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 309 of file zoom_video_sdk_def.h.
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 320 of file zoom_video_sdk_def.h.
Enumeration of remote control status in Zoom Video SDK.
Definition at line 343 of file zoom_video_sdk_def.h.
Enumeration of session leave reasons in Zoom Video SDK.
Definition at line 226 of file zoom_video_sdk_def.h.
Enumeration of Zoom Video SDK session types.
| Enumerator | |
|---|---|
| ZoomVideoSDKSessionType_MainSession | Main session. |
| ZoomVideoSDKSessionType_SubSession | Sub session. |
Definition at line 796 of file zoom_video_sdk_def.h.
Enumeration of reasons why screen sharing capture is paused in the Zoom Video SDK.
Definition at line 275 of file zoom_video_sdk_def.h.
Enumeration of Zoom Video SDK share setting types.
Definition at line 807 of file zoom_video_sdk_def.h.
Enumeration of sharing status in Zoom Video SDK.
Definition at line 243 of file zoom_video_sdk_def.h.
Enumeration of sharing types in Zoom Video SDK.
Definition at line 260 of file zoom_video_sdk_def.h.
Enumeration of the status of whiteboard sharing.
| Enumerator | |
|---|---|
| WhiteboardStatus_Started | The whiteboard has started. |
| WhiteboardStatus_Stopped | The whiteboard has stopped. |
Definition at line 822 of file zoom_video_sdk_def.h.