|
Meeting SDK for iOS API Reference
|
Defines all constants, enumerations, and data types used throughout the Zoom SDK. The AI Companion brand has been retired. AI-powered features are now more deeply integrated throughout Zoom Workplace. Existing APIs and SDKs that reference AI Companion will continue to function as before to ensure backward compatibility. More...
Go to the source code of this file.
Defines all constants, enumerations, and data types used throughout the Zoom SDK. The AI Companion brand has been retired. AI-powered features are now more deeply integrated throughout Zoom Workplace. Existing APIs and SDKs that reference AI Companion will continue to function as before to ensure backward compatibility.
Definition in file MobileRTCConstants.h.
| enum DialOutStatus |
Enumeration of the phone call status.
Definition at line 384 of file MobileRTCConstants.h.
Enumeration of reasons why a free meeting needs an upgrade.
Definition at line 1005 of file MobileRTCConstants.h.
| enum H323CallOutStatus |
Enumeration of the H.323/SIP outgoing call status.
Definition at line 424 of file MobileRTCConstants.h.
| enum JBHCmd |
Enumeration of the waiting UI when JBH is disabled.
| Enumerator | |
|---|---|
| JBHCmd_Show | Show JBH waiting command. |
| JBHCmd_Hide | Hide JBH waiting command. |
Definition at line 374 of file MobileRTCConstants.h.
| enum LeaveMeetingCmd |
Enumeration of the commands for leaving meeting.
| Enumerator | |
|---|---|
| LeaveMeetingCmd_Leave | Command of leaving meeting. |
| LeaveMeetingCmd_End | Command of ending Meeting. |
Definition at line 364 of file MobileRTCConstants.h.
Enumeration of the audio status.
Definition at line 526 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 546 of file MobileRTCConstants.h.
| enum MobileRTC_ZoomLocale |
Enumeration of locale for customer.
| Enumerator | |
|---|---|
| MobileRTC_ZoomLocale_Default | Default. |
| MobileRTC_ZoomLocale_CN | CN. |
Definition at line 950 of file MobileRTCConstants.h.
Enumeration of the AI companion types.
Definition at line 1803 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 621 of file MobileRTCConstants.h.
Enumeration of the 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 1472 of file MobileRTCConstants.h.
Enumeration of audio channel types.
| Enumerator | |
|---|---|
| MobileRTCAudioChannel_Mono | Mono audio channel. |
| MobileRTCAudioChannel_Stereo | Stereo audio channel. |
Definition at line 1636 of file MobileRTCConstants.h.
| enum MobileRTCAudioError |
Enumeration of audio-related operational error states.
Definition at line 510 of file MobileRTCConstants.h.
| enum MobileRTCAudioOutput |
Enumeration of the audio output description.
Definition at line 711 of file MobileRTCConstants.h.
Enumeration of 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 321 of file MobileRTCConstants.h.
| enum MobileRTCAuthError |
Enumeration of SDK authentication results.
Definition at line 90 of file MobileRTCConstants.h.
Enumeration of the auto framing modes in video.
Definition at line 1610 of file MobileRTCConstants.h.
Enumeration of the errors related to the Breakout Room (BO) controller operations.
Definition at line 1047 of file MobileRTCConstants.h.
| enum MobileRTCBOHelpReply |
Enumeration of the attendee request for help results.
Definition at line 1033 of file MobileRTCConstants.h.
Enumeration of the pre-assign breakout room data download status.
Definition at line 1069 of file MobileRTCConstants.h.
| enum MobileRTCBOStatus |
Enumeration of the Breakout Room (BO) status.
Definition at line 1017 of file MobileRTCConstants.h.
| enum MobileRTCCameraError |
Enumeration of camera-related operational error states.
Definition at line 558 of file MobileRTCConstants.h.
Enumeration of the reasons why sharing is not allowed.
Definition at line 1303 of file MobileRTCConstants.h.
Enumeration of the attendee chat permission in webinar.
| Enumerator | |
|---|---|
| MobileRTCChatAllowAttendeeChat_ChatWithNone | Chat is disabled. |
| MobileRTCChatAllowAttendeeChat_ChatWithAll | Chat with all. |
| MobileRTCChatAllowAttendeeChat_ChatWithPanelist | Chat with panelist. |
Definition at line 727 of file MobileRTCConstants.h.
Enumeration of the chat message delete type.
Definition at line 827 of file MobileRTCConstants.h.
Enumeration of chat types.
Definition at line 809 of file MobileRTCConstants.h.
Enumeration of the CLAIM HOST results in meeting.
| Enumerator | |
|---|---|
| MobileRTCClaimHostError_Successed | Claim host successfully. |
| MobileRTCClaimHostError_HostKeyError | Host Key Errors. |
| MobileRTCClaimHostError_NetWorkError | Network Errors. |
Definition at line 586 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 633 of file MobileRTCConstants.h.
Enumeration of meeting components.
Definition at line 458 of file MobileRTCConstants.h.
Enumeration of custom 3D avatar element color types.
Definition at line 1968 of file MobileRTCConstants.h.
Enumeration of custom 3D avatar element image types.
Definition at line 1928 of file MobileRTCConstants.h.
Enumeration of co-owner assets type.
| Enumerator | |
|---|---|
| MobileRTCDGrantCoOwnerAssetsType_None | For initialization. |
| MobileRTCDGrantCoOwnerAssetsType_Summary | Summary. |
| MobileRTCDGrantCoOwnerAssetsType_CloudRecording | CloudRecording. |
Definition at line 1894 of file MobileRTCConstants.h.
Enumeration of the direct sharing status.
Definition at line 1083 of file MobileRTCConstants.h.
Enumeration of the document creation permission options.
Definition at line 1879 of file MobileRTCConstants.h.
Enumeration of the document sharing permission options.
Definition at line 1865 of file MobileRTCConstants.h.
| enum MobileRTCDocsStatus |
Enumeration of the document sharing status in a meeting.
| Enumerator | |
|---|---|
| MobileRTCDocsStatus_Start | User starts sharing docs. |
| MobileRTCDocsStatus_Stop | User stops sharing docs. |
Definition at line 1855 of file MobileRTCConstants.h.
Enumeration of emoji feedback types.
Definition at line 1129 of file MobileRTCConstants.h.
Enumeration of the emoji reactions skin tone.
Definition at line 1147 of file MobileRTCConstants.h.
Enumeration of the 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 1109 of file MobileRTCConstants.h.
Enumeration of the face recognition failure strategies.
Definition at line 1622 of file MobileRTCConstants.h.
Enumeration of the status of the file transfer.
Definition at line 1815 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 1791 of file MobileRTCConstants.h.
Enumeration of the 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 865 of file MobileRTCConstants.h.
Enumeration of the H.323/SIP pairing status.
Definition at line 442 of file MobileRTCConstants.h.
Enumeration of the supported audio types in a Zoom meeting. This is a bitmask enumeration; multiple values can be combined using bitwise OR.
Definition at line 1460 of file MobileRTCConstants.h.
Enumeration of invite meeting types.
Definition at line 1556 of file MobileRTCConstants.h.
Enumeration of the information needed to Join Meeting.
Definition at line 645 of file MobileRTCConstants.h.
Enumeration of the live stream status.
Definition at line 570 of file MobileRTCConstants.h.
Enumeration of the live transcription operation types.
Definition at line 1390 of file MobileRTCConstants.h.
Enumeration of the live transcription status.
Definition at line 1374 of file MobileRTCConstants.h.
Enumeration of the local recording request privilege settings.
Definition at line 1492 of file MobileRTCConstants.h.
Enumeration of the login failure reasons.
Definition at line 122 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_AuthorizedUserNotInMeeting | Authorized user not in meeting. |
| MobileRTCMeetError_OnBehalfTokenConflictLoginError | On-behalf token error: conflict with login credentials. |
| MobileRTCMeetError_UserLevelTokenNotHaveHostZakObf | User level privilege token not have host zak/obf. |
| MobileRTCMeetError_AppCanNotAnonymousJoinMeeting | App can not anonymous join meeting. |
| MobileRTCMeetError_OnBehalfTokenInvalid | On-behalf token invalid. |
| MobileRTCMeetError_OnBehalfTokenNotMatchMeeting | On-behalf token meeting number not match. |
| MobileRTCMeetError_Unknown | Unknown error. |
Definition at line 166 of file MobileRTCConstants.h.
Enumeration of the meeting chat types in meeting.
Definition at line 781 of file MobileRTCConstants.h.
Enumeration of meeting encryption types.
| Enumerator | |
|---|---|
| MobileRTCMeetingEncryptionType_None | For initialization. |
| MobileRTCMeetingEncryptionType_Enhanced | Enhanced. |
| MobileRTCMeetingEncryptionType_E2EE | E2EE. |
Definition at line 610 of file MobileRTCConstants.h.
Enumeration of the meeting end reasons.
Definition at line 673 of file MobileRTCConstants.h.
Enumeration of audio types in meeting.
Definition at line 751 of file MobileRTCConstants.h.
Enumeration of the meeting recording types in meeting.
Definition at line 767 of file MobileRTCConstants.h.
Enumeration of the meeting status.
Definition at line 285 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 1167 of file MobileRTCConstants.h.
Enumeration of the audio errors.
Definition at line 661 of file MobileRTCConstants.h.
Enumeration of the Minimize Meeting states in Zoom UI.
| Enumerator | |
|---|---|
| MobileRTCMinimizeMeeting_ShowMinimizeMeeting | Show miniimize meeting. |
| MobileRTCMinimizeMeeting_BackFullScreenMeeting | Back to full screen meeting. |
Definition at line 995 of file MobileRTCConstants.h.
Enumeration of the connection quality.
Definition at line 490 of file MobileRTCConstants.h.
Enumeration of the notification service error codes.
Definition at line 1437 of file MobileRTCConstants.h.
Enumeration of the type for alive connect service status.
Definition at line 1421 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 797 of file MobileRTCConstants.h.
| enum MobileRTCPinResult |
Enumeration of possible results for pinning a user.
Definition at line 1906 of file MobileRTCConstants.h.
Enumeration of the polling action types.
Definition at line 1766 of file MobileRTCConstants.h.
Enumeration of the polling question types. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057587.
Definition at line 1740 of file MobileRTCConstants.h.
Enumeration of polling statuses.
Definition at line 1714 of file MobileRTCConstants.h.
| enum MobileRTCPollingType |
Enumeration of polling types.
Definition at line 1728 of file MobileRTCConstants.h.
Enumeration of the 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 1570 of file MobileRTCConstants.h.
Enumeration of the raw data.
Definition at line 889 of file MobileRTCConstants.h.
Enumeration of memory modes for raw data handling.
| Enumerator | |
|---|---|
| MobileRTCRawDataMemoryModeStack | Use stack memory. |
| MobileRTCRawDataMemoryModeHeap | Use heap memory. |
Definition at line 940 of file MobileRTCConstants.h.
Enumeration of the recording status.
Definition at line 1199 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 1598 of file MobileRTCConstants.h.
Enumeration of reminder types.
Definition at line 1506 of file MobileRTCConstants.h.
Enumeration of remote control-related operational result in meeting.
Definition at line 697 of file MobileRTCConstants.h.
Enumeration of the status of the local recording permission request.
Definition at line 1217 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 1646 of file MobileRTCConstants.h.
| enum MobileRTCSDKError |
Enumeration of the SDK error.
Definition at line 10 of file MobileRTCConstants.h.
Enumeration of the 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 598 of file MobileRTCConstants.h.
Enumeration of the types of shared content.
Definition at line 1229 of file MobileRTCConstants.h.
Enumeration of the 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 1285 of file MobileRTCConstants.h.
Enumeration of the sharing status.
Definition at line 1260 of file MobileRTCConstants.h.
Enumeration of the status of the sign language interpretation.
Definition at line 1408 of file MobileRTCConstants.h.
Enumeration of the SMS retrieve result.
Definition at line 975 of file MobileRTCConstants.h.
Enumeration of the SMS verify result.
Definition at line 960 of file MobileRTCConstants.h.
Enumeration of the type for video subscribe failed reason.
Definition at line 1351 of file MobileRTCConstants.h.
| enum MobileRTCUserRole |
Enumeration of user roles.
Definition at line 1181 of file MobileRTCConstants.h.
| enum MobileRTCUserType |
Enumeration of user types.
Definition at line 346 of file MobileRTCConstants.h.
Enumeration of the UVC camera types.
| Enumerator | |
|---|---|
| MobileRTCUVCCameraStatus_Attached | UVC camera attached. |
| MobileRTCUVCCameraStatus_Detached | UVC camera detached. |
Definition at line 1831 of file MobileRTCConstants.h.
| enum MobileRTCVBType |
Enumeration of the 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 1338 of file MobileRTCConstants.h.
Enumeration of the video preference modes.
Definition at line 1841 of file MobileRTCConstants.h.
Enumeration of the video quality.
Definition at line 476 of file MobileRTCConstants.h.
Enumeration of the colorspace of acquired raw video data.
Definition at line 332 of file MobileRTCConstants.h.
Enumeration of the directions of video.
Definition at line 875 of file MobileRTCConstants.h.
Enumeration of the video resolution options.
Definition at line 851 of file MobileRTCConstants.h.
| enum MobileRTCVideoType |
Enumeration of video types.
| Enumerator | |
|---|---|
| MobileRTCVideoType_VideoData | Video Camera Data. |
| MobileRTCVideoType_ShareData | Share Data. |
Definition at line 841 of file MobileRTCConstants.h.
Enumeration of promoting/demoting attendee and panelist errors in webinar.
Definition at line 739 of file MobileRTCConstants.h.
Enumeration of the whiteboard create options.
Definition at line 1692 of file MobileRTCConstants.h.
Enumeration of the whiteboard share options.
Definition at line 1680 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 1704 of file MobileRTCConstants.h.