|
Video SDK for MacOS API Reference
|
This file defines the enumeration of Zoom Video SDK. More...
Go to the source code of this file.
This file defines the enumeration of Zoom Video SDK.
Definition in file ZMVideoSDKDef.h.
| enum ZMPhoneFailedReason |
Enumerates the various reasons for a phone call failure.
Definition at line 432 of file ZMVideoSDKDef.h.
| enum ZMPhoneStatus |
Enumerates the statuses of a phone call.
Definition at line 403 of file ZMVideoSDKDef.h.
| enum ZMRecordingStatus |
Enumerates the statuses of recording.
Definition at line 373 of file ZMVideoSDKDef.h.
| enum ZMVideoRotation |
Enumerates the video rotation angles.
Definition at line 342 of file ZMVideoSDKDef.h.
Enumeration of the type for clear annotation.
Definition at line 879 of file ZMVideoSDKDef.h.
Enumeration of the type for annotation tool. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067931.
Definition at line 813 of file ZMVideoSDKDef.h.
Enumeration of audio channel types.
| Enumerator | |
|---|---|
| ZMVideoSDKAudioChannel_Mono | Mono audio channel. |
| ZMVideoSDKAudioChannel_Stereo | Stereo audio channel. |
Definition at line 909 of file ZMVideoSDKDef.h.
Enumerates the statuses related to audio device state and availability.
Definition at line 532 of file ZMVideoSDKDef.h.
Enumerates the types of audio devices.
| Enumerator | |
|---|---|
| ZMVideoSDKAudioDeviceType_Microphone | Represents a microphone device used for audio input. |
| ZMVideoSDKAudioDeviceType_Speaker | Represents a speaker device used for audio output. |
Definition at line 521 of file ZMVideoSDKDef.h.
| enum ZMVideoSDKAudioType |
Enumerates the types of audio.
| Enumerator | |
|---|---|
| ZMVideoSDKAudioType_VOIP | Audio type is VOIP (Voice over IP). |
| ZMVideoSDKAudioType_TELEPHONY | Audio type is telephony. |
| ZMVideoSDKAudioType_None | No audio type. |
Definition at line 330 of file ZMVideoSDKDef.h.
Enumerations of broadcast control status.
Definition at line 1088 of file ZMVideoSDKDef.h.
Enumeration of supported translation languages for broadcast streaming live transcription.
Definition at line 1227 of file ZMVideoSDKDef.h.
Enumerates the types of remote camera control requests.
| Enumerator | |
|---|---|
| ZMVideoSDKCameraControlRequestType_RequestControl | Request remote camera control. |
| ZMVideoSDKCameraControlRequestType_GiveUpControl | Give up remote camera control. |
Definition at line 391 of file ZMVideoSDKDef.h.
| enum ZMVideoSDKCanvasType |
Enumeration of the zoom render type.
| Enumerator | |
|---|---|
| ZMVideoSDKCanvasType_VideoData | Video Camera data. This type represents video data captured from the camera. |
| ZMVideoSDKCanvasType_ShareData | Share data. |
Definition at line 727 of file ZMVideoSDKDef.h.
The chat message delete type are sent in the ZMVideoSDKDelegate#onChatMsgDeleteNotification callback.
Definition at line 623 of file ZMVideoSDKDef.h.
Enumerates the types of chat privileges.
Definition at line 799 of file ZMVideoSDKDef.h.
Enumerates the types of consent for cloud recording.
Definition at line 680 of file ZMVideoSDKDef.h.
Enumerates the statuses of a CRC call.
Definition at line 760 of file ZMVideoSDKDef.h.
Enumerates the types of Call CRC (Circuit-Reliable Communication).
| Enumerator | |
|---|---|
| ZMVideoSDKCRCProtocol_H323 | H.323 type. |
| ZMVideoSDKCRCProtocol_SIP | SIP type. |
Definition at line 749 of file ZMVideoSDKDef.h.
| enum ZMVideoSDKDataType |
Enumeration of the data type for network quality monitoring.
| Enumerator | |
|---|---|
| ZMVideoSDKDataType_Unknown | Unknown data type. |
| ZMVideoSDKDataType_Audio | Audio data type. |
| ZMVideoSDKDataType_Video | Video data type. |
| ZMVideoSDKDataType_Share | Share data type. |
Definition at line 1150 of file ZMVideoSDKDef.h.
Enumeration of the number types for calling to join the audio into a meeting.
| Enumerator | |
|---|---|
| ZMVideoSDKDialInNumType_None | For initialization. |
| ZMVideoSDKDialInNumType_Toll | Paid (toll) number. |
| ZMVideoSDKDialInNumType_TollFree | Toll-free number. |
Definition at line 651 of file ZMVideoSDKDef.h.
Enumeration of echo cancellation level. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066398.
Definition at line 476 of file ZMVideoSDKDef.h.
Enumeration of emoji reaction types.
Definition at line 1206 of file ZMVideoSDKDef.h.
| enum ZMVideoSDKErrors |
Enumerates all errors in the VideoSDK.
| Enumerator | |
|---|---|
| ZMVideoSDKErrors_Success | Success. |
| ZMVideoSDKErrors_Wrong_Usage | Wrong usage. |
| ZMVideoSDKErrors_Internal_Error | Internal error. |
| ZMVideoSDKErrors_Uninitialize | SDK is not initialized. |
| ZMVideoSDKErrors_Memory_Error | Memory allocation error. |
| ZMVideoSDKErrors_Load_Module_Error | Failed to load module. |
| ZMVideoSDKErrors_UnLoad_Module_Error | Failed to unload module. |
| ZMVideoSDKErrors_Invalid_Parameter | One or more parameters are invalid. |
| ZMVideoSDKErrors_Call_Too_Frequently | API called too frequently. |
| ZMVideoSDKErrors_No_Impl | Function not implemented. |
| ZMVideoSDKErrors_Dont_Support_Feature | Feature not supported. |
| ZMVideoSDKErrors_Unknown | Unknown error. |
| ZMVideoSDKErrors_Remove_Folder_Fail | Failed to remove folder. |
| ZMVideoSDKErrors_Auth_Error | Authorization related errors Authorization failure. |
| ZMVideoSDKErrors_Auth_Empty_Key_or_Secret | App key or secret is empty. |
| ZMVideoSDKErrors_Auth_Wrong_Key_or_Secret |
|
| ZMVideoSDKErrors_Auth_DoesNot_Support_SDK |
|
| ZMVideoSDKErrors_Auth_Disable_SDK |
|
| ZMVideoSDKErrors_JoinSession_NoSessionName | Join session errors Session name is missing. |
| ZMVideoSDKErrors_JoinSession_NoSessionToken | Session token is missing. |
| ZMVideoSDKErrors_JoinSession_NoUserName | Username is missing. |
| ZMVideoSDKErrors_JoinSession_Invalid_SessionName | Session name is invalid. |
| ZMVideoSDKErrors_JoinSession_Invalid_Password | Password is incorrect. |
| ZMVideoSDKErrors_JoinSession_Invalid_SessionToken | Session token is invalid. |
| ZMVideoSDKErrors_JoinSession_SessionName_TooLong | Session name is too long. |
| ZMVideoSDKErrors_JoinSession_Token_MismatchedSessionName | Token does not match session name. |
| ZMVideoSDKErrors_JoinSession_Token_NoSessionName | Token does not contain a session name. |
| ZMVideoSDKErrors_JoinSession_Token_RoleType_EmptyOrWrong | Role type in token is empty or incorrect. |
| ZMVideoSDKErrors_JoinSession_Token_UserIdentity_TooLong | User identity in token is too long. |
| ZMVideoSDKErrors_SessionModule_Not_Found | Session-related errors Session module not found. |
| ZMVideoSDKErrors_SessionService_Invalid | Invalid session service. |
| ZMVideoSDKErrors_Session_Join_Failed | Failed to join session. |
| ZMVideoSDKErrors_Session_No_Rights | No permission to join session. |
| ZMVideoSDKErrors_Session_Already_In_Progress | Already in progress. |
| ZMVideoSDKErrors_Session_Dont_Support_SessionType | Unsupported session type. |
| ZMVideoSDKErrors_Session_Reconnecting | Session is reconnecting. |
| ZMVideoSDKErrors_Session_Disconnecting | Session is disconnecting. |
| ZMVideoSDKErrors_Session_Not_Started | Session has not started. |
| ZMVideoSDKErrors_Session_Need_Password | Password is required to join. |
| ZMVideoSDKErrors_Session_Password_Wrong | Incorrect session password. |
| ZMVideoSDKErrors_Session_Remote_DB_Error | Remote database error. |
| ZMVideoSDKErrors_Session_Invalid_Param | Invalid parameter. |
| ZMVideoSDKErrors_Session_Client_Incompatible | Client version is incompatible. |
| ZMVideoSDKErrors_Session_Account_FreeMinutesExceeded | Free minutes exceeded. |
| ZMVideoSDKErrors_Session_Account_FreeCreditExceeded | Join session failed because the account's free credit has been exceeded. |
| ZMVideoSDKErrors_Session_PreJoin_Not_In_Flow | Pre-join flow: not in prepare join flow. |
| ZMVideoSDKErrors_Session_PreJoin_Already_Commit | Pre-join flow: already committed (user has confirmed). |
| ZMVideoSDKErrors_Session_PreJoin_Timeout | Pre-join flow: timeout. |
| ZMVideoSDKErrors_Session_Audio_Error | Audio errors General audio error. |
| ZMVideoSDKErrors_Session_Audio_No_Microphone | No microphone detected. |
| ZMVideoSDKErrors_Session_Audio_No_Speaker | No speaker detected. |
| ZMVideoSDKErrors_Session_Bluetooth_SCO_Connection_Failed | Bluetooth sco connect fail. Android Only. |
| ZMVideoSDKErrors_Session_Video_Error | Video errors. General video error. |
| ZMVideoSDKErrors_Session_Video_Device_Error | Video device error. |
| ZMVideoSDKErrors_Session_Live_Stream_Error | Live stream error. |
| ZMVideoSDKErrors_Session_Phone_Error | Phone error. |
| ZMVideoSDKErrors_RAWDATA_MALLOC_FAILED | Raw data errors Memory allocation for raw data failed. |
| ZMVideoSDKErrors_RAWDATA_NOT_IN_Session | Not in session. |
| ZMVideoSDKErrors_RAWDATA_NO_LICENSE | No raw data license. |
| ZMVideoSDKErrors_RAWDATA_VIDEO_MODULE_NOT_READY | Video module not ready. |
| ZMVideoSDKErrors_RAWDATA_VIDEO_MODULE_ERROR | Video module error. |
| ZMVideoSDKErrors_RAWDATA_VIDEO_DEVICE_ERROR | Video device error. |
| ZMVideoSDKErrors_RAWDATA_NO_VIDEO_DATA | No video data available. |
| ZMVideoSDKErrors_RAWDATA_SHARE_MODULE_NOT_READY | Share module not ready. |
| ZMVideoSDKErrors_RAWDATA_SHARE_MODULE_ERROR | Share module error. |
| ZMVideoSDKErrors_RAWDATA_NO_SHARE_DATA | No shared data available. |
| ZMVideoSDKErrors_RAWDATA_AUDIO_MODULE_NOT_READY | Audio module not ready. |
| ZMVideoSDKErrors_RAWDATA_AUDIO_MODULE_ERROR | Audio module error. |
| ZMVideoSDKErrors_RAWDATA_NO_AUDIO_DATA | No audio data available. |
| ZMVideoSDKErrors_RAWDATA_PREPROCESS_RAWDATA_ERROR | Raw data pre-processing failed. |
| ZMVideoSDKErrors_RAWDATA_NO_DEVICE_RUNNING | No device is running. |
| ZMVideoSDKErrors_RAWDATA_INIT_DEVICE | Failed to initialize media device. |
| ZMVideoSDKErrors_RAWDATA_VIRTUAL_DEVICE | Virtual device error. |
| ZMVideoSDKErrors_RAWDATA_CANNOT_CHANGE_VIRTUAL_DEVICE_IN_PREVIEW | Cannot change virtual device during preview. |
| ZMVideoSDKErrors_RAWDATA_INTERNAL_ERROR | Internal raw data error. |
| ZMVideoSDKErrors_RAWDATA_SEND_TOO_MUCH_DATA_IN_SINGLE_TIME | Too much data sent at once. |
| ZMVideoSDKErrors_RAWDATA_SEND_TOO_FREQUENTLY | Data sent too frequently. |
| ZMVideoSDKErrors_RAWDATA_VIRTUAL_MIC_IS_TERMINATE | Virtual microphone has been terminated. |
| ZMVideoSDKErrors_Rawdata_Invalid_Share_Preprocessing_Data_Object | The share preprocessing data object is invalid. |
| ZMVideoSDKErrors_Rawdata_Share_Preprocessing_Is_Stopped | Share preprocessing has stopped. |
| ZMVideoSDKErrors_Session_Share_Error | Session sharing errors General sharing error. |
| ZMVideoSDKErrors_Session_Share_Module_Not_Ready |
|
| ZMVideoSDKErrors_Session_Share_You_Are_Not_Sharing | You are not sharing. |
| ZMVideoSDKErrors_Session_Share_Type_Is_Not_Support |
|
| ZMVideoSDKErrors_Session_Share_Internal_Error |
|
| ZMVideoSDKErrors_Dont_Support_Multi_Stream_Video_User |
|
| ZMVideoSDKErrors_Fail_Assign_User_Privilege |
|
| ZMVideoSDKErrors_No_Recording_In_Process |
|
| ZMVideoSDKErrors_Recording_Is_Connecting | Recording is connecting. |
| ZMVideoSDKErrors_Set_Virtual_Background_Fail |
|
| ZMVideoSDKErrors_Session_Share_Camera_Video_Not_Start | Camera video not started for share. |
| ZMVideoSDKErrors_Session_Share_Camera_Conflict_With_Video_Effects | Camera conflicts with video effects. |
| ZMVideoSDKErrors_Session_Share_Conflict_With_Whiteboard | Share conflicts with whiteboard share. |
| ZMVideoSDKErrors_Filetransfer_UnknowError | File transfer errors. Unknown file transfer error. |
| ZMVideoSDKErrors_Filetransfer_FileTypeBlocked | File type is blocked. |
| ZMVideoSDKErrors_Filetransfer_FileSizelimited | File size exceeds limit. |
| ZMVideoSDKErrors_Spotlight_NotEnoughUsers | Spotlight errors Not enough users to spotlight. |
| ZMVideoSDKErrors_Spotlight_ToMuchSpotlightedUsers | Too many spotlighted users. |
| ZMVideoSDKErrors_Spotlight_UserCannotBeSpotlighted | User cannot be spotlighted. |
| ZMVideoSDKErrors_Spotlight_UserWithoutVideo | User has no video to spotlight. |
| ZMVideoSDKErrors_Spotlight_UserNotSpotlighted | User is not spotlighted. |
| ZMVideoSDKErrors_Cannot_Call_Cleanup_In_Session | Cannot call cleanUp while in session. Leave the session before calling cleanUp. |
Definition at line 9 of file ZMVideoSDKDef.h.
Enumeration of supported export formats for content, like whiteboard.
| Enumerator | |
|---|---|
| ZMVideoSDKExportFormat_PDF | Export the content as a PDF document. |
Definition at line 1079 of file ZMVideoSDKDef.h.
Enumeration of file transfer status.
Definition at line 892 of file ZMVideoSDKDef.h.
Enumeration of raw data formats. Defines the color space format and color range for video frames.
| Enumerator | |
|---|---|
| ZMVideoSDKFrameDataFormat_I420_Limited | I420 format with Limited color range. |
| ZMVideoSDKFrameDataFormat_I420_Full | I420 format with Full color range. |
Definition at line 738 of file ZMVideoSDKDef.h.
Enumeration of live stream close caption options.
Definition at line 1137 of file ZMVideoSDKDef.h.
Enumeration of live stream layout types.
| Enumerator | |
|---|---|
| ZMVideoSDKLiveStreamLayout_SpeakerView | Speaker view layout for live stream. |
| ZMVideoSDKLiveStreamLayout_GalleryView | Gallery view layout for live stream. |
Definition at line 1126 of file ZMVideoSDKDef.h.
Enumerates the statuses of live streaming.
Definition at line 259 of file ZMVideoSDKDef.h.
Enumerates the types of operations related to live transcription.
Definition at line 604 of file ZMVideoSDKDef.h.
Enumerates the status of live transcription.
| Enumerator | |
|---|---|
| ZMVideoSDKLiveTranscription_Status_Stop | Live transcription is currently stopped. |
| ZMVideoSDKLiveTranscription_Status_Start | Live transcription is currently active. |
Definition at line 593 of file ZMVideoSDKDef.h.
Enumerates the microphone test statuses.
Definition at line 508 of file ZMVideoSDKDef.h.
Enumerates the status of multi-camera streams.
Definition at line 489 of file ZMVideoSDKDef.h.
Enumerates the network statuses.
Definition at line 664 of file ZMVideoSDKDef.h.
Enumeration of preferred video resolution in Zoom Video SDK.
Definition at line 1053 of file ZMVideoSDKDef.h.
Enumeration of memory modes for raw data handling.
| Enumerator | |
|---|---|
| ZMVideoSDKRawDataMemoryMode_Stack | The memory mode is srack. |
| ZMVideoSDKRawDataMemoryMode_Heap | The memory mode is heap. |
Definition at line 308 of file ZMVideoSDKDef.h.
Enumeration the statuses of raw data.
| Enumerator | |
|---|---|
| ZMVideoSDKRawData_On | The raw data status is on. |
| ZMVideoSDKRawData_Off | The raw data status if off. |
Definition at line 319 of file ZMVideoSDKDef.h.
Enumeration of raw data types.
| Enumerator | |
|---|---|
| ZMVideoSDKRawDataType_Video | Video raw data. |
| ZMVideoSDKRawDataType_Share | Share raw data. |
Definition at line 278 of file ZMVideoSDKDef.h.
Failure reasons for RealTimeMediaStreams. Here are more detailed structural descriptions.
Definition at line 1193 of file ZMVideoSDKDef.h.
Real-time media streams status. Here are more detailed structural descriptions.
Definition at line 1177 of file ZMVideoSDKDef.h.
Enumerates the statuses for remote control.
Definition at line 941 of file ZMVideoSDKDef.h.
| enum ZMVideoSDKResolution |
Enumeration of render resolution.
Definition at line 289 of file ZMVideoSDKDef.h.
Enumeration of the mode for screen capture. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063824.
Definition at line 694 of file ZMVideoSDKDef.h.
Enumerates the possible reasons for leaving a session.
Definition at line 920 of file ZMVideoSDKDef.h.
Enumeration of session type.
| Enumerator | |
|---|---|
| ZMVideoSDKSessionType_MainSession | The session type is main session. |
| ZMVideoSDKSessionType_SubSession | The session type is subsession. |
Definition at line 997 of file ZMVideoSDKDef.h.
Enumeration of reasons why screen sharing capture is paused in the Zoom Video SDK.
Definition at line 565 of file ZMVideoSDKDef.h.
Enumeration of share preprocess types.
Definition at line 1023 of file ZMVideoSDKDef.h.
Enumeration of Zoom Video SDK share setting types.
Definition at line 1038 of file ZMVideoSDKDef.h.
Enumerates the status of sharing.
Definition at line 242 of file ZMVideoSDKDef.h.
| enum ZMVideoSDKShareType |
Enumerates the types of content available for sharing in a session.
| Enumerator | |
|---|---|
| ZMVideoSDKShareType_None | |
| ZMVideoSDKShareType_Normal | Application or desktop share. |
| ZMVideoSDKShareType_PureAudio | Pure computer audio share. |
| ZMVideoSDKShareType_Camera | Camera share. |
Definition at line 551 of file ZMVideoSDKDef.h.
Direction of media statistics (send or receive).
| Enumerator | |
|---|---|
| ZMVideoSDKStatisticsDirection_Send | Sending media statistics. |
| ZMVideoSDKStatisticsDirection_Receive | Receiving media statistics. |
Definition at line 1165 of file ZMVideoSDKDef.h.
Enumerations of streaming join status.
Definition at line 1105 of file ZMVideoSDKDef.h.
Enumerates the reasons for a failed video subscription attempt.
Definition at line 779 of file ZMVideoSDKDef.h.
Enumeration of subsession statuses.
Definition at line 970 of file ZMVideoSDKDef.h.
Enumeration of background noise suppression levels. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0059985.
Definition at line 461 of file ZMVideoSDKDef.h.
Enumeration of subsession user help request results.
Definition at line 1008 of file ZMVideoSDKDef.h.
Enumeration of the video aspect ratio.
Definition at line 712 of file ZMVideoSDKDef.h.
Enumerates the video preference modes.
Definition at line 357 of file ZMVideoSDKDef.h.
Enumerates the data modes for video source frames.
Definition at line 580 of file ZMVideoSDKDef.h.
Enumerates the types of virtual backgrounds.
Definition at line 638 of file ZMVideoSDKDef.h.
Enumeration of the status of whiteboard sharing.
| Enumerator | |
|---|---|
| ZMVideoSDKWhiteboardStatus_Started | The whiteboard has started. |
| ZMVideoSDKWhiteboardStatus_Stopped | The whiteboard has stopped. |
Definition at line 1068 of file ZMVideoSDKDef.h.