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 422 of file ZMVideoSDKDef.h.
enum ZMPhoneStatus |
Enumerates the statuses of a phone call.
Definition at line 395 of file ZMVideoSDKDef.h.
enum ZMRecordingStatus |
Enumerates the statuses of recording.
Definition at line 365 of file ZMVideoSDKDef.h.
enum ZMVideoRotation |
Enumerates the video rotation angles.
Definition at line 334 of file ZMVideoSDKDef.h.
Enumeration of the type for clear annotation.
Definition at line 867 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 801 of file ZMVideoSDKDef.h.
Enumeration of audio channel types.
Enumerator | |
---|---|
ZMVideoSDKAudioChannel_Mono | Mono audio channel. |
ZMVideoSDKAudioChannel_Stereo | Stereo audio channel. |
Definition at line 897 of file ZMVideoSDKDef.h.
Enumerates the statuses related to audio device state and availability.
Definition at line 522 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 511 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 322 of file ZMVideoSDKDef.h.
Enumerations of broadcast control status.
Definition at line 1072 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 383 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 715 of file ZMVideoSDKDef.h.
The chat message delete type are sent in the ZMVideoSDKDelegate#onChatMsgDeleteNotification callback.
Definition at line 611 of file ZMVideoSDKDef.h.
Enumerates the types of chat privileges.
Definition at line 787 of file ZMVideoSDKDef.h.
Enumerates the types of consent for cloud recording.
Definition at line 668 of file ZMVideoSDKDef.h.
Enumerates the statuses of a CRC call.
Definition at line 748 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 737 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 1134 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 639 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 466 of file ZMVideoSDKDef.h.
enum ZMVideoSDKErrors |
Enumerates all errors in the VideoSDK.
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 1063 of file ZMVideoSDKDef.h.
Enumeration of file transfer status.
Definition at line 880 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 726 of file ZMVideoSDKDef.h.
Enumeration of live stream close caption options.
Definition at line 1121 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 1110 of file ZMVideoSDKDef.h.
Enumerates the statuses of live streaming.
Definition at line 251 of file ZMVideoSDKDef.h.
Enumerates the types of operations related to live transcription.
Definition at line 592 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 581 of file ZMVideoSDKDef.h.
Enumerates the microphone test statuses.
Definition at line 498 of file ZMVideoSDKDef.h.
Enumerates the status of multi-camera streams.
Definition at line 479 of file ZMVideoSDKDef.h.
Enumerates the network statuses.
Definition at line 652 of file ZMVideoSDKDef.h.
Enumeration of preferred video resolution in Zoom Video SDK.
Definition at line 1037 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 300 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 311 of file ZMVideoSDKDef.h.
Enumeration of raw data types.
Enumerator | |
---|---|
ZMVideoSDKRawDataType_Video | Video raw data. |
ZMVideoSDKRawDataType_Share | Share raw data. |
Definition at line 270 of file ZMVideoSDKDef.h.
Enumerates the statuses for remote control.
Definition at line 925 of file ZMVideoSDKDef.h.
enum ZMVideoSDKResolution |
Enumeration of render resolution.
Definition at line 281 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 682 of file ZMVideoSDKDef.h.
Enumerates the possible reasons for leaving a session.
Definition at line 908 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 981 of file ZMVideoSDKDef.h.
Enumeration of reasons why screen sharing capture is paused in the Zoom Video SDK.
Definition at line 553 of file ZMVideoSDKDef.h.
Enumeration of share preprocess types.
Definition at line 1007 of file ZMVideoSDKDef.h.
Enumeration of Zoom Video SDK share setting types.
Definition at line 1022 of file ZMVideoSDKDef.h.
Enumerates the status of sharing.
Definition at line 234 of file ZMVideoSDKDef.h.
enum ZMVideoSDKShareType |
Enumerates the types of content that can be shared 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 539 of file ZMVideoSDKDef.h.
Enumerations of streaming join status.
Definition at line 1089 of file ZMVideoSDKDef.h.
Enumerates the reasons for a failed video subscription attempt.
Definition at line 767 of file ZMVideoSDKDef.h.
Enumeration of subsession statuses.
Definition at line 954 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 451 of file ZMVideoSDKDef.h.
Enumeration of subsession user help request results.
Definition at line 992 of file ZMVideoSDKDef.h.
Enumeration of the video aspect ratio.
Definition at line 700 of file ZMVideoSDKDef.h.
Enumerates the video preference modes.
Definition at line 349 of file ZMVideoSDKDef.h.
Enumerates the data modes for video source frames.
Definition at line 568 of file ZMVideoSDKDef.h.
Enumerates the types of virtual backgrounds.
Definition at line 626 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 1052 of file ZMVideoSDKDef.h.