|
Video SDK for iOS API Reference
|
Definitions of all constants, enumerations, and error codes used throughout the Zoom Video SDK. More...
Go to the source code of this file.
Definitions of all constants, enumerations, and error codes used throughout the Zoom Video SDK.
Definition in file ZoomVideoSDKConstants.h.
Enumeration of the type for clear annotation.
Definition at line 684 of file ZoomVideoSDKConstants.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 620 of file ZoomVideoSDKConstants.h.
Enumeration of audio channel types.
| Enumerator | |
|---|---|
| ZoomVideoSDKAudioChannel_Mono | Mono audio channel. |
| ZoomVideoSDKAudioChannel_Stereo | Stereo audio channel. |
Definition at line 743 of file ZoomVideoSDKConstants.h.
Enumeration of audio types.
Definition at line 249 of file ZoomVideoSDKConstants.h.
Enumeration of the broadcast control status.
Definition at line 912 of file ZoomVideoSDKConstants.h.
Enumeration of chat message delete types. The chat message delete types are sent in the onChatMsgDeleteNotification:messageID:deleteBy: callback.
Definition at line 522 of file ZoomVideoSDKConstants.h.
Enumeration of chat privilege types.
Definition at line 729 of file ZoomVideoSDKConstants.h.
Enumeration of CRC call statuses.
Definition at line 602 of file ZoomVideoSDKConstants.h.
Enumeration of Call CRC (Circuit-Reliable Communication) types.
| Enumerator | |
|---|---|
| ZoomVideoSDKCRCProtocol_H323 | H.323 type. |
| ZoomVideoSDKCRCProtocol_SIP | SIP type. |
Definition at line 592 of file ZoomVideoSDKConstants.h.
| enum ZoomVideoSDKDataType |
Enumeration of data types 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 954 of file ZoomVideoSDKConstants.h.
Enumeration of the number types for calling to join the audio into a meeting.
| Enumerator | |
|---|---|
| ZoomVideoSDKDialInNumType_None | For initialization. |
| ZoomVideoSDKDialInNumType_Toll | Paid (toll) number. |
| ZoomVideoSDKDialInNumType_TollFree | Toll-free number. |
Definition at line 537 of file ZoomVideoSDKConstants.h.
| enum ZoomVideoSDKError |
Enumeration of all the errors in the VideoSDK.
Definition at line 11 of file ZoomVideoSDKConstants.h.
Enumeration of the file transfer status.
Definition at line 765 of file ZoomVideoSDKConstants.h.
Enumeration of the raw data formats. Defines the color space format and color range for video frames.
| Enumerator | |
|---|---|
| ZoomVideoSDKFrameDataFormat_I420 | I420 format with Limited color range. |
| ZoomVideoSDKFrameDataFormat_I420_Limit | I420 format with Full color range. |
Definition at line 321 of file ZoomVideoSDKConstants.h.
Enumeration of the live stream close caption options.
Definition at line 991 of file ZoomVideoSDKConstants.h.
Enumeration of live stream layout types.
| Enumerator | |
|---|---|
| ZoomVideoSDKLiveStreamLayout_SpeakerView | Speaker view layout for live stream. |
| ZoomVideoSDKLiveStreamLayout_GalleryView | Gallery view layout for live stream. |
Definition at line 981 of file ZoomVideoSDKConstants.h.
Enumeration of live streaming statuses.
Definition at line 303 of file ZoomVideoSDKConstants.h.
Enumeration of live transcription operation types.
Definition at line 494 of file ZoomVideoSDKConstants.h.
Enumeration of the live transcription status.
| Enumerator | |
|---|---|
| ZoomVideoSDKLiveTranscriptionStatus_Stop | Live transcription is currently stopped. |
| ZoomVideoSDKLiveTranscriptionStatus_Start | Live transcription is currently active. |
Definition at line 484 of file ZoomVideoSDKConstants.h.
Enumeration of the mask shape.
| Enumerator | |
|---|---|
| ZoomVideoSDKMaskShape_Rectangle | Rectangle. |
| ZoomVideoSDKMaskShape_Circle | Circle. |
| ZoomVideoSDKMaskShape_Oval | Oval. |
Definition at line 797 of file ZoomVideoSDKConstants.h.
Enumeration of multi-camera stream statuses.
Definition at line 466 of file ZoomVideoSDKConstants.h.
Enumeration of network statuses.
Definition at line 551 of file ZoomVideoSDKConstants.h.
Enumeration of phone call failure reasons.
Definition at line 408 of file ZoomVideoSDKConstants.h.
Enumeration of phone call statuses.
Definition at line 381 of file ZoomVideoSDKConstants.h.
Enumeration of the preferred video resolution in Zoom Video SDK.
Definition at line 968 of file ZoomVideoSDKConstants.h.
Enumeration of the memory modes for raw data handling.
| Enumerator | |
|---|---|
| ZoomVideoSDKRawDataMemoryModeStack | The memory mode is stack. |
| ZoomVideoSDKRawDataMemoryModeHeap | The memory mode is heap. |
Definition at line 361 of file ZoomVideoSDKConstants.h.
Enumeration of failure reasons for RealTimeMediaStreams.
Definition at line 1017 of file ZoomVideoSDKConstants.h.
Enumeration of the real-time media streams status.
Definition at line 1003 of file ZoomVideoSDKConstants.h.
Enumeration of the sharing status.
Definition at line 287 of file ZoomVideoSDKConstants.h.
Enumeration of cloud recording consent types.
Definition at line 566 of file ZoomVideoSDKConstants.h.
Enumeration of the recording status.
Definition at line 434 of file ZoomVideoSDKConstants.h.
Enumeration of session leave reasons.
Definition at line 781 of file ZoomVideoSDKConstants.h.
Enumeration of the session type.
| Enumerator | |
|---|---|
| ZoomVideoSDKSessionType_MainSession | The session type is main session. |
| ZoomVideoSDKSessionType_SubSession | The session type is subsession. |
Definition at line 238 of file ZoomVideoSDKConstants.h.
Enumeration of share preprocess types.
| Enumerator | |
|---|---|
| ZoomVideoSDKSharePreprocessType_none | For initialization. |
| ZoomVideoSDKSharePreprocessType_view | For share view |
Definition at line 861 of file ZoomVideoSDKConstants.h.
Enumeration of Zoom Video SDK share setting types.
Definition at line 871 of file ZoomVideoSDKConstants.h.
Enumeration of content types that can be shared in a session.
| Enumerator | |
|---|---|
| ZoomVideoSDKShareType_None | |
| ZoomVideoSDKShareType_Normal | Application or desktop share. |
| ZoomVideoSDKShareType_PureAudio | Pure computer audio share. |
| ZoomVideoSDKShareType_Camera | Camera share. |
Definition at line 714 of file ZoomVideoSDKConstants.h.
Enumeration of the streaming join status.
Definition at line 886 of file ZoomVideoSDKConstants.h.
Enumeration of video subscription failure reasons.
Definition at line 696 of file ZoomVideoSDKConstants.h.
Enumeration of subsession statuses.
Definition at line 819 of file ZoomVideoSDKConstants.h.
Enumeration of device permission types.
| Enumerator | |
|---|---|
| ZoomVideoSDKSystemPermissionType_Camera | System permission - Camera is needed. |
| ZoomVideoSDKSystemPermissionType_Microphone | System permission - Microphone is needed. |
Definition at line 512 of file ZoomVideoSDKConstants.h.
Enumeration of the microphone test statuses.
Definition at line 753 of file ZoomVideoSDKConstants.h.
Enumeration of the subsession user help request results.
Definition at line 846 of file ZoomVideoSDKConstants.h.
Enumeration of raw data statuses.
| Enumerator | |
|---|---|
| ZoomVideoSDKUserRawdataOn | The raw data status is on. |
| ZoomVideoSDKUserRawdataOff | The raw data status is off. |
Definition at line 371 of file ZoomVideoSDKConstants.h.
Enumeration of the UVC camera status.
| Enumerator | |
|---|---|
| ZoomVideoSDKUVCCameraStatus_Attached | UVC camera attached. |
| ZoomVideoSDKUVCCameraStatus_Detached | UVC camera detached. |
Definition at line 809 of file ZoomVideoSDKConstants.h.
Enumeration of the video aspect ratio.
Definition at line 263 of file ZoomVideoSDKConstants.h.
Enumeration of video preference modes.
Definition at line 452 of file ZoomVideoSDKConstants.h.
Enumeration of the directions of video raw data rotation.
Definition at line 331 of file ZoomVideoSDKConstants.h.
Enumeration of the render resolution.
Definition at line 345 of file ZoomVideoSDKConstants.h.
Enumeration of the video type.
| Enumerator | |
|---|---|
| ZoomVideoSDKVideoType_VideoData | Video Camera Data. |
| ZoomVideoSDKVideoType_ShareData | Share Data. |
Definition at line 277 of file ZoomVideoSDKConstants.h.
Enumeration of virtual background types.
Definition at line 579 of file ZoomVideoSDKConstants.h.
Enumeration of supported export formats for content, like whiteboard.
| Enumerator | |
|---|---|
| ZoomVideoSDKWhiteboardExport_Format_PDF | Export the content as a PDF document. |
Definition at line 932 of file ZoomVideoSDKConstants.h.
Enumeration of the status of the whiteboard sharing.
| Enumerator | |
|---|---|
| ZoomVideoSDKWhiteboardStatus_Started | The whiteboard has started. |
| ZoomVideoSDKWhiteboardStatus_Stopped | The whiteboard has stopped. |
Definition at line 942 of file ZoomVideoSDKConstants.h.