|
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 696 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 632 of file ZoomVideoSDKConstants.h.
Enumeration of audio channel types.
| Enumerator | |
|---|---|
| ZoomVideoSDKAudioChannel_Mono | Mono audio channel. |
| ZoomVideoSDKAudioChannel_Stereo | Stereo audio channel. |
Definition at line 755 of file ZoomVideoSDKConstants.h.
Enumeration of audio error types for iOS. Used by onAudioError callback.
Definition at line 238 of file ZoomVideoSDKConstants.h.
Enumeration of audio types.
Definition at line 261 of file ZoomVideoSDKConstants.h.
Enumeration of the broadcast control status.
Definition at line 924 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 534 of file ZoomVideoSDKConstants.h.
Enumeration of chat privilege types.
Definition at line 741 of file ZoomVideoSDKConstants.h.
Enumeration of CRC call statuses.
Definition at line 614 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 604 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 966 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 549 of file ZoomVideoSDKConstants.h.
| enum ZoomVideoSDKError |
Enumeration of all the errors in the VideoSDK.
| Enumerator | |
|---|---|
| Errors_Success | Success. |
| Errors_Wrong_Usage | Wrong usage. |
| Errors_Internal_Error | Internal error. |
| Errors_Uninitialize | SDK is not initialized. |
| Errors_Memory_Error | Memory allocation error. |
| Errors_Load_Module_Error | Failed to load module. |
| Errors_UnLoad_Module_Error | Failed to unload module. |
| Errors_Invalid_Parameter | One or more parameters are invalid. |
| Errors_Call_Too_Frequently | API called too frequently. |
| Errors_No_Impl | Function not implemented. |
| Errors_Dont_Support_Feature | Feature not supported. |
| Errors_Unknown | Unknown error. |
| Errors_Remove_Folder_Fail | Failed to remove folder. |
| Errors_Auth_Base | Authorization related errors. |
| Errors_Auth_Error | Authorization failure. |
| Errors_Auth_Empty_Key_or_Secret | App key or secret is empty. |
| Errors_Auth_Wrong_Key_or_Secret |
|
| Errors_Auth_DoesNot_Support_SDK |
|
| Errors_Auth_Disable_SDK |
|
| Errors_JoinSession_NoSessionName | Join session errors. Session name is missing. |
| Errors_JoinSession_NoSessionToken | Session token is missing. |
| Errors_JoinSession_NoUserName | Username is missing. |
| Errors_JoinSession_Invalid_SessionName | Session name is invalid. |
| Errors_JoinSession_Invalid_Password | Password is incorrect. |
| Errors_JoinSession_Invalid_SessionToken | Session token is invalid. |
| Errors_JoinSession_SessionName_TooLong | Session name is too long. |
| Errors_JoinSession_Token_MismatchedSessionName | Token does not match session name. |
| Errors_JoinSession_Token_NoSessionName | Token does not contain a session name. |
| Errors_JoinSession_Token_RoleType_EmptyOrWrong | Role type in token is empty or incorrect. |
| Errors_JoinSession_Token_UserIdentity_TooLong | User identity in token is too long. |
| Errors_Session_Base | Session-related errors. |
| Errors_Session_Module_Not_Found | Session module not found. |
| Errors_Session_Service_Invalid | Invalid session service. |
| Errors_Session_Join_Failed | Failed to join session. |
| Errors_Session_No_Rights | No permission to join session. |
| Errors_Session_Already_In_Progress | Already in progress. |
| Errors_Session_Dont_Support_SessionType | Unsupported session type. |
| Errors_Session_Reconnecting | Session is reconnecting. |
| Errors_Session_Disconnecting | Session is disconnecting. |
| Errors_Session_Not_Started | Session has not started. |
| Errors_Session_Need_Password | Password is required to join. |
| Errors_Session_Password_Wrong | Incorrect session password. |
| Errors_Session_Remote_DB_Error | Remote database error. |
| Errors_Session_Invalid_Param | Invalid parameter. |
| Errors_Session_Client_Incompatible | Client version is incompatible. |
| Errors_Session_Account_FreeMinutesExceeded | Free minutes exceeded. |
| Errors_Session_Account_FreeCreditExceeded | Join session failed because the account's free credit has been exceeded. |
| Errors_Session_Audio_Error | Audio errors. General audio error. |
| Errors_Session_Audio_No_Microphone | No microphone detected. |
| Errors_Session_Audio_No_Speaker | No speaker detected. |
| Errors_Session_Bluetooth_SCO_Connection_Failed | Bluetooth sco connect fail. Android Only. |
| Errors_Session_Video_Error | Video errors. General video error. |
| Errors_Session_Video_Device_Error | Video device error. |
| Errors_Session_Live_Stream_Error | Live stream error. |
| Errors_Session_Phone_Error | Phone error. |
| Errors_Dont_Support_Multi_Stream_Video_User |
|
| Errors_Fail_Assign_User_Privilege |
|
| Errors_No_Recording_In_Process |
|
| Errors_Recording_Is_Connecting | Recording is connecting. |
| Errors_Set_Virtual_Background_Fail |
|
| Errors_Malloc_Failed | Raw data errors. Memory allocation for raw data failed. |
| Errors_Not_In_Session | Not in session. |
| Errors_No_License | No raw data license. |
| Errors_Video_Module_Not_Ready | Video module not ready. |
| Errors_Video_Module_Error | Video module error. |
| Errors_Video_device_error | Video device error. |
| Errors_No_Video_Data | No video data available. |
| Errors_Share_Module_Not_Ready | Share module not ready. |
| Errors_Share_Module_Error | Share module error. |
| Errors_No_Share_Data | No shared data available. |
| Errors_Audio_Module_Not_Ready | Audio module not ready. |
| Errors_Audio_Module_Error | Audio module error. |
| Errors_No_Audio_Data | No audio data available. |
| Errors_Preprocess_Rawdata_Error | Raw data pre-processing failed. |
| Errors_Rawdata_No_Device_Running | No device is running. |
| Errors_Rawdata_Init_Device | Failed to initialize media device. |
| Errors_Rawdata_Virtual_Device | Virtual device error. |
| Errors_Rawdata_Cannot_Change_Virtual_Device_In_Preview | Cannot change virtual device during preview. |
| Errors_Rawdata_Internal_Error | Internal raw data error. |
| Errors_Rawdata_Send_Too_Much_Data_In_Single_Time | Too much data sent at once. |
| Errors_Rawdata_Send_Too_Frequently | Data sent too frequently. |
| Errors_Rawdata_Virtual_Mic_Is_Terminate | Virtual microphone has been terminated. |
| Errors_Rawdata_Invalid_Share_Preprocessing_Data_Object | The share preprocessing data object is invalid. |
| Errors_Rawdata_Share_Preprocessing_Is_Stopped | Share preprocessing has stopped. |
| Errors_Session_Share_Error | Session sharing errors. General sharing error. |
| Errors_Session_Share_Module_Not_Ready |
|
| Errors_Session_Share_You_Are_Not_Sharing | You are not sharing. |
| Errors_Session_Share_Type_Is_Not_Support |
|
| Errors_Session_Share_Internal_Error |
|
| Errors_Session_Share_Camera_Video_Not_Start | Camera video not started for share. |
| Errors_Session_Share_Camera_Conflict_With_Video_Effects | Camera conflicts with video effects. |
| Errors_Session_Share_Conflict_With_Whiteboard | Share conflicts with whiteboard share. |
| Errors_Session_Filetransfer_UnknownError | File transfer errors. Unknown file transfer error. |
| Errors_Session_Filetransfer_FileTypeBlocked | File type is blocked. |
| Errors_Session_Filetransfer_FileSizelimited | File size exceeds limit. |
| Errors_Spotlight_NotEnoughUsers | Spotlight errors. Not enough users to spotlight. |
| Errors_Spotlight_ToMuchSpotlightedUsers | Too many spotlighted users. |
| Errors_Spotlight_UserCannotBeSpotlighted | User cannot be spotlighted. |
| Errors_Spotlight_UserWithoutVideo | User has no video to spotlight. |
| Errors_Spotlight_UserNotSpotlighted | User is not spotlighted. |
| Errors_Cannot_Call_Cleanup_In_Session | Cannot call cleanup while in session. Leave the session before calling -[ZoomVideoSDK cleanup]. |
Definition at line 11 of file ZoomVideoSDKConstants.h.
Enumeration of the file transfer status.
Definition at line 777 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 333 of file ZoomVideoSDKConstants.h.
Enumeration of the live stream close caption options.
Definition at line 1003 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 993 of file ZoomVideoSDKConstants.h.
Enumeration of live streaming statuses.
Definition at line 315 of file ZoomVideoSDKConstants.h.
Enumeration of live transcription operation types.
Definition at line 506 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 496 of file ZoomVideoSDKConstants.h.
Enumeration of the mask shape.
| Enumerator | |
|---|---|
| ZoomVideoSDKMaskShape_Rectangle | Rectangle. |
| ZoomVideoSDKMaskShape_Circle | Circle. |
| ZoomVideoSDKMaskShape_Oval | Oval. |
Definition at line 809 of file ZoomVideoSDKConstants.h.
Enumeration of multi-camera stream statuses.
Definition at line 478 of file ZoomVideoSDKConstants.h.
Enumeration of network statuses.
Definition at line 563 of file ZoomVideoSDKConstants.h.
Enumeration of phone call failure reasons.
Definition at line 420 of file ZoomVideoSDKConstants.h.
Enumeration of phone call statuses.
Definition at line 393 of file ZoomVideoSDKConstants.h.
Enumeration of the preferred video resolution in Zoom Video SDK.
Definition at line 980 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 373 of file ZoomVideoSDKConstants.h.
Enumeration of failure reasons for RealTimeMediaStreams.
Definition at line 1029 of file ZoomVideoSDKConstants.h.
Enumeration of the real-time media streams status.
Definition at line 1015 of file ZoomVideoSDKConstants.h.
Enumeration of the sharing status.
Definition at line 299 of file ZoomVideoSDKConstants.h.
Enumeration of cloud recording consent types.
Definition at line 578 of file ZoomVideoSDKConstants.h.
Enumeration of the recording status.
Definition at line 446 of file ZoomVideoSDKConstants.h.
Enumeration of session leave reasons.
Definition at line 793 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 250 of file ZoomVideoSDKConstants.h.
Enumeration of share preprocess types.
| Enumerator | |
|---|---|
| ZoomVideoSDKSharePreprocessType_none | For initialization. |
| ZoomVideoSDKSharePreprocessType_view | For share view |
Definition at line 873 of file ZoomVideoSDKConstants.h.
Enumeration of Zoom Video SDK share setting types.
Definition at line 883 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 726 of file ZoomVideoSDKConstants.h.
Enumeration of the streaming join status.
Definition at line 898 of file ZoomVideoSDKConstants.h.
Enumeration of video subscription failure reasons.
Definition at line 708 of file ZoomVideoSDKConstants.h.
Enumeration of subsession statuses.
Definition at line 831 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 524 of file ZoomVideoSDKConstants.h.
Enumeration of the microphone test statuses.
Definition at line 765 of file ZoomVideoSDKConstants.h.
Enumeration of the subsession user help request results.
Definition at line 858 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 383 of file ZoomVideoSDKConstants.h.
Enumeration of the UVC camera status.
| Enumerator | |
|---|---|
| ZoomVideoSDKUVCCameraStatus_Attached | UVC camera attached. |
| ZoomVideoSDKUVCCameraStatus_Detached | UVC camera detached. |
Definition at line 821 of file ZoomVideoSDKConstants.h.
Enumeration of the video aspect ratio.
Definition at line 275 of file ZoomVideoSDKConstants.h.
Enumeration of video preference modes.
Definition at line 464 of file ZoomVideoSDKConstants.h.
Enumeration of the directions of video raw data rotation.
Definition at line 343 of file ZoomVideoSDKConstants.h.
Enumeration of the render resolution.
Definition at line 357 of file ZoomVideoSDKConstants.h.
Enumeration of the video type.
| Enumerator | |
|---|---|
| ZoomVideoSDKVideoType_VideoData | Video Camera Data. |
| ZoomVideoSDKVideoType_ShareData | Share Data. |
Definition at line 289 of file ZoomVideoSDKConstants.h.
Enumeration of virtual background types.
Definition at line 591 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 944 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 954 of file ZoomVideoSDKConstants.h.