iOS SDK API Reference
Loading...
Searching...
No Matches
MobileRTCConstants.h
Go to the documentation of this file.
1//
2// MobileRTCConstants.h
3// MobileRTC
4//
5// Created by Zoom Video Communications on 8/7/14.
6// Copyright (c) 2019 Zoom Video Communications, Inc. All rights reserved.
7//
8
12typedef NS_ENUM(NSUInteger, MobileRTCSDKError) {
47};
48
52typedef NS_ENUM(NSUInteger, MobileRTCAuthError) {
77};
78
82typedef NS_ENUM(NSUInteger, MobileRTCLoginFailReason) {
113 // invalid arguements error.
115 // SDK not authorized error.
117 // login failed for now is in auto login process.
119 // login failed for now is already logged in.
121};
122
126typedef NS_ENUM(NSUInteger, MobileRTCMeetError) {
215
218
219};
220
224typedef NS_ENUM(NSUInteger, MobileRTCMeetingState) {
241};
242
246typedef NS_ENUM(NSUInteger, MobileRTCUserType) {
259};
260
264typedef NS_ENUM(NSUInteger, LeaveMeetingCmd) {
269};
270
274typedef NS_ENUM(NSUInteger, JBHCmd) {
279};
280
284typedef NS_ENUM(NSUInteger, DialOutStatus) {
319};
320
324typedef NS_ENUM(NSUInteger, H323CallOutStatus) {
337};
338
342typedef NS_ENUM(NSUInteger, MobileRTCH323ParingStatus) {
353};
354
358typedef NS_ENUM(NSUInteger, MobileRTCComponentType) {
371};
372
376typedef NS_ENUM(NSInteger, MobileRTCVideoQuality) {
385};
386
390typedef NS_ENUM(NSInteger, MobileRTCNetworkQuality) {
405};
406
410typedef NS_ENUM(NSUInteger, MobileRTCAudioError) {
422
423
424typedef NS_ENUM(NSUInteger, MobileRTC_AudioStatus) {
439};
440
441typedef NS_ENUM(NSUInteger, MobileRTC_VideoStatus) {
448};
449
453typedef NS_ENUM(NSUInteger, MobileRTCCameraError) {
460};
461
465typedef NS_ENUM(NSUInteger, MobileRTCLiveStreamStatus) {
472};
473
477typedef NS_ENUM(NSUInteger, MobileRTCClaimHostError) {
484};
485
489typedef NS_ENUM(NSUInteger, MobileRTCSendChatError) {
496};
497
501typedef NS_ENUM(NSUInteger, MobileRTCAnnotationError) {
508};
509
513typedef NS_ENUM(NSUInteger, MobileRTCCMRError) {
520};
521
525typedef NS_ENUM(NSUInteger, MobileRTCJoinMeetingInfo) {
534};
535
539typedef NS_ENUM(NSUInteger, MobileRTCMicrophoneError) {
546};
547
551typedef NS_ENUM(NSUInteger, MobileRTCMeetingEndReason) {
570};
571
575typedef NS_ENUM(NSUInteger, MobileRTCRemoteControlError) {
584};
585
589typedef NS_ENUM(NSUInteger, MobileRTCAudioOutput) {
600};
601
605typedef NS_ENUM(NSUInteger, MobileRTCChatAllowAttendeeChat) {
612};
613
617typedef NS_ENUM(NSUInteger, MobileRTCWebinarPromoteorDepromoteError) {
624};
625
629typedef NS_ENUM(NSUInteger, MobileRTCMeetingItemAudioType) {
640};
641
645typedef NS_ENUM(NSUInteger, MobileRTCMeetingItemRecordType) {
654};
655
659typedef NS_ENUM(NSUInteger, MobileRTCMeetingChatPriviledgeType) {
670};
671
675typedef NS_ENUM(NSUInteger, MobileRTCPanelistChatPrivilegeType) {
682};
683
687typedef NS_ENUM(NSUInteger, MobileRTCChatMessageType) {
700};
701
705typedef NS_ENUM(NSUInteger, MobileRTCChatMessageDeleteType) {
714};
715
716typedef NS_ENUM(NSUInteger, MobileRTCVideoType) {
721};
722
726typedef NS_ENUM(NSUInteger, MobileRTCVideoResolution) {
735};
736
740typedef NS_ENUM(NSUInteger, MobileRTCVideoRawDataFormat) {
743};
744
748typedef NS_ENUM(NSInteger, MobileRTCVideoRawDataRotation) {
757};
758
762typedef NS_ENUM(NSUInteger,MobileRTCRawDataError)
763{
772
777
782
788
792typedef NS_ENUM(NSUInteger, MobileRTCRawDataMemoryMode) {
796
800typedef NS_ENUM(NSUInteger, MobileRTC_ZoomLocale) {
804
808typedef NS_ENUM(NSUInteger, MobileRTCSMSVerifyResult) {
814};
815
816typedef NS_ENUM(NSUInteger, MobileRTCSMSRetrieveResult) {
824};
825
829typedef NS_ENUM(NSUInteger, MobileRTCMinimizeMeetingState) {
833
837typedef NS_ENUM(NSUInteger, FreeMeetingNeedUpgradeType) {
841};
842
846typedef NS_ENUM(NSUInteger, MobileRTCBOStatus) {
848 MobileRTCBOStatus_Edit = 1, //<edit & assign
851 MobileRTCBOStatus_Ended //<BO is ended
853
857typedef NS_ENUM(NSUInteger, MobileRTCBOHelpReply) {
858 MobileRTCBOHelpReply_Idle = 0, //host receive the help request and there is no other one currently requesting for help
859 MobileRTCBOHelpReply_Busy, //host is handling other's request with the request dialog, no chance to show dialog for this request
860 MobileRTCBOHelpReply_Ignore, //host click "later" button or close the request dialog directly
861 MobileRTCBOHelpReply_alreadyInBO //host already in your BO meeting
863
867typedef NS_ENUM(NSUInteger, MobileRTCBOControllerError) {
877
881typedef NS_ENUM(NSUInteger, MobileRTCDirectShareStatus) {
882 MobileRTCDirectShareStatus_Unknown = 0, //<Only for initialization.
883 MobileRTCDirectShareStatus_Connecting, //<Waiting for enabling the direct sharing.
885 MobileRTCDirectShareStatus_Ended, //<End the direct sharing.
886 MobileRTCDirectShareStatus_Need_MeetingID_Or_PairingCode, //<Re-enter the meeting ID/paring code.
887 MobileRTCDirectShareStatus_NetWork_Error, //<Network error. Please try again later.
888 MobileRTCDirectShareStatus_Other_Error, //<Other errors. Mainly occur in SIP call mode.
890 MobileRTCDirectShareStatus_Need_Input_New_ParingCode, //<require input paringCode again for users on a different network.
893
897typedef NS_ENUM(NSUInteger, MobileRTCEmojiReactionType) {
905};
906
910typedef NS_ENUM(NSUInteger, MobileRTCEmojiReactionSkinTone) {
918};
919
923typedef NS_ENUM(NSUInteger, MobileRTCMeetingType) {
924 //There is no meeting.
926 //Normal meeting.
928 //Breakout meeting.
930 //Webinar.
932};
933
937typedef NS_ENUM(NSUInteger, MobileRTCUserRole) {
938 //For initialization.
940 //Host.
942 //Co-host.
944 //Attendee in the webinar.
946 //Panelist.
948 //Moderator of breakout room.
950};
951
955typedef NS_ENUM(NSUInteger, MobileRTCRecordingStatus) {
956 //recording start.
958 //recording stop.
960 //Pause recording.
962 //recording connecting.
964 //recording disk full.
966};
967
971typedef NS_ENUM(NSUInteger, MobileRTCSharingStatus)
972{
991};
992
996typedef NS_ENUM(NSUInteger, MobileRTCShareSettingType)
997{
1008
1009};
1010
1014typedef NS_ENUM(NSInteger, MobileRTCVBType)
1015{
1023
1027typedef NS_ENUM(NSInteger, MobileRTCSubscribeFailReason)
1028{
1035};
1036
1040typedef NS_ENUM(NSUInteger, MobileRTCANNError) {
1049};
1050
1054typedef NS_ENUM(NSUInteger, MobileRTCLiveTranscriptionStatus) {
1065};
1066
1070typedef NS_ENUM(NSUInteger, MobileRTCLiveTranscriptionOperationType) {
1085};
1086
1087typedef NS_ENUM(NSInteger,MobileRTCSignInterpretationStatus)
1088{
1090 MobileRTCSignInterpretationStatus_Started, //<sign interpretation stared.
1091 MobileRTCSignInterpretationStatus_Stopped, //<sign interpretation stopped.
1092};
1093
1097typedef NS_ENUM(NSInteger, MobileRTCNotificationServiceStatus) {
1104
1108typedef NS_ENUM(NSInteger, MobileRTCAttendeeViewMode){
1117
1121typedef NS_ENUM(NSInteger, MobileRTCInMeetingSupportAudioType) {
MobileRTCMeetError
MobileRTCMeetError An enumeration of Meeting States.
@ MobileRTCMeetError_VBMaximumNum
Virtual background image reach to max capacity.
@ MobileRTCMeetError_VanityNotExist
The vanity URL does not exist.
@ MobileRTCMeetError_RegisterWebinarHostRegister
User needs to register a webinar account if he wants to start a webinar.
@ MobileRTCMeetError_MeetingNotStart
Meeting is not started.
@ MobileRTCMeetError_MeetingClientIncompatible
The MobileRTC version is incompatible.
@ MobileRTCMeetError_ReconnectError
Failed to reconnect the meeting.
@ MobileRTCMeetError_RegisterWebinarPanelistRegister
User needs to register an account if he wants to join the webinar by the link.
@ MobileRTCMeetError_MeetingUserFull
The amount of attendees reaches the upper limit.
@ MobileRTCMeetError_MeetingOver
Meeting is over.
@ MobileRTCMeetError_MeetingNotExist
The meeting does not exist.
@ MobileRTCMeetError_NoMMR
No MMR is valid.
@ MobileRTCMeetError_TooFrequenceCall
The request too frequence.
@ MobileRTCMeetError_PasswordError
The meeting password is incorrect.
@ MobileRTCMeetError_MeetingRestricted
The meeting is restricted.
@ MobileRTCMeetError_Success
Start/Join meeting successfully.
@ MobileRTCMeetError_RegisterWebinarFull
The amount of webinar attendees reaches the upper limit.
@ MobileRTCMeetError_InvalidUserType
Invalid user Type.
@ MobileRTCMeetError_AppPrivilegeTokenError
App privilege token error.
@ MobileRTCMeetError_Failed
Failed of the api call.
@ MobileRTCMeetError_VBNoSupport
Virtual background not support.
@ MobileRTCMeetError_VBSetError
Set image for virtual background error.
@ MobileRTCMeetError_RegisterWebinarDeniedEmail
The host has denied your webinar registration.
@ MobileRTCMeetError_NetworkError
Network issue, please check the network connection.
@ MobileRTCMeetError_ZCCertificateChanged
The certificate of ZC has been changed.
@ MobileRTCMeetError_RegisterWebinarEnforceLogin
Sign in with the specified account to join webinar.
@ MobileRTCMeetError_VBRemoveNone
Virtual background save the image error.
@ MobileRTCMeetError_SessionError
Failed to create video and audio data connection with MMR.
@ MobileRTCMeetError_CannotStartTokenExpire
Failed to start meeting with expired token.
@ MobileRTCMeetError_VBGreenScreenNoSupport
Virtual background GreenScreen not support, only iPad support green screen.
@ MobileRTCMeetError_MMRError
MMR issue, please check MMR configuration.
@ MobileRTCMeetError_Unknown
Unknown error.
@ MobileRTCMeetError_HostDisallowOutsideUserJoin
Forbidden to join meeting.
@ MobileRTCMeetError_MeetingLocked
The meeting is locked by the host.
@ MobileRTCMeetError_MeetingRestrictedJBH
The meeting is restricted to join before host.
@ MobileRTCMeetError_RemovedByHost
Meeting is removed by the host.
@ MobileRTCMeetError_InAnotherMeeting
The user joins already another ongoing meeting.
@ MobileRTCMeetError_WriteConfigFile
Failed to write configure file.
@ MobileRTCMeetError_WrongUsage
Wrong usage of the api.
@ MobileRTCMeetError_VBSaveImage
Virtual background save the image error.
@ MobileRTCMeetError_CannotEmitWebRequest
Failed to request the web server.
@ MobileRTCMeetError_AudioAutoStartError
The user's audio cannot auto-start.
@ MobileRTCMeetError_JoinWebinarWithSameEmail
The email address has already been registered in the current webinar.
@ MobileRTCMeetError_InvalidArguments
Invalid arguments.
@ MobileRTCMeetError_VBBase
The virtual background error base.
@ MobileRTCMeetError_VideoError
The user's video does not work.
MobileRTCAudioOutput
MobileRTCAudioOutput An enumeration of audio output description.
@ MobileRTCAudioOutput_Unknown
Unknown.
@ MobileRTCAudioOutput_Speaker
Speaker.
@ MobileRTCAudioOutput_Headphones
Headphones.
@ MobileRTCAudioOutput_Receiver
Receiver.
@ MobileRTCAudioOutput_Bluetooth
Blue-tooth.
MobileRTCWebinarPromoteorDepromoteError
MobileRTCWebinarPromoteorDepromoteError An enumeration of promoting/demoting attendee and panelist er...
@ MobileRTCWebinarPromoteorDepromoteError_Webinar_Panelist_Capacity_Exceed
The amount of panelist in webinar reaches the upper limit.
@ MobileRTCWebinarPromoteorDepromoteError_Not_Found_Webinar_Attendee
The attendees in webinar are not found.
@ MobileRTCWebinarPromoteorDepromoteError_Success
Promote/demote successfully.
MobileRTCMeetingState
MobileRTCMeetingState An enumeration of meeting states.
@ MobileRTCMeetingState_JoinBO
Join the breakout room.
@ MobileRTCMeetingState_WebinarDePromote
Downgrade the attendees from the panelist.
@ MobileRTCMeetingState_Ended
Meeting ends.
@ MobileRTCMeetingState_Unlocked
Meeting is open and participants can join the meeting.
@ MobileRTCMeetingState_InMeeting
Meeting is ready, in meeting status.
@ MobileRTCMeetingState_Reconnecting
Reconnecting meeting server status.
@ MobileRTCMeetingState_Idle
No meeting is running.
@ MobileRTCMeetingState_Locked
Meeting is locked to prevent the further participants to join the meeting.
@ MobileRTCMeetingState_WaitingForHost
Waiting for the host to start the meeting.
@ MobileRTCMeetingState_Disconnecting
Disconnect the meeting server, leave meeting status.
@ MobileRTCMeetingState_WebinarPromote
Upgrade the attendees to panelist in webinar.
@ MobileRTCMeetingState_Failed
Failed to connect the meeting server.
@ MobileRTCMeetingState_LeaveBO
Leave the breakout room.
@ MobileRTCMeetingState_Unknow
Unknown status.
@ MobileRTCMeetingState_InWaitingRoom
Participants who join the meeting before the start are in the waiting room.
@ MobileRTCMeetingState_Connecting
Connect to the meeting server status.
MobileRTCVideoQuality
MobileRTCVideoQuality Quality of video.
@ MobileRTCVideoQuality_Bad
The video quality is poor.
@ MobileRTCVideoQuality_Good
The video quality is good.
@ MobileRTCVideoQuality_Unknown
unknown video quality status.
@ MobileRTCVideoQuality_Normal
The video quality is normal.
MobileRTCAttendeeViewMode
Enumerations of webinar attendee view mode, Only host can set.
@ MobileRTCAttendeeViewMode_None
@ MobileRTCAttendeeViewMode_Gallery
@ MobileRTCAttendeeViewMode_Speaker
@ MobileRTCAttendeeViewMode_Sharing_SidebysideSpeaker
@ MobileRTCAttendeeViewMode_FollowHost
@ MobileRTCAttendeeViewMode_Sharing_SidebysideGallery
@ MobileRTCAttendeeViewMode_Sharing_Standard
MobileRTCBOControllerError
Error type of Starting BO Failed.
@ MobileRTCBOControllerError_WRONG_CURRENT_STATUS
@ MobileRTCBOControllerError_NO_PRIVILEGE
@ MobileRTCBOControllerError_UPLOAD_FAIL
@ MobileRTCBOControllerError_TOKEN_NOT_READY
@ MobileRTCBOControllerError_BO_LIST_IS_UPLOADING
@ MobileRTCBOControllerError_NULL_POINTER
@ MobileRTCBOControllerError_NO_ONE_HAS_BEEN_ASSIGNED
@ MobileRTCBOControllerError_UNKNOWN
MobileRTCMinimizeMeetingState
Minimize Meeting state in Zoom UI.
@ MobileRTCMinimizeMeeting_ShowMinimizeMeeting
@ MobileRTCMinimizeMeeting_BackFullScreenMeeting
MobileRTCChatMessageDeleteType
Enumerations of the chat message delete type.
@ MobileRTCChatMessageDeleteType_By_None
none
@ MobileRTCChatMessageDeleteType_By_Host
delete by host
@ MobileRTCChatMessageDeleteType_By_Self
delete by self
@ MobileRTCChatMessageDeleteType_By_DLP
delete by dlp when the message goes against the host organization's compliance policies.
MobileRTCUserType
MobileRTCUserType An enumeration of user types.
@ MobileRTCUserType_SSOUser
Single-sign-on user.
@ MobileRTCUserType_GoogleOAuth
User logs in with Google authentication.
@ MobileRTCUserType_Facebook
User logs in with Facebook account.
@ MobileRTCUserType_APIUser
API user.
@ MobileRTCUserType_ZoomUser
User logs in with working email.
@ MobileRTCUserType_Unknown
Unknown user type.
MobileRTCMeetingItemRecordType
MobileRTCMeetingItemRecordType An enumeration of meeting recording types in meeting.
@ MobileRTCMeetingItemRecordType_Unknown
Unknown.
@ MobileRTCMeetingItemRecordType_LocalRecord
Local Recording.
@ MobileRTCMeetingItemRecordType_AutoRecordDisabled
Automatic recording is disabled.
@ MobileRTCMeetingItemRecordType_CloudRecord
Cloud Recording.
MobileRTCAnnotationError
MobileRTCAnnotationError An enumeration of annotation-related operational error states.
@ MobileRTCAnnotationError_PermissionDenied
No permission.
@ MobileRTCAnnotationError_Successed
Succeeded.
@ MobileRTCAnnotationError_Failed
Failed.
MobileRTCChatAllowAttendeeChat
MobileRTCWebinarAllowAttendeeChat An enumeration of attendee chat permission in webinar.
@ MobileRTCChatAllowAttendeeChat_ChatWithNone
Chat is disabled.
@ MobileRTCChatAllowAttendeeChat_ChatWithPanelist
Chat with panelist.
@ MobileRTCChatAllowAttendeeChat_ChatWithAll
Chat with all.
MobileRTCMicrophoneError
MobileRTCAudioError An enumeration of Audio Errors.
@ MobileRTCMicrophoneError_MicMuted
Microphone is muted while speaking.
@ MobileRTCMicrophoneError_MicUnavailable
Microphone is unavailable.
@ MobileRTCMicrophoneError_FeedbackDetected
Audio feedback is detected when join meeting.
MobileRTCNotificationServiceStatus
Enumerations of the type for alive connect service status.
@ MobileRTCNotificationServiceStatus_Started
@ MobileRTCNotificationServiceStatus_StartFailed
@ MobileRTCNotificationServiceStatus_Closed
@ MobileRTCNotificationServiceStatus_None
@ MobileRTCNotificationServiceStatus_Starting
MobileRTCRecordingStatus
Enumeration of recording status.
@ MobileRTCRecording_Pause
@ MobileRTCRecording_Stop
@ MobileRTCRecording_DiskFull
@ MobileRTCRecording_Connecting
@ MobileRTCRecording_Start
MobileRTCLiveStreamStatus
MobileRTCLiveStreamStatus An enumeration of Live Stream status in meeting.
@ MobileRTCLiveStreamStatus_StartTimeout
Start live stream timeout.
@ MobileRTCLiveStreamStatus_StartSuccessed
Start live stream successfully.
@ MobileRTCLiveStreamStatus_StartFailedOrEnded
Start live stream failed.
MobileRTCChatMessageType
Chat message type.
@ MobileRTCChatMessageType_To_Individual
Chat message is send to individual user.
@ MobileRTCChatMessageType_To_All_Panelist
Chat message is send to all panelists.
@ MobileRTCChatMessageType_To_Individual_Panelist
Chat message is send to individual attendee and cc panelists.
@ MobileRTCChatMessageType_To_WaitingRoomUsers
Chat message is send to waiting room user.
@ MobileRTCChatMessageType_To_All
Chat message is send to all.
@ MobileRTCChatMessageType_To_None
For initialize.
MobileRTCMeetingChatPriviledgeType
MobileRTCMeetingChatPriviledgeType An enumeration of meeting chat types in meeting.
@ MobileRTCMeetingChatPriviledge_Host_Only
allow attendee to chat with host only
@ MobileRTCMeetingChatPriviledge_Everyone_Publicly
allow attendee to chat with host and public
@ MobileRTCMeetingChatPriviledge_Everyone_Publicly_And_Privately
allow attendee to chat with everyone
@ MobileRTCMeetingChatPriviledge_No_One
allow attendee to chat with no one
@ MobileRTCMeetingChatPriviledge_Unknown
Unknown type.
MobileRTCVideoRawDataRotation
MobileRTCVideoResolution The direction of video.
@ MobileRTCVideoRawDataRotation270
video direction 270
@ MobileRTCVideoRawDataRotation180
video direction 180
@ MobileRTCVideoRawDataRotation90
video direction 90
@ MobileRTCVideoRawDataRotationNone
video direction 0
MobileRTCSDKError
An enumeration of SDK error.
@ MobileRTCSDKError_VideoNotReady
the video service is not ready.
@ MobileRTCSDKError_OtherSdkInstanceRunning
the other instance of the sdk is in process.
@ MobileRTCSDKError_MeetingViewtypeParameterIsWrong
incorrect viewtype parameters.
@ MobileRTCSDKError_InternalError
sdk internal error.
@ MobileRTCSDKError_MeetingCallOutFailed
meeting call out fail.
@ MobileRTCSDKError_NoShareData
there is no raw data of sharing.
@ MobileRTCSDKError_NoVideoDeviceIsFound
no video device found.
@ MobileRTCSDKError_MeetingAnnotationIsOff
annotation is disabled.
@ MobileRTCSDKError_MeetingYouHaveNoShare
there is no sharing.
@ MobileRTCSDKError_Unauthentication
not authorized before the usage.
@ MobileRTCSDKError_Unknown
unknown error.
@ MobileRTCSDKError_NoPermission
no permission.
@ MobileRTCSDKError_ModuleLoadFailed
loading module failed.
@ MobileRTCSDKError_MeetingDontSupportFeature
the current meeting doesn't support the feature.
@ MobileRTCSDKError_InvalidParameter
wrong parameter.
@ MobileRTCSDKError_NotInMeeting
not in meeting.
@ MobileRTCSDKError_SettingOsDontSupport
current os doesn't support the setting.
@ MobileRTCSDKError_FailAssignUserPrivilege
user can't be assigned with new privilege.
@ MobileRTCSDKError_TranscoderNoFound
transcoder module is not found.
@ MobileRTCSDKError_TooFrequentCall
api calls too frequently.
@ MobileRTCSDKError_NotSupportMultiStreamVideoUser
not support multi stream video user.
@ MobileRTCSDKError_NoAudiodeviceIsFound
no audio device found.
@ MobileRTCSDKError_EmailLoginIsDisabled
email login is disable
@ MobileRTCSDKError_NoImpl
this feature is currently invalid.
@ MobileRTCSDKError_WrongUsage
incorrect usage of the feature.
@ MobileRTCSDKError_ShareCannotSubscribeMyself
can't subscribe my self share.
@ MobileRTCSDKError_MeetingNotShareSender
the current user is not the presenter.
@ MobileRTCSDKError_HardwareNotMeetForVb
computer doesn't meet the minimum requirements to use virtual background feature.
@ MobileRTCSDKError_Uninitialize
not initialized before the usage.
@ MobileRTCSDKError_ServiceFailed
internal service error.
@ MobileRTCSDKError_MemoryFailed
no memory is allocated.
@ MobileRTCSDKError_NeedUserConfirmRecordDisclaimer
need process disclaimer.
@ MobileRTCSDKError_NoRecordingInprocess
no recording in process.
@ MobileRTCSDKError_Success
success.
MobileRTCShareSettingType
Enumeration of LockShare Status changed.
@ MobileRTCShareSettingType_MultiShare
Anyone can share, Multi-share can exist at the same time.
@ MobileRTCShareSettingType_None
share settings type none
@ MobileRTCShareSettingType_AnyoneGrab
Anyone can share, but one sharing only at one moment, and anyone can grab other's sharing.
@ MobileRTCShareSettingType_LockShare
Only host can share, the same as "lock share".
@ MobileRTCShareSettingType_HostGrab
Anyone can share, but one sharing only at one moment, and only host can grab other's sharing.
MobileRTCANNError
MobileRTCANNError An enumeration of App Signaling.
@ MobileRTCANNError_NotCustomUI
You should not call ANN.
@ MobileRTCANNError_Success
Call ANN API succeed.
@ MobileRTCANNError_FeatureNotSupport
ANN feature not support.
@ MobileRTCANNError_NotInMeeting
You can't call ANN api out of a meeting.
MobileRTCCameraError
MobileRTCCameraError An enumeration of camera-related operational error states.
@ MobileRTCCameraError_Success
Success.
@ MobileRTCCameraError_VideoNotSending
The camera can not connect to video session.
@ MobileRTCCameraError_CameraPermissionDenied
The permission to enable the camera is denied.
MobileRTCRawDataMemoryMode
Rawdata memory mode.
@ MobileRTCRawDataMemoryModeStack
@ MobileRTCRawDataMemoryModeHeap
MobileRTCRemoteControlError
MobileRTCRemoteControlError An enumeration of remote control-related operational result in meeting.
@ MobileRTCRemoteControlError_Successed
Succeeded.
@ MobileRTCRemoteControlError_Failed
Failed.
@ MobileRTCRemoteControlError_PermissionDenied
No Permission.
@ MobileRTCRemoteControlError_Stop
stop
MobileRTCCMRError
MobileRTCCMRError An enumeration of CMR-related result error states.
@ MobileRTCCMRError_Successed
Succeeded.
@ MobileRTCCMRError_Failed
Failed.
@ MobileRTCCMRError_StorageFull
The storage is full.
MobileRTCSMSVerifyResult
for SMS service usage.
@ MobileRTCSMSVerifyResult_RealNameAuthErrorIdentifyCode
@ MobileRTCSMSVerifyResult_RealNameAuthIdentifyCodeExpired
@ MobileRTCSMSVerifyResult_RealNameAuthUnknownError
@ MobileRTCSMSVerifyResult_Succ
@ MobileRTCSMSVerifyResult_RealNameAuthBypassVerify
MobileRTCUserRole
Enumeration of user roles.
@ MobileRTCUserRole_CoHost
@ MobileRTCUserRole_None
@ MobileRTCUserRole_Panelist
@ MobileRTCUserRole_Host
@ MobileRTCUserRole_BreakoutRoom_Moderator
@ MobileRTCUserRole_Attendee
FreeMeetingNeedUpgradeType
free meeting need upgrade type.
@ FreeMeetingNeedUpgradeType_BY_ADMIN
@ FreeMeetingNeedUpgradeType_NONE
@ FreeMeetingNeedUpgradeType_BY_GIFTURL
MobileRTCDirectShareStatus
Direct sharing status.
@ MobileRTCDirectShareStatus_Need_MeetingID_Or_PairingCode
@ MobileRTCDirectShareStatus_Connecting
@ MobileRTCDirectShareStatus_WrongMeetingID_Or_SharingKey
@ MobileRTCDirectShareStatus_Unknown
@ MobileRTCDirectShareStatus_Other_Error
@ MobileRTCDirectShareStatus_Need_Input_New_ParingCode
@ MobileRTCDirectShareStatus_NetWork_Error
@ MobileRTCDirectShareStatus_In_Direct_Share_Mode
@ MobileRTCDirectShareStatus_DirectShare_Prepared
@ MobileRTCDirectShareStatus_Ended
MobileRTCMeetingItemAudioType
MobileRTCMeetingItemAudioType An enumeration of audio types in meeting.
@ MobileRTCMeetingItemAudioType_TelephoneOnly
Telephone Only.
@ MobileRTCMeetingItemAudioType_Unknown
Unknown.
@ MobileRTCMeetingItemAudioType_3rdPartyAudio
The 3rd Party Audio.
@ MobileRTCMeetingItemAudioType_VoipOnly
VoIP Only.
@ MobileRTCMeetingItemAudioType_TelephoneAndVoip
Telephone And VoIP.
DialOutStatus
DialOutStatus An enumeration of outgoing call states.
@ DialOutStatus_Ringing
In process of ringing.
@ DialOutStatus_TimeOut
Outgoing call timeout.
@ DialOutStatus_Calling
Calling in process.
@ DialOutStatus_ZoomStartCancelCall
Start to cancel outgoing call.
@ DialOutStatus_UserHangUp
The phone is hung up.
@ DialOutStatus_ZoomCancelCallFail
Failed to cancel outgoing call.
@ DialOutStatus_Accepted
The call is accepted by the receiver.
@ DialOutStatus_Unknown
Unknown outgoing call status.
@ DialOutStatus_BlockTooFrequent
All the invitees invited by the call should press the button one(1) to join the meeting....
@ DialOutStatus_ZoomCallCanceled
The outgoing call is canceled.
@ DialOutStatus_BlockNoHost
Disable the function of international outgoing call before the host joins the meeting.
@ DialOutStatus_JoinSuccess
Join meeting successfully.
@ DialOutStatus_Busy
The telephone service is busy.
@ DialOutStatus_BlockHighRate
The call-out is blocked by the system due to high cost.
@ DialOutStatus_NoAnswer
The call is not answered.
@ DialOutStatus_OtherFail
Other reasons.
@ DialOutStatus_NotAvailable
The telephone is out of service.
MobileRTCSharingStatus
Enumeration of sharing status.
@ MobileRTCSharingStatus_View_Other_Sharing
View the sharing of others.
@ MobileRTCSharingStatus_Self_Send_End
Stop sharing by the user.
@ MobileRTCSharingStatus_Self_Send_Begin
Begin to share by the user himself.
@ MobileRTCSharingStatus_Pause
Pause sharing.
@ MobileRTCSharingStatus_Other_Share_End
Others stop sharing.
@ MobileRTCSharingStatus_Other_Share_Begin
Others begin to share.
@ MobileRTCSharingStatus_Resume
Resume sharing.
@ MobileRTCSharingStatus_OtherPureAudioShareStart
Other user begins to share the sounds of computer audio.
@ MobileRTCSharingStatus_OtherPureAudioShareStop
Other user stops sharing the sounds of computer audio.
MobileRTCSignInterpretationStatus
@ MobileRTCSignInterpretationStatus_Started
@ MobileRTCSignInterpretationStatus_Stopped
@ MobileRTCSignInterpretationStatus_Initial
MobileRTCBOStatus
enum for BO status.
@ MobileRTCBOStatus_Edit
@ MobileRTCBOStatus_Stopping
@ MobileRTCBOStatus_Started
@ MobileRTCBOStatus_Ended
@ MobileRTCBOStatus_Invalid
MobileRTCNetworkQuality
MobileRTCNetworkQuality Quality of session network.
@ MobileRTCNetworkQuality_Good
The connection quality is good.
@ MobileRTCNetworkQuality_Excellent
The connection quality is excellent.
@ MobileRTCNetworkQuality_Unknown
Unknown connection status.
@ MobileRTCNetworkQuality_Bad
The connection quality is very poor.
@ MobileRTCNetworkQuality_NotGood
The connection quality is not good.
@ MobileRTCNetworkQuality_VeryBad
The connection quality is very poor.
@ MobileRTCNetworkQuality_Normal
The connection quality is normal.
MobileRTCInMeetingSupportAudioType
Enumerations of the type for in meeting audio type.
@ MobileRTCInMeetingSupportAudioType_Voip
@ MobileRTCInMeetingSupportAudioType_None
@ MobileRTCInMeetingSupportAudioType_Telephone
MobileRTCSendChatError
MobileRTCSendChatError An enumeration of SENDING CHAT MESSAGE result in meeting.
@ MobileRTCSendChatError_PermissionDenied
No permission.
@ MobileRTCSendChatError_Successed
Send chat message successfully.
@ MobileRTCSendChatError_Failed
Send chat message failed.
MobileRTC_AudioStatus
@ MobileRTC_AudioStatus_Audio_MutedAll_ByHost
The host unmutes all.
@ MobileRTC_AudioStatus_Audio_UnMutedAll_ByHost
@ MobileRTC_AudioStatus_Audio_Muted
Unmuted status.
@ MobileRTC_AudioStatus_Audio_UnMuted_ByHost
The host mutes all.
@ MobileRTC_AudioStatus_None
Initialization.
@ MobileRTC_AudioStatus_Audio_UnMuted
Muted by the host.
@ MobileRTC_AudioStatus_Audio_Muted_ByHost
Unmuted by the host.
LeaveMeetingCmd
LeaveMeetingCmd An enumeration of commands for leaving meeting.
@ LeaveMeetingCmd_Leave
Command of leaving meeting.
@ LeaveMeetingCmd_End
Command of ending Meeting.
MobileRTCComponentType
MobileRTCComponentType An enumeration of all component types.
@ MobileRTCComponentType_Chat
Chat.
@ MobileRTCComponentType_AUDIO
Audio.
@ MobileRTCComponentType_FT
File Transfer.
@ MobileRTCComponentType_VIDEO
Video.
@ MobileRTCComponentType_Def
Default component type.
@ MobileRTCComponentType_AS
Share application.
MobileRTCEmojiReactionType
emoji reacion type.
@ MobileRTCEmojiReactionType_Unknown
@ MobileRTCEmojiReactionType_Openmouth
joy
@ MobileRTCEmojiReactionType_Thumbsup
clap
@ MobileRTCEmojiReactionType_Joy
heart
@ MobileRTCEmojiReactionType_Heart
thumbsup
@ MobileRTCEmojiReactionType_Tada
openmouth
@ MobileRTCEmojiReactionType_Clap
unknow
MobileRTCMeetingType
Enumeration of meeting types.
@ MobileRTCMeetingType_None
@ MobileRTCMeetingType_Normal
@ MobileRTCMeetingType_Webinar
@ MobileRTCMeetingType_BreakoutRoom
JBHCmd
JBHCmd An enumeration of waiting UI when JBH is disabled.
@ JBHCmd_Hide
Hide JBH waiting command.
@ JBHCmd_Show
Show JBH waiting command.
MobileRTCLiveTranscriptionStatus
Live transcription status.
@ MobileRTC_LiveTranscription_Status_Connecting
Live transcription connecting.
@ MobileRTC_LiveTranscription_Status_Stop
Live transcription not start.
@ MobileRTC_LiveTranscription_Status_Start
Live transcription start.
@ MobileRTC_LiveTranscription_Status_Unknown
Live transcription not start.
@ MobileRTC_LiveTranscription_Status_UserSub
Live transcription user sub.
MobileRTC_VideoStatus
@ MobileRTC_VideoStatus_Video_OFF
Muted by the host.
@ MobileRTC_VideoStatus_Video_ON
Muted status.
@ MobileRTC_VideoStatus_Video_Muted_ByHost
H323CallOutStatus
H323CallOutStatus An enumeration of H.323/SIP outgoing call status.
@ H323CallOutStatus_Busy
Busy.
@ H323CallOutStatus_Success
OK.
@ H323CallOutStatus_Ring
Ring.
@ H323CallOutStatus_Decline
Decline.
@ H323CallOutStatus_Failed
Failed.
@ H323CallOutStatus_Timeout
Timeout.
MobileRTCVideoType
@ MobileRTCVideoType_ShareData
Share Data.
@ MobileRTCVideoType_VideoData
Video Camera Data.
MobileRTCVideoResolution
MobileRTCVideoResolution An enumeration of video raw data resolution.
@ MobileRTCVideoResolution_360
video resolution 360
@ MobileRTCVideoResolution_180
video resolution 180
@ MobileRTCVideoResolution_90
video resolution 90
@ MobileRTCVideoResolution_720
video resolution 720
MobileRTCMeetingEndReason
MobileRTCAudioError An enumeration of Audio Errors.
@ MobileRTCMeetingEndReason_Unknown
Meeting ends by unknown reasons.
@ MobileRTCMeetingEndReason_JBHTimeout
Join the meeting before host (JBH) timeout.
@ MobileRTCMeetingEndReason_RemovedByHost
The user is removed from meeting by the host.
@ MobileRTCMeetingEndReason_NoAteendee
No ateendee.
@ MobileRTCMeetingEndReason_FreeMeetingTimeout
Meeting ends when the free service is over.
@ MobileRTCMeetingEndReason_HostEndForAnotherMeeting
Meeting ends by the host for he will start another meeting.
@ MobileRTCMeetingEndReason_SelfLeave
User leaves meeting.
@ MobileRTCMeetingEndReason_ConnectBroken
Meeting ends for SDK disconnects, such as network issue.
@ MobileRTCMeetingEndReason_EndByHost
Host ends the meeting.
MobileRTCH323ParingStatus
MobileRTCH323ParingStatus An enumeration of H.323/SIP pairing status.
@ MobileRTCH323ParingStatus_MeetingNotExisted
Meeting does not Exist.
@ MobileRTCH323ParingStatus_Success
Success.
@ MobileRTCH323ParingStatus_PermissionDenied
No permission.
@ MobileRTCH323ParingStatus_Error
Error.
@ MobileRTCH323ParingStatus_ParingcodeNotExisted
Paring Code is not existed.
MobileRTCVideoRawDataFormat
MobileRTCVideoResolution An enumeration of video raw data format.
@ MobileRTCVideoRawDataFormatI420_Limit
@ MobileRTCVideoRawDataFormatI420
MobileRTCVBType
Enumeration of virtual background type in MobileRTCVirtualBGImageInfo .
@ MobileRTCVBType_None
virtual background type none
@ MobileRTCVBType_Item
virtual background type with image
@ MobileRTCVBType_Blur
virtual background type blur
MobileRTCSMSRetrieveResult
@ MobileRTCSMSRetrieveResult_SendSMSFailed
@ MobileRTCSMSRetrieveResult_Succ
@ MobileRTCSMSRetrieveResult_PhoneNumSendTooFrequent
@ MobileRTCSMSRetrieveResult_RequestFailed
@ MobileRTCSMSRetrieveResult_InvalidPhoneNum
@ MobileRTCSMSRetrieveResult_BypassVerify
@ MobileRTCSMSRetrieveResult_PhoneNumAlreadyBound
MobileRTCJoinMeetingInfo
MobileRTCJoinMeetingInfo An enumeration of information needed to Join Meeting.
@ MobileRTCJoinMeetingInfo_NeedNameAndPwd
Screen name and meeting Password are needed.
@ MobileRTCJoinMeetingInfo_WrongPassword
Meeting password is wrong.
@ MobileRTCJoinMeetingInfo_NeedPassword
Meeting password is needed.
@ MobileRTCJoinMeetingInfo_NeedName
Display name is needed.
MobileRTCLoginFailReason
An enumeration of SDK login.
@ MobileRTCLoginFailReason_AlreayLoggedin
@ MobileRTCLoginFailReason_SDKNeedUpdate
SDK need update.
@ MobileRTCLoginFailReason_UserNotExist
User not exist.
@ MobileRTCLoginFailReason_OtherIssue
Login fail other reason.
@ MobileRTCLoginFailReason_NeedBirthdayAsk
Need confirm birthday.
@ MobileRTCLoginFailReason_EmailLoginDiable
Email login disabled.
@ MobileRTCLoginFailReason_TooManyFailedAttempts
Attemps too many times.
@ MobileRTCLoginFailReason_SDKNotAuthorized
@ MobileRTCLoginFailReason_Success
login is successful.
@ MobileRTCLoginFailReason_UserDisagreeLoginDisclaimer
User disagree login Disclaimer.
@ MobileRTCLoginFailReason_PhoneNumberFormatInValid
Phone number format invalid.
@ MobileRTCLoginFailReason_LoginTokenInvalid
Login token invalid.
@ MobileRTCLoginFailReason_InAutoLoginProcess
@ MobileRTCLoginFailReason_AccountLocked
Account is locked.
@ MobileRTCLoginFailReason_SMSCodeExpired
SMS code expired.
@ MobileRTCLoginFailReason_SMSCodeError
SMS code error.
@ MobileRTCLoginFailReason_WrongPassword
Password is wrong.
@ MobileRTCLoginFailReason_MFARequired
Need MFA auth.
@ MobileRTCLoginFailReason_InvalidArguments
MobileRTCPanelistChatPrivilegeType
Chat Privilege type of webinar panelist.
@ MobileRTCPanelistChatPrivilege_INVALID
default status, can't set this
@ MobileRTCPanelistChatPrivilege_PANELIST
can chat to all panelist
@ MobileRTCPanelistChatPrivilege_ALL
can chat to all
MobileRTCRawDataError
MobileRTCRawDataError An enumeration of raw data.
@ MobileRTCRawData_Share_Module_Error
@ MobileRTCRawData_No_Audio_Data
@ MobileRTCRawData_Audio_Module_Error
@ MobileRTCRawData_No_Share_Data
@ MobileRTCRawData_Video_Module_Error
@ MobileRTCRawData_No_License
@ MobileRTCRawData_Invalid_Param
@ MobileRTCRawData_Wrongusage
@ MobileRTCRawData_Not_In_Meeting
@ MobileRTCRawData_Malloc_Failed
@ MobileRTCRawData_Unknow
@ MobileRTCRawData_Uninitialized
@ MobileRTCRawData_Share_Cannot_Subscribe_Myself
@ MobileRTCRawData_Audio_Module_Not_Ready
@ MobileRTCRawData_No_Video_Data
@ MobileRTCRawData_Success
@ MobileRTCRawData_Share_Module_Not_Ready
@ MobileRTCRawData_Video_Module_Not_Ready
@ MobileRTCRawData_Send_Too_Frequently
@ MobileRTCRawData_Video_device_error
MobileRTCLiveTranscriptionOperationType
Live transcription operation type.
@ MobileRTC_LiveTranscription_OperationType_Add
Live transcription operation type is add, means a new live transcription item is arrive.
@ MobileRTC_LiveTranscription_OperationType_Complete
Live transcription operation type is complete.
@ MobileRTC_LiveTranscription_OperationType_None
Live transcription operation type is none, means no operate.
@ MobileRTC_LiveTranscription_OperationType_Delete
Live transcription operation type is delete, means an existed live transcription item has been delete...
@ MobileRTC_LiveTranscription_OperationType_NoTranslation
Live transcription operation type is no translation.
@ MobileRTC_LiveTranscription_OperationType_Update
Live transcription operation type is update, means an existed live transcription item has been update...
@ MobileRTC_LiveTranscription_OperationType_NotSupported
Live transcription operation type is not suppported.
MobileRTCAudioError
MobileRTCAudioError An enumeration of audio-related operational error states.
@ MobileRTCAudioError_Success
Success.
@ MobileRTCAudioError_CannotUnmuteMyAudio
User can not unmute his Audio.
@ MobileRTCAudioError_AudioNotConnected
Do not connect to audio session.
@ MobileRTCAudioError_Failed
Failed.
@ MobileRTCAudioError_AudioPermissionDenied
The application for Audio Session Recording is Denied.
MobileRTCSubscribeFailReason
Video subscribe error.
@ MobileRTCSubscribe_Fail_HasSubscribe720P
@ MobileRTCSubscribe_Fail_NotSupport1080P
@ MobileRTCSubscribe_Fail_NotInMeeting
@ MobileRTCSubscribe_Fail_HasSubscribeExceededLimit
@ MobileRTCSubscribe_Fail_None
@ MobileRTCSubscribe_Fail_ViewOnly
MobileRTCAuthError
An enumeration of SDK authentication.
@ MobileRTCAuthError_KeyOrSecretEmpty
Key or secret is empty.
@ MobileRTCAuthError_OverTime
Request over time.
@ MobileRTCAuthError_KeyOrSecretWrong
Key or secret is wrong.
@ MobileRTCAuthError_Unknown
Unknown error.
@ MobileRTCAuthError_AccountNotSupport
Client account does not support.
@ MobileRTCAuthError_TokenWrong
The jwt token to authenticate is wrong.
@ MobileRTCAuthError_AccountNotEnableSDK
Client account does not enable SDK.
@ MobileRTCAuthError_Success
Authentication is successful.
@ MobileRTCAuthError_ServiceBusy
Service is busy.
@ MobileRTCAuthError_None
@ MobileRTCAuthError_NetworkIssue
@ MobileRTCAuthError_ClientIncompatible
Account does not support this SDK version.
MobileRTC_ZoomLocale
Locale fo Customer.
@ MobileRTC_ZoomLocale_Default
@ MobileRTC_ZoomLocale_CN
MobileRTCClaimHostError
MobileRTCClaimHostError An enumeration of CLAIM HOST results in meeting.
@ MobileRTCClaimHostError_Successed
Claim host successfully.
@ MobileRTCClaimHostError_NetWorkError
Network Errors.
@ MobileRTCClaimHostError_HostKeyError
Host Key Errors.
MobileRTCEmojiReactionSkinTone
emoji reaction skin tone.
@ MobileRTCEmojiReactionSkinTone_Dark
medium dark skin tone
@ MobileRTCEmojiReactionSkinTone_MediumLight
light skin tone
@ MobileRTCEmojiReactionSkinTone_Unknown
@ MobileRTCEmojiReactionSkinTone_MediumDark
medium skin tone
@ MobileRTCEmojiReactionSkinTone_Default
unknow
@ MobileRTCEmojiReactionSkinTone_Medium
medium light skin tone
@ MobileRTCEmojiReactionSkinTone_Light
default skin tone
MobileRTCBOHelpReply
Result for requested help from attendee in BO Meeting.
@ MobileRTCBOHelpReply_alreadyInBO
@ MobileRTCBOHelpReply_Busy
@ MobileRTCBOHelpReply_Ignore
@ MobileRTCBOHelpReply_Idle