Meeting SDK for iOS API Reference
|
Defines all constants, enumerations, and data types used throughout the Zoom SDK. More...
Go to the source code of this file.
Defines all constants, enumerations, and data types used throughout the Zoom SDK.
Definition in file MobileRTCConstants.h.
enum DialOutStatus |
Enumeration of phone call status.
Definition at line 369 of file MobileRTCConstants.h.
Enumeration indicating reasons why a free meeting needs an upgrade.
Definition at line 983 of file MobileRTCConstants.h.
enum H323CallOutStatus |
Enumeration of H.323/SIP outgoing call status.
Definition at line 409 of file MobileRTCConstants.h.
enum JBHCmd |
Enumeration of waiting UI when JBH is disabled.
Enumerator | |
---|---|
JBHCmd_Show | Show JBH waiting command. |
JBHCmd_Hide | Hide JBH waiting command. |
Definition at line 359 of file MobileRTCConstants.h.
enum LeaveMeetingCmd |
Enumeration of commands for leaving meeting.
Enumerator | |
---|---|
LeaveMeetingCmd_Leave | Command of leaving meeting. |
LeaveMeetingCmd_End | Command of ending Meeting. |
Definition at line 349 of file MobileRTCConstants.h.
Enumeration of Audio status.
Definition at line 511 of file MobileRTCConstants.h.
Enumeration of the status of a user's video.
Enumerator | |
---|---|
MobileRTC_VideoStatus_Video_ON | Video is turned on. |
MobileRTC_VideoStatus_Video_OFF | Video is turned off. |
MobileRTC_VideoStatus_Video_Muted_ByHost | Video is muted by the host. |
Definition at line 531 of file MobileRTCConstants.h.
enum MobileRTC_ZoomLocale |
Locale fo Customer.
Enumerator | |
---|---|
MobileRTC_ZoomLocale_Default | Default. |
MobileRTC_ZoomLocale_CN | CN. |
Definition at line 928 of file MobileRTCConstants.h.
Enumeration of AI companion types.
Definition at line 1791 of file MobileRTCConstants.h.
enum MobileRTCANNError |
Enumeration of App Signaling.
Definition at line 1350 of file MobileRTCConstants.h.
Enumeration of annotation-related operational error states.
Enumerator | |
---|---|
MobileRTCAnnotationError_Successed | Succeeded. |
MobileRTCAnnotationError_Failed | Failed. |
MobileRTCAnnotationError_PermissionDenied | No permission. |
Definition at line 606 of file MobileRTCConstants.h.
Enumeration of attendee view modes in a Zoom meeting. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063672.
Definition at line 1462 of file MobileRTCConstants.h.
Enumeration of audio channel types.
Enumerator | |
---|---|
MobileRTCAudioChannel_Mono | Mono audio channel. |
MobileRTCAudioChannel_Stereo | Stereo audio channel. |
Definition at line 1624 of file MobileRTCConstants.h.
enum MobileRTCAudioError |
Enumeration of audio-related operational error states.
Definition at line 495 of file MobileRTCConstants.h.
enum MobileRTCAudioOutput |
Enumeration of audio output description.
Definition at line 692 of file MobileRTCConstants.h.
Enumeration representing the sampling rate of acquired raw audio data.
Enumerator | |
---|---|
MobileRTCAudioRawdataSamplingRate_32K | The sampling rate of the acquired raw audio data is 32K. |
MobileRTCAudioRawdataSamplingRate_48K | The sampling rate of the acquired raw audio data is 48K. |
Definition at line 306 of file MobileRTCConstants.h.
enum MobileRTCAuthError |
Enumeration of SDK authentication results.
Definition at line 87 of file MobileRTCConstants.h.
Enumeration of auto framing modes in video.
Definition at line 1598 of file MobileRTCConstants.h.
Enumeration of the errors related to the Breakout Room (BO) controller operations.
Definition at line 1025 of file MobileRTCConstants.h.
enum MobileRTCBOHelpReply |
Enumeration of attendee request for help results.
Definition at line 1011 of file MobileRTCConstants.h.
Enumeration of the pre-assign breakout room data download status.
Definition at line 1047 of file MobileRTCConstants.h.
enum MobileRTCBOStatus |
Enumeration of Breakout Room (BO) status.
Definition at line 995 of file MobileRTCConstants.h.
enum MobileRTCCameraError |
Enumeration of camera-related operational error states.
Definition at line 543 of file MobileRTCConstants.h.
Enumeration of reasons why sharing is not allowed.
Definition at line 1281 of file MobileRTCConstants.h.
Enumeration of attendee chat permission in webinar.
Enumerator | |
---|---|
MobileRTCChatAllowAttendeeChat_ChatWithNone | Chat is disabled. |
MobileRTCChatAllowAttendeeChat_ChatWithAll | Chat with all. |
MobileRTCChatAllowAttendeeChat_ChatWithPanelist | Chat with panelist. |
Definition at line 708 of file MobileRTCConstants.h.
Enumeration of the chat message delete type.
Definition at line 808 of file MobileRTCConstants.h.
Enumeration of chat types.
Definition at line 790 of file MobileRTCConstants.h.
Enumeration of CLAIM HOST results in meeting.
Enumerator | |
---|---|
MobileRTCClaimHostError_Successed | Claim host successfully. |
MobileRTCClaimHostError_HostKeyError | Host Key Errors. |
MobileRTCClaimHostError_NetWorkError | Network Errors. |
Definition at line 571 of file MobileRTCConstants.h.
enum MobileRTCCMRError |
Enumeration of CMR-related result error states.
Enumerator | |
---|---|
MobileRTCCMRError_Successed | Succeeded. |
MobileRTCCMRError_Failed | Failed. |
MobileRTCCMRError_StorageFull | The storage is full. |
Definition at line 618 of file MobileRTCConstants.h.
Enumeration of security session types. Marked as deprecated, no longer used.
Definition at line 443 of file MobileRTCConstants.h.
Enumeration of co-owner assets type.
Enumerator | |
---|---|
MobileRTCDGrantCoOwnerAssetsType_None | For initialization. |
MobileRTCDGrantCoOwnerAssetsType_Summary | Summary. |
MobileRTCDGrantCoOwnerAssetsType_CloudRecording | CloudRecording. |
Definition at line 1882 of file MobileRTCConstants.h.
Enumeration of direct sharing status.
Definition at line 1061 of file MobileRTCConstants.h.
Enumeration of document creation permission options.
Definition at line 1867 of file MobileRTCConstants.h.
Enumeration of document sharing permission options.
Definition at line 1853 of file MobileRTCConstants.h.
enum MobileRTCDocsStatus |
Enumeration of document sharing status in a meeting.
Enumerator | |
---|---|
MobileRTCDocsStatus_Start | User starts sharing docs. |
MobileRTCDocsStatus_Stop | User stops sharing docs. |
Definition at line 1843 of file MobileRTCConstants.h.
Enumeration of emoji feedback types.
Definition at line 1107 of file MobileRTCConstants.h.
Enumeration of emoji reactions skin tone.
Definition at line 1125 of file MobileRTCConstants.h.
Enumeration of available emoji reaction types. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060612.
Definition at line 1087 of file MobileRTCConstants.h.
Enumeration of face recognition failure strategies.
Definition at line 1610 of file MobileRTCConstants.h.
Enumeration of the status of a file transfer.
Definition at line 1803 of file MobileRTCConstants.h.
Enumeration of the focus mode share type. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063004.
Definition at line 1779 of file MobileRTCConstants.h.
Enumeration of video frame data format.
Enumerator | |
---|---|
MobileRTCFrameDataFormat_I420 | I420 format with limited (TV) range color space. |
MobileRTCFrameDataFormat_I420_Limit | I420 format with full (PC) range color space. |
Definition at line 843 of file MobileRTCConstants.h.
Enumeration of H.323/SIP pairing status.
Definition at line 427 of file MobileRTCConstants.h.
Enumeration of supported audio types in a Zoom meeting. This is a bitmask enumeration; multiple values can be combined using bitwise OR.
Definition at line 1450 of file MobileRTCConstants.h.
Enumeration of invite meeting types.
Definition at line 1544 of file MobileRTCConstants.h.
Enumeration of information needed to Join Meeting.
Definition at line 630 of file MobileRTCConstants.h.
Enumeration of live stream status.
Definition at line 555 of file MobileRTCConstants.h.
Enumeration of live transcription operation types.
Definition at line 1380 of file MobileRTCConstants.h.
Enumeration of live transcription status.
Definition at line 1364 of file MobileRTCConstants.h.
Enumeration of local recording request privilege settings.
Definition at line 1482 of file MobileRTCConstants.h.
Enumeration of the login failure reasons.
Definition at line 119 of file MobileRTCConstants.h.
enum MobileRTCMeetError |
Enumeration of errors to start/join meeting.
Enumerator | |
---|---|
MobileRTCMeetError_Success | Start/Join meeting successfully. |
MobileRTCMeetError_ConnectionError | The connection with the backend service has errors. |
MobileRTCMeetError_ReconnectError | Failed to reconnect the meeting. |
MobileRTCMeetError_MMRError | MMR issue, please check MMR configuration. |
MobileRTCMeetError_PasswordError | The meeting password is incorrect. |
MobileRTCMeetError_SessionError | Failed to create video and audio data connection with MMR. |
MobileRTCMeetError_MeetingOver | Meeting is over. |
MobileRTCMeetError_MeetingNotStart | Meeting is not started. |
MobileRTCMeetError_MeetingNotExist | The meeting does not exist. |
MobileRTCMeetError_MeetingUserFull | The amount of attendees reaches the upper limit, For users that can' t join the meeting.they can go to watch live stream with the interface MobileRTCMeetingServiceDelegate::onMeetingFullToWatchLiveStream: ,if the host has started. |
MobileRTCMeetError_MeetingClientIncompatible | The MobileRTC version is incompatible. |
MobileRTCMeetError_NoMMR | No MMR is valid. |
MobileRTCMeetError_MeetingLocked | The meeting is locked by the host. |
MobileRTCMeetError_MeetingRestricted | The meeting is restricted. |
MobileRTCMeetError_MeetingRestrictedJBH | The meeting is restricted to join before host. |
MobileRTCMeetError_CannotEmitWebRequest | Failed to request the web server. |
MobileRTCMeetError_CannotStartTokenExpire | Failed to start meeting with expired token. |
MobileRTCMeetError_VideoError | The user's video does not work. |
MobileRTCMeetError_AudioAutoStartError | The user's audio cannot auto-start. |
MobileRTCMeetError_RegisterWebinarFull | The amount of webinar attendees reaches the upper limit. |
MobileRTCMeetError_RegisterWebinarHostRegister | User needs to register a webinar account if he wants to start a webinar. |
MobileRTCMeetError_RegisterWebinarPanelistRegister | User needs to register an account if he wants to join the webinar by the link. |
MobileRTCMeetError_RegisterWebinarDeniedEmail | The host has denied your webinar registration. |
MobileRTCMeetError_RegisterWebinarEnforceLogin | Sign in with the specified account to join webinar. |
MobileRTCMeetError_ZCCertificateChanged | The certificate of ZC has been changed. |
MobileRTCMeetError_VanityNotExist | The vanity URL does not exist. |
MobileRTCMeetError_JoinWebinarWithSameEmail | The email address has already been registered in the current webinar. |
MobileRTCMeetError_WriteConfigFile | Failed to write configure file. |
MobileRTCMeetError_RemovedByHost | Meeting is removed by the host. |
MobileRTCMeetError_HostDisallowOutsideUserJoin | Forbidden to join meeting. |
MobileRTCMeetError_UnableToJoinExternalMeeting | To join a meeting hosted by an external Zoom account, your SDK app has to be published on Zoom Marketplace. You can refer to Section 6.1 of Zoom's API License Terms of Use. |
MobileRTCMeetError_BlockedByAccountAdmin | Join failed because this Meeting SDK key is blocked by the host’s account admin. |
MobileRTCMeetError_NeedSignInForPrivateMeeting | Need sign in using the same account as the meeting organizer. |
MobileRTCMeetError_FailNeedConfirmPlink | The join meeting param vanityID is duplicated, and needs to be confirmed. |
MobileRTCMeetError_FailNeedInputPlink | The join meeting param vanityID does not exist in the current account. |
MobileRTCMeetError_InvalidArguments | Invalid arguments. |
MobileRTCMeetError_InvalidUserType | Invalid user Type. |
MobileRTCMeetError_InAnotherMeeting | The user joins already another ongoing meeting. |
MobileRTCMeetError_TooFrequenceCall | The request too frequence. |
MobileRTCMeetError_WrongUsage | Wrong usage of the api. |
MobileRTCMeetError_Failed | Failed of the api call. |
MobileRTCMeetError_VBBase | The virtual background error base. |
MobileRTCMeetError_VBSetError | Set image for virtual background error = MobileRTCMeetError_VBBase. |
MobileRTCMeetError_VBMaximumNum | Virtual background image reach to max capacity. |
MobileRTCMeetError_VBSaveImage | Virtual background save the image error. |
MobileRTCMeetError_VBRemoveNone | Virtual background save the image error. |
MobileRTCMeetError_VBNoSupport | Virtual background not support. |
MobileRTCMeetError_VBGreenScreenNoSupport | Virtual background GreenScreen not support, only iPad support green screen. |
MobileRTCMeetError_AppPrivilegeTokenError | App privilege token error. |
MobileRTCMeetError_Unknown | Unknown error. |
Definition at line 163 of file MobileRTCConstants.h.
Enumeration of meeting chat types in meeting.
Definition at line 762 of file MobileRTCConstants.h.
Type of meeting encryption.
Enumerator | |
---|---|
MobileRTCMeetingEncryptionType_None | For initialization. |
MobileRTCMeetingEncryptionType_Enhanced | Enhanced. |
MobileRTCMeetingEncryptionType_E2EE | E2EE. |
Definition at line 595 of file MobileRTCConstants.h.
Enumeration of Audio Errors.
Definition at line 656 of file MobileRTCConstants.h.
Enumeration of audio types in meeting.
Definition at line 732 of file MobileRTCConstants.h.
Enumeration of meeting recording types in meeting.
Definition at line 748 of file MobileRTCConstants.h.
Enumeration of meeting status.
Definition at line 270 of file MobileRTCConstants.h.
enum MobileRTCMeetingType |
Enumeration of meeting types.
Enumerator | |
---|---|
MobileRTCMeetingType_None | There is no meeting. |
MobileRTCMeetingType_Normal | Normal meeting. |
MobileRTCMeetingType_BreakoutRoom | Breakout meeting. |
MobileRTCMeetingType_Webinar | Webinar. |
Definition at line 1145 of file MobileRTCConstants.h.
Enumeration of Audio Errors.
Definition at line 644 of file MobileRTCConstants.h.
Enumeration of Minimize Meeting states in Zoom UI.
Enumerator | |
---|---|
MobileRTCMinimizeMeeting_ShowMinimizeMeeting | Show miniimize meeting. |
MobileRTCMinimizeMeeting_BackFullScreenMeeting | Back to full screen meeting. |
Definition at line 973 of file MobileRTCConstants.h.
Enumeration of connection quality.
Definition at line 475 of file MobileRTCConstants.h.
Enumeration of notification service error codes.
Definition at line 1427 of file MobileRTCConstants.h.
Enumeration of the type for alive connect service status.
Definition at line 1411 of file MobileRTCConstants.h.
Enumeration of webinar panelist types.
Enumerator | |
---|---|
MobileRTCPanelistChatPrivilege_INVALID | Default status, can't set this. |
MobileRTCPanelistChatPrivilege_PANELIST | Can chat to all panelist. |
MobileRTCPanelistChatPrivilege_ALL | Can chat to all. |
Definition at line 778 of file MobileRTCConstants.h.
enum MobileRTCPinResult |
Enumeration of possible results for pinning a user.
Definition at line 1894 of file MobileRTCConstants.h.
Enumeration of polling action types.
Definition at line 1754 of file MobileRTCConstants.h.
Enumeration of polling question types. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057587.
Definition at line 1728 of file MobileRTCConstants.h.
Enumeration of polling statuses.
Definition at line 1702 of file MobileRTCConstants.h.
enum MobileRTCPollingType |
Enumeration of polling types.
Definition at line 1716 of file MobileRTCConstants.h.
Enumeration of user's presence status. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065488.
Definition at line 1558 of file MobileRTCConstants.h.
Enumeration of raw data.
Definition at line 867 of file MobileRTCConstants.h.
Enumeration of memory modes for raw data handling.
Enumerator | |
---|---|
MobileRTCRawDataMemoryModeStack | Use stack memory. |
MobileRTCRawDataMemoryModeHeap | Use heap memory. |
Definition at line 918 of file MobileRTCConstants.h.
Enumeration of recording status.
Definition at line 1177 of file MobileRTCConstants.h.
Enumeration of the reminder action type.
Enumerator | |
---|---|
MobileRTCReminderActionType_None | Need no more action. |
MobileRTCReminderActionType_NeedSignIn | Need to sign in. |
MobileRTCReminderActionType_NeedSwitchAccount | Need to switch account. |
Definition at line 1586 of file MobileRTCConstants.h.
Enumeration of reminder types.
Definition at line 1496 of file MobileRTCConstants.h.
Enumeration of remote control-related operational result in meeting.
Definition at line 678 of file MobileRTCConstants.h.
Enumeration of the status of a local recording permission request.
Definition at line 1195 of file MobileRTCConstants.h.
Enumeration of the content font style type for chat message. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064400.
Definition at line 1634 of file MobileRTCConstants.h.
enum MobileRTCSDKError |
Enumeration of SDK error.
Definition at line 9 of file MobileRTCConstants.h.
Enumeration of SENDING CHAT MESSAGE result in meeting.
Enumerator | |
---|---|
MobileRTCSendChatError_Successed | Send chat message successfully. |
MobileRTCSendChatError_Failed | Send chat message failed. |
MobileRTCSendChatError_PermissionDenied | No permission. |
Definition at line 583 of file MobileRTCConstants.h.
Enumeration of types of shared content.
Definition at line 1207 of file MobileRTCConstants.h.
Enumeration of LockShare Status changed.
Enumerator | |
---|---|
MobileRTCShareSettingType_None | Share settings type none. |
MobileRTCShareSettingType_LockShare | Only host can share, the same as "lock share" |
MobileRTCShareSettingType_HostGrab | Anyone can share, but only one can share at a moment, and only the host can start sharing when another user is sharing. The previous share will be ended once the host grabs the sharing. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0058730#h_01GCCD82NKKECQ6QJNH6F4CTWA. |
MobileRTCShareSettingType_AnyoneGrab | Anyone can share, but one sharing only at one moment, and anyone can grab other's sharing. |
MobileRTCShareSettingType_MultiShare | Anyone can share, Multi-share can exist at the same time. |
Definition at line 1263 of file MobileRTCConstants.h.
Enumeration of sharing status.
Definition at line 1238 of file MobileRTCConstants.h.
Enumeration of the status of sign language interpretation.
Definition at line 1398 of file MobileRTCConstants.h.
Enumeration of SMS retrieve result.
Definition at line 953 of file MobileRTCConstants.h.
For SMS service usage.
Definition at line 938 of file MobileRTCConstants.h.
Enumeration of the type for video subscribe failed reason.
Definition at line 1329 of file MobileRTCConstants.h.
enum MobileRTCUserRole |
Enumeration of user roles.
Definition at line 1159 of file MobileRTCConstants.h.
enum MobileRTCUserType |
Enumerates the types of users.
Definition at line 331 of file MobileRTCConstants.h.
Enumeration of UVC camera types.
Enumerator | |
---|---|
MobileRTCUVCCameraStatus_Attached | UVC camera attached. |
MobileRTCUVCCameraStatus_Detached | UVC camera detached. |
Definition at line 1819 of file MobileRTCConstants.h.
enum MobileRTCVBType |
Enumeration of virtual background type in MobileRTCVirtualBGImageInfo .
Enumerator | |
---|---|
MobileRTCVBType_None | Virtual background type none. |
MobileRTCVBType_Blur | Virtual background type blur. |
MobileRTCVBType_Item | Virtual background type with image. |
Definition at line 1316 of file MobileRTCConstants.h.
Enumeration of video preference modes.
Definition at line 1829 of file MobileRTCConstants.h.
Enumeration of video quality.
Definition at line 461 of file MobileRTCConstants.h.
Enumeration representing the colorspace of acquired raw video data.
Definition at line 317 of file MobileRTCConstants.h.
Enumeration of directions of video.
Definition at line 853 of file MobileRTCConstants.h.
Enumeration of video resolution options.
Definition at line 829 of file MobileRTCConstants.h.
enum MobileRTCVideoType |
Enumerator | |
---|---|
MobileRTCVideoType_VideoData | Video Camera Data. |
MobileRTCVideoType_ShareData | Share Data. |
Definition at line 819 of file MobileRTCConstants.h.
Enumeration of promoting/demoting attendee and panelist errors in webinar.
Definition at line 720 of file MobileRTCConstants.h.
Enumeration of the whiteboard create options.
Definition at line 1680 of file MobileRTCConstants.h.
Enumeration of the whiteboard share options.
Definition at line 1668 of file MobileRTCConstants.h.
Enumeration of the whiteboard status.
Enumerator | |
---|---|
MobileRTCWhiteboardStatus_Started | User stared sharing their whiteboard. |
MobileRTCWhiteboardStatus_Stopped | User stopped sharing their whiteboard. |
Definition at line 1692 of file MobileRTCConstants.h.