//
// MobileRTCConstants.h
// MobileRTC
//
// Created by Zoom Video Communications on 8/7/14.
// Copyright (c) 2019 Zoom Video Communications, Inc. All rights reserved.
//
/*!
@brief An enumeration of SDK authentication.
*/
typedef NS_ENUM(NSUInteger, MobileRTCAuthError) {
///Authentication is successful
MobileRTCAuthError_Success,
///Key or secret is empty
MobileRTCAuthError_KeyOrSecretEmpty,
///Key or secret is wrong
MobileRTCAuthError_KeyOrSecretWrong,
///Client account does not support
MobileRTCAuthError_AccountNotSupport,
///Client account does not enable SDK
MobileRTCAuthError_AccountNotEnableSDK,
///Unknown error
MobileRTCAuthError_Unknown,
///Service is busy
MobileRTCAuthError_ServiceBusy,
///<Initial status.
MobileRTCAuthError_None,
///Request over time
MobileRTCAuthError_OverTime,
///<Network issues.
MobileRTCAuthError_NetworkIssue,
///Account does not support this SDK version
MobileRTCAuthError_ClientIncompatible,
///The jwt token to authenticate is wrong
MobileRTCAuthError_TokenWrong,
};
/*!
@brief An enumeration of SDK login.
*/
typedef NS_ENUM(NSUInteger, MobileRTCLoginFailReason) {
///login is successful.
MobileRTCLoginFailReason_Success,
///Email login disabled.
MobileRTCLoginFailReason_EmailLoginDiable,
///User not exist.
MobileRTCLoginFailReason_UserNotExist,
///Password is wrong.
MobileRTCLoginFailReason_WrongPassword,
///Account is locked.
MobileRTCLoginFailReason_AccountLocked,
///SDK need update.
MobileRTCLoginFailReason_SDKNeedUpdate,
///Attemps too many times.
MobileRTCLoginFailReason_TooManyFailedAttempts,
///SMS code error.
MobileRTCLoginFailReason_SMSCodeError,
///SMS code expired.
MobileRTCLoginFailReason_SMSCodeExpired,
///Phone number format invalid.
MobileRTCLoginFailReason_PhoneNumberFormatInValid,
///Login token invalid.
MobileRTCLoginFailReason_LoginTokenInvalid,
/// User disagree login Disclaimer
MobileRTCLoginFailReason_UserDisagreeLoginDisclaimer,
///Login fail other reason.
MobileRTCLoginFailReason_OtherIssue = 100,
};
/*!
@brief MobileRTCMeetError An enumeration of Meeting States.
*/
typedef NS_ENUM(NSUInteger, MobileRTCMeetError) {
///Start/Join meeting successfully.
MobileRTCMeetError_Success = 0,
///Network issue, please check the network connection.
MobileRTCMeetError_NetworkError = 1,
///Failed to reconnect the meeting.
MobileRTCMeetError_ReconnectError = 2,
///MMR issue, please check MMR configuration.
MobileRTCMeetError_MMRError = 3,
///The meeting password is incorrect.
MobileRTCMeetError_PasswordError = 4,
///Failed to create video and audio data connection with MMR.
MobileRTCMeetError_SessionError = 5,
///Meeting is over.
MobileRTCMeetError_MeetingOver = 6,
///Meeting is not started.
MobileRTCMeetError_MeetingNotStart = 7,
///The meeting does not exist.
MobileRTCMeetError_MeetingNotExist = 8,
///The amount of attendees reaches the upper limit.
MobileRTCMeetError_MeetingUserFull = 9,
///The MobileRTC version is incompatible.
MobileRTCMeetError_MeetingClientIncompatible = 10,
///No MMR is valid.
MobileRTCMeetError_NoMMR = 11,
///The meeting is locked by the host.
MobileRTCMeetError_MeetingLocked = 12,
///The meeting is restricted.
MobileRTCMeetError_MeetingRestricted = 13,
///The meeting is restricted to join before host.
MobileRTCMeetError_MeetingRestrictedJBH = 14,
///Failed to request the web server.
MobileRTCMeetError_CannotEmitWebRequest = 15,
///Failed to start meeting with expired token.
MobileRTCMeetError_CannotStartTokenExpire = 16,
///The user's video does not work.
MobileRTCMeetError_VideoError = 17,
///The user's audio cannot auto-start.
MobileRTCMeetError_AudioAutoStartError = 18,
///The amount of webinar attendees reaches the upper limit.
MobileRTCMeetError_RegisterWebinarFull = 19,
///User needs to register a webinar account if he wants to start a webinar.
MobileRTCMeetError_RegisterWebinarHostRegister = 20,
///User needs to register an account if he wants to join the webinar by the link.
MobileRTCMeetError_RegisterWebinarPanelistRegister = 21,
///The host has denied your webinar registration.
MobileRTCMeetError_RegisterWebinarDeniedEmail = 22,
///Sign in with the specified account to join webinar.
MobileRTCMeetError_RegisterWebinarEnforceLogin = 23,
///The certificate of ZC has been changed.
MobileRTCMeetError_ZCCertificateChanged = 24,
///The vanity URL does not exist.
MobileRTCMeetError_VanityNotExist = 27,
///The email address has already been registered in the current webinar.
MobileRTCMeetError_JoinWebinarWithSameEmail = 28,
///Failed to write configure file.
MobileRTCMeetError_WriteConfigFile = 50,
///Meeting is removed by the host.
MobileRTCMeetError_RemovedByHost = 61,
///Forbidden to join meeting.
MobileRTCMeetError_HostDisallowOutsideUserJoin = 62,
///Invalid arguments.
MobileRTCMeetError_InvalidArguments = MobileRTCMeetError_WriteConfigFile + 100,
///Invalid user Type.
MobileRTCMeetError_InvalidUserType,
///The user joins already another ongoing meeting.
MobileRTCMeetError_InAnotherMeeting,
///The request too frequence
MobileRTCMeetError_TooFrequenceCall,
///Wrong usage of the api
MobileRTCMeetError_WrongUsage,
///Failed of the api call
MobileRTCMeetError_Failed,
///The virtual background error base
MobileRTCMeetError_VBBase = 200,
///Set image for virtual background error
MobileRTCMeetError_VBSetError = MobileRTCMeetError_VBBase,
///Virtual background image reach to max capacity
MobileRTCMeetError_VBMaximumNum,
///Virtual background save the image error
MobileRTCMeetError_VBSaveImage,
///Virtual background save the image error
MobileRTCMeetError_VBRemoveNone,
///Virtual background not support
MobileRTCMeetError_VBNoSupport,
///Virtual background GreenScreen not support, only iPad support green screen.
MobileRTCMeetError_VBGreenScreenNoSupport,
///Unknown error.
MobileRTCMeetError_Unknown,
};
/*!
@brief MobileRTCMeetingState An enumeration of meeting states.
*/
typedef NS_ENUM(NSUInteger, MobileRTCMeetingState) {
MobileRTCMeetingState_Idle,///<No meeting is running.
MobileRTCMeetingState_Connecting,///<Connect to the meeting server status.
MobileRTCMeetingState_WaitingForHost,///<Waiting for the host to start the meeting.
MobileRTCMeetingState_InMeeting,///<Meeting is ready, in meeting status.
MobileRTCMeetingState_Disconnecting,///<Disconnect the meeting server, leave meeting status.
MobileRTCMeetingState_Reconnecting,///<Reconnecting meeting server status.
MobileRTCMeetingState_Failed,///<Failed to connect the meeting server.
MobileRTCMeetingState_Ended,///<Meeting ends.
MobileRTCMeetingState_Unknow,///<Unknown status.
MobileRTCMeetingState_Locked,///<Meeting is locked to prevent the further participants to join the meeting.
MobileRTCMeetingState_Unlocked,///<Meeting is open and participants can join the meeting.
MobileRTCMeetingState_InWaitingRoom,///<Participants who join the meeting before the start are in the waiting room.
MobileRTCMeetingState_WebinarPromote,///<Upgrade the attendees to panelist in webinar.
MobileRTCMeetingState_WebinarDePromote,///<Downgrade the attendees from the panelist.
MobileRTCMeetingState_JoinBO,///<Join the breakout room.
MobileRTCMeetingState_LeaveBO,///<Leave the breakout room.
MobileRTCMeetingState_WaitingExternalSessionKey,///<Waiting for the additional secret key.
};
/*!
@brief MobileRTCUserType An enumeration of user types.
*/
typedef NS_ENUM(NSUInteger, MobileRTCUserType) {
///User logs in with Facebook account.
MobileRTCUserType_Facebook = 0,
///User logs in with Google authentication.
MobileRTCUserType_GoogleOAuth = 2,
///API user.
MobileRTCUserType_APIUser = 99,
///User logs in with working email.
MobileRTCUserType_ZoomUser = 100,
///Single-sign-on user.
MobileRTCUserType_SSOUser = 101,
///Unknown user type.
MobileRTCUserType_Unknown = 102,
};
/*!
@brief LeaveMeetingCmd An enumeration of commands for leaving meeting.
*/
typedef NS_ENUM(NSUInteger, LeaveMeetingCmd) {
///Command of leaving meeting.
LeaveMeetingCmd_Leave,
///Command of ending Meeting.
LeaveMeetingCmd_End,
};
/*!
@brief JBHCmd An enumeration of waiting UI when JBH is disabled.
*/
typedef NS_ENUM(NSUInteger, JBHCmd) {
///Show JBH waiting command.
JBHCmd_Show,
///Hide JBH waiting command.
JBHCmd_Hide,
};
/*!
@brief DialOutStatus An enumeration of outgoing call states.
*/
typedef NS_ENUM(NSUInteger, DialOutStatus) {
///Unknown outgoing call status.
DialOutStatus_Unknown = 0,
///Calling in process.
DialOutStatus_Calling,
///In process of ringing.
DialOutStatus_Ringing,
///The call is accepted by the receiver.
DialOutStatus_Accepted,
///The telephone service is busy.
DialOutStatus_Busy,
///The telephone is out of service.
DialOutStatus_NotAvailable,
///The phone is hung up.
DialOutStatus_UserHangUp,
///Other reasons.
DialOutStatus_OtherFail,
///Join meeting successfully.
DialOutStatus_JoinSuccess,
///Outgoing call timeout.
DialOutStatus_TimeOut,
///Start to cancel outgoing call.
DialOutStatus_ZoomStartCancelCall,
///The outgoing call is canceled.
DialOutStatus_ZoomCallCanceled,
///Failed to cancel outgoing call.
DialOutStatus_ZoomCancelCallFail,
///The call is not answered.
DialOutStatus_NoAnswer,
///Disable the function of international outgoing call before the host joins the meeting.
DialOutStatus_BlockNoHost,
///The call-out is blocked by the system due to high cost.
DialOutStatus_BlockHighRate,
///All the invitees invited by the call should press the button one(1) to join the meeting. In case that many invitees do not press the button that leads to time out, the call invitation for this meeting shall be banned.
DialOutStatus_BlockTooFrequent,
};
/*!
@brief H323CallOutStatus An enumeration of H.323/SIP outgoing call status.
*/
typedef NS_ENUM(NSUInteger, H323CallOutStatus) {
///OK
H323CallOutStatus_Success = 0,
///Ring
H323CallOutStatus_Ring,
///Timeout
H323CallOutStatus_Timeout,
///Busy
H323CallOutStatus_Busy,
///Decline
H323CallOutStatus_Decline,
///Failed
H323CallOutStatus_Failed,
};
/*!
@brief MobileRTCH323ParingStatus An enumeration of H.323/SIP pairing status.
*/
typedef NS_ENUM(NSUInteger, MobileRTCH323ParingStatus) {
///Success
MobileRTCH323ParingStatus_Success = 0,
///Meeting does not Exist
MobileRTCH323ParingStatus_MeetingNotExisted,
///No permission
MobileRTCH323ParingStatus_PermissionDenied,
///Paring Code is not existed
MobileRTCH323ParingStatus_ParingcodeNotExisted,
///Error
MobileRTCH323ParingStatus_Error,
};
/*!
@brief MobileRTCComponentType An enumeration of all component types.
*/
typedef NS_ENUM(NSUInteger, MobileRTCComponentType) {
///Default component type.
MobileRTCComponentType_Def = 0,
///Chat.
MobileRTCComponentType_Chat,
///File Transfer.
MobileRTCComponentType_FT,
///Audio.
MobileRTCComponentType_AUDIO,
///Video.
MobileRTCComponentType_VIDEO,
///Share application.
MobileRTCComponentType_AS,
};
/*!
@brief MobileRTCNetworkQuality Quality of session network.
*/
typedef NS_ENUM(NSInteger, MobileRTCNetworkQuality) {
///Unknown connection status.
MobileRTCNetworkQuality_Unknown = -1,
///The connection quality is very poor.
MobileRTCNetworkQuality_VeryBad = 0,
///The connection quality is very poor.
MobileRTCNetworkQuality_Bad = 1,
///The connection quality is not good.
MobileRTCNetworkQuality_NotGood = 2,
///The connection quality is normal.
MobileRTCNetworkQuality_Normal = 3,
///The connection quality is good.
MobileRTCNetworkQuality_Good = 4,
///The connection quality is excellent.
MobileRTCNetworkQuality_Excellent = 5,
};
/*!
@brief MobileRTCAudioError An enumeration of audio-related operational error states.
*/
typedef NS_ENUM(NSUInteger, MobileRTCAudioError) {
///Success
MobileRTCAudioError_Success = 0,
///The application for Audio Session Recording is Denied
MobileRTCAudioError_AudioPermissionDenied = 1,
///Do not connect to audio session.
MobileRTCAudioError_AudioNotConnected = 2,
///User can not unmute his Audio.
MobileRTCAudioError_CannotUnmuteMyAudio = 3,
/// Failed
MobileRTCAudioError_Failed = 4
};
typedef NS_ENUM(NSUInteger, MobileRTC_AudioStatus) {
///<Initialization.
MobileRTC_AudioStatus_None = 0,
///<Muted status.
MobileRTC_AudioStatus_Audio_Muted = 1,
///<Unmuted status.
MobileRTC_AudioStatus_Audio_UnMuted = 2,
///<Muted by the host.
MobileRTC_AudioStatus_Audio_Muted_ByHost = 3,
///<Unmuted by the host.
MobileRTC_AudioStatus_Audio_UnMuted_ByHost = 4,
///<The host mutes all.
MobileRTC_AudioStatus_Audio_MutedAll_ByHost = 5,
///<The host unmutes all.
MobileRTC_AudioStatus_Audio_UnMutedAll_ByHost = 6,
};
typedef NS_ENUM(NSUInteger, MobileRTC_VideoStatus) {
///<Muted status.
MobileRTC_VideoStatus_Video_ON = 0,
///<Unmuted status.
MobileRTC_VideoStatus_Video_OFF = 1,
///<Muted by the host.
MobileRTC_VideoStatus_Video_Muted_ByHost = 2,
};
/*!
@brief MobileRTCVideoError An enumeration of video-related operational error states.
*/
typedef NS_ENUM(NSUInteger, MobileRTCVideoError) {
///Success
MobileRTCVideoError_Success = 0,
///Camera Permission is Denied
MobileRTCVideoError_CameraPermissionDenied = 1,
///User can not unmute his Audio.
MobileRTCVideoError_CannotUnmuteMyVideo = 3,
};
/*!
@brief MobileRTCCameraError An enumeration of camera-related operational error states.
*/
typedef NS_ENUM(NSUInteger, MobileRTCCameraError) {
///Success
MobileRTCCameraError_Success = 0,
///The permission to enable the camera is denied
MobileRTCCameraError_CameraPermissionDenied = 1,
///The camera can not connect to video session
MobileRTCCameraError_VideoNotSending = 2,
};
/*!
@brief MobileRTCLiveStreamStatus An enumeration of Live Stream status in meeting.
*/
typedef NS_ENUM(NSUInteger, MobileRTCLiveStreamStatus) {
///Start live stream successfully.
MobileRTCLiveStreamStatus_StartSuccessed = 0,
///Start live stream failed
MobileRTCLiveStreamStatus_StartFailedOrEnded = 1,
///Start live stream timeout
MobileRTCLiveStreamStatus_StartTimeout = 2,
};
/*!
@brief MobileRTCClaimHostError An enumeration of CLAIM HOST results in meeting.
*/
typedef NS_ENUM(NSUInteger, MobileRTCClaimHostError) {
///Claim host successfully.
MobileRTCClaimHostError_Successed = 0,
///Host Key Errors.
MobileRTCClaimHostError_HostKeyError = 1,
///Network Errors.
MobileRTCClaimHostError_NetWorkError = 2,
};
/*!
@brief MobileRTCSendChatError An enumeration of SENDING CHAT MESSAGE result in meeting.
*/
typedef NS_ENUM(NSUInteger, MobileRTCSendChatError) {
///Send chat message successfully.
MobileRTCSendChatError_Successed = 0,
///Send chat message failed.
MobileRTCSendChatError_Failed = 1,
///No permission.
MobileRTCSendChatError_PermissionDenied = 2,
};
/*!
@brief MobileRTCAnnotationError An enumeration of annotation-related operational error states.
*/
typedef NS_ENUM(NSUInteger, MobileRTCAnnotationError) {
///Succeeded
MobileRTCAnnotationError_Successed = 0,
///Failed
MobileRTCAnnotationError_Failed = 1,
///No permission.
MobileRTCAnnotationError_PermissionDenied = 2,
};
/*!
@brief MobileRTCCMRError An enumeration of CMR-related result error states.
*/
typedef NS_ENUM(NSUInteger, MobileRTCCMRError) {
///Succeeded
MobileRTCCMRError_Successed = 0,
///Failed
MobileRTCCMRError_Failed = 1,
///The storage is full
MobileRTCCMRError_StorageFull = 2,
};
/*!
@brief MobileRTCJoinMeetingInfo An enumeration of information needed to Join Meeting.
*/
typedef NS_ENUM(NSUInteger, MobileRTCJoinMeetingInfo) {
///Display name is needed.
MobileRTCJoinMeetingInfo_NeedName = 0,
///Meeting password is needed.
MobileRTCJoinMeetingInfo_NeedPassword = 1,
///Meeting password is wrong.
MobileRTCJoinMeetingInfo_WrongPassword = 2,
///Screen name and meeting Password are needed.
MobileRTCJoinMeetingInfo_NeedNameAndPwd = 3,
};
/*!
@brief MobileRTCAudioError An enumeration of Audio Errors.
*/
typedef NS_ENUM(NSUInteger, MobileRTCMicrophoneError) {
///Microphone is muted while speaking.
MobileRTCMicrophoneError_MicMuted = 0,
///Audio feedback is detected when join meeting.
MobileRTCMicrophoneError_FeedbackDetected = 1,
///Microphone is unavailable.
MobileRTCMicrophoneError_MicUnavailable = 2,
};
/*!
@brief MobileRTCAudioError An enumeration of Audio Errors.
*/
typedef NS_ENUM(NSUInteger, MobileRTCMeetingEndReason) {
///User leaves meeting.
MobileRTCMeetingEndReason_SelfLeave = 0,
///The user is removed from meeting by the host.
MobileRTCMeetingEndReason_RemovedByHost = 1,
///Host ends the meeting.
MobileRTCMeetingEndReason_EndByHost = 2,
///Join the meeting before host (JBH) timeout.
MobileRTCMeetingEndReason_JBHTimeout = 3,
///Meeting ends when the free service is over.
MobileRTCMeetingEndReason_FreeMeetingTimeout = 4,
///No ateendee
MobileRTCMeetingEndReason_NoAteendee = 5,
///Meeting ends by the host for he will start another meeting.
MobileRTCMeetingEndReason_HostEndForAnotherMeeting = 6,
///Meeting ends for SDK disconnects, such as network issue.
MobileRTCMeetingEndReason_ConnectBroken = 7,
///Meeting ends by unknown reasons.
MobileRTCMeetingEndReason_Unknown,
};
/*!
@brief MobileRTCRemoteControlError An enumeration of remote control-related operational result in meeting.
*/
typedef NS_ENUM(NSUInteger, MobileRTCRemoteControlError) {
///Succeeded
MobileRTCRemoteControlError_Successed = 0,
///stop
MobileRTCRemoteControlError_Stop = 1,
///Failed
MobileRTCRemoteControlError_Failed = 2,
///No Permission
MobileRTCRemoteControlError_PermissionDenied = 3,
};
/*!
@brief MobileRTCAudioOutput An enumeration of audio output description.
*/
typedef NS_ENUM(NSUInteger, MobileRTCAudioOutput) {
///Unknown
MobileRTCAudioOutput_Unknown = 0,
///Receiver
MobileRTCAudioOutput_Receiver = 1,
///Speaker
MobileRTCAudioOutput_Speaker = 2,
///Headphones
MobileRTCAudioOutput_Headphones = 3,
///Blue-tooth
MobileRTCAudioOutput_Bluetooth = 4,
};
/*!
@brief MobileRTCWebinarAllowAttendeeChat An enumeration of attendee chat permission in webinar.
*/
typedef NS_ENUM(NSUInteger, MobileRTCChatAllowAttendeeChat) {
///Chat is disabled
MobileRTCChatAllowAttendeeChat_ChatWithNone = 1,
///Chat with all
MobileRTCChatAllowAttendeeChat_ChatWithAll = 2,
///Chat with panelist
MobileRTCChatAllowAttendeeChat_ChatWithPanelist = 3,
};
/*!
@brief MobileRTCWebinarPromoteorDepromoteError An enumeration of promoting/demoting attendee and panelist errors in webinar.
*/
typedef NS_ENUM(NSUInteger, MobileRTCWebinarPromoteorDepromoteError) {
///Promote/demote successfully.
MobileRTCWebinarPromoteorDepromoteError_Success = 0,
///The amount of panelist in webinar reaches the upper limit.
MobileRTCWebinarPromoteorDepromoteError_Webinar_Panelist_Capacity_Exceed = 3035,
///The attendees in webinar are not found.
MobileRTCWebinarPromoteorDepromoteError_Not_Found_Webinar_Attendee = 3029,
};
/*!
@brief MobileRTCMeetingItemAudioType An enumeration of audio types in meeting.
*/
typedef NS_ENUM(NSUInteger, MobileRTCMeetingItemAudioType) {
///Unknown
MobileRTCMeetingItemAudioType_Unknown = 0,
///Telephone Only
MobileRTCMeetingItemAudioType_TelephoneOnly = 1,
///VoIP Only
MobileRTCMeetingItemAudioType_VoipOnly = 2,
///Telephone And VoIP
MobileRTCMeetingItemAudioType_TelephoneAndVoip = 3,
///The 3rd Party Audio
MobileRTCMeetingItemAudioType_3rdPartyAudio = 4,
};
/*!
@brief MobileRTCMeetingItemRecordType An enumeration of meeting recording types in meeting.
*/
typedef NS_ENUM(NSUInteger, MobileRTCMeetingItemRecordType) {
///Automatic recording is disabled
MobileRTCMeetingItemRecordType_AutoRecordDisabled = 0,
///Local Recording
MobileRTCMeetingItemRecordType_LocalRecord = 1,
///Cloud Recording
MobileRTCMeetingItemRecordType_CloudRecord = 2,
///Unknown
MobileRTCMeetingItemRecordType_Unknown = 3,
};
/*!
@brief MobileRTCMeetingChatPriviledgeType An enumeration of meeting chat types in meeting.
*/
typedef NS_ENUM(NSUInteger, MobileRTCMeetingChatPriviledgeType) {
/// Unknown type
MobileRTCMeetingChatPriviledge_Unknown = 0,
/// allow attendee to chat with everyone
MobileRTCMeetingChatPriviledge_Everyone_Publicly_And_Privately,
/// allow attendee to chat with host only
MobileRTCMeetingChatPriviledge_Host_Only,
/// allow attendee to chat with no one
MobileRTCMeetingChatPriviledge_No_One,
/// allow attendee to chat with host and public
MobileRTCMeetingChatPriviledge_Everyone_Publicly,
};
/*!
@brief Chat message type.
*/
typedef NS_ENUM(NSUInteger, MobileRTCChatMessageType) {
/// For initialize.
MobileRTCChatMessageType_To_None = 0,
/// Chat message is send to all.
MobileRTCChatMessageType_To_All,
/// Chat message is send to all panelists.
MobileRTCChatMessageType_To_All_Panelist,
/// Chat message is send to individual attendee and cc panelists.
MobileRTCChatMessageType_To_Individual_Panelist,
/// Chat message is send to individual user.
MobileRTCChatMessageType_To_Individual,
/// Chat message is send to waiting room user.
MobileRTCChatMessageType_To_WaitingRoomUsers,
};
typedef NS_ENUM(NSUInteger, MobileRTCVideoType) {
///Video Camera Data
MobileRTCVideoType_VideoData = 1,
///Share Data
MobileRTCVideoType_ShareData,
};
/*!
@brief MobileRTCVideoResolution An enumeration of video raw data resolution.
*/
typedef NS_ENUM(NSUInteger, MobileRTCVideoResolution) {
/// video resolution 90
MobileRTCVideoResolution_90 = 0,
/// video resolution 180
MobileRTCVideoResolution_180,
/// video resolution 360
MobileRTCVideoResolution_360,
/// video resolution 720
MobileRTCVideoResolution_720,
};
/*!
@brief MobileRTCVideoResolution An enumeration of video raw data format.
*/
typedef NS_ENUM(NSUInteger, MobileRTCVideoRawDataFormat) {
MobileRTCVideoRawDataFormatI420 = 1,
MobileRTCVideoRawDataFormatI420_Limit,
};
/*!
@brief MobileRTCVideoResolution The direction of video.
*/
typedef NS_ENUM(NSInteger, MobileRTCVideoRawDataRotation) {
/// video direction 0
MobileRTCVideoRawDataRotationNone = 1,
/// video direction 90
MobileRTCVideoRawDataRotation90,
/// video direction 180
MobileRTCVideoRawDataRotation180,
/// video direction 270
MobileRTCVideoRawDataRotation270,
};
/*!
@brief MobileRTCRawDataError An enumeration of raw data.
*/
typedef NS_ENUM(NSUInteger,MobileRTCRawDataError)
{
MobileRTCRawData_Success = 0,
MobileRTCRawData_Uninitialized,
MobileRTCRawData_Malloc_Failed,
MobileRTCRawData_Wrongusage,
MobileRTCRawData_Invalid_Param,
MobileRTCRawData_Not_In_Meeting,
MobileRTCRawData_No_License,
MobileRTCRawData_Video_Module_Not_Ready,
MobileRTCRawData_Video_Module_Error,
MobileRTCRawData_Video_device_error,
MobileRTCRawData_No_Video_Data,
MobileRTCRawData_Share_Module_Not_Ready,
MobileRTCRawData_Hare_Module_Error,
MobileRTCRawData_No_Share_Data,
MobileRTCRawData_Audio_Module_Not_Ready,
MobileRTCRawData_Audio_Module_Error,
MobileRTCRawData_No_Audio_Data,
};
/*!
@brief Rawdata memory mode.
*/
typedef NS_ENUM(NSUInteger, MobileRTCRawDataMemoryMode) {
MobileRTCRawDataMemoryModeStack = 0,
MobileRTCRawDataMemoryModeHeap
};
/*!
@brief Locale fo Customer.
*/
typedef NS_ENUM(NSUInteger, MobileRTC_ZoomLocale) {
MobileRTC_ZoomLocale_Default = 0,
MobileRTC_ZoomLocale_CN
};
/*!
@brief for SMS service usage.
*/
typedef NS_ENUM(NSUInteger, MobileRTCSMSVerifyResult) {
MobileRTCSMSVerifyResult_Succ = 0,
MobileRTCSMSVerifyResult_RealNameAuthErrorIdentifyCode,
MobileRTCSMSVerifyResult_RealNameAuthIdentifyCodeExpired,
MobileRTCSMSVerifyResult_RealNameAuthBypassVerify,
MobileRTCSMSVerifyResult_RealNameAuthUnknownError,
};
typedef NS_ENUM(NSUInteger, MobileRTCSMSRetrieveResult) {
MobileRTCSMSRetrieveResult_Succ = 0,
MobileRTCSMSRetrieveResult_SendSMSFailed,
MobileRTCSMSRetrieveResult_RequestFailed,
MobileRTCSMSRetrieveResult_InvalidPhoneNum,
MobileRTCSMSRetrieveResult_PhoneNumAlreadyBound,
MobileRTCSMSRetrieveResult_PhoneNumSendTooFrequent,
MobileRTCSMSRetrieveResult_BypassVerify,
};
/*!
@brief Minimize Meeting state in Zoom UI.
*/
typedef NS_ENUM(NSUInteger, MobileRTCMinimizeMeetingState) {
MobileRTCMinimizeMeeting_ShowMinimizeMeeting = 0,
MobileRTCMinimizeMeeting_BackFullScreenMeeting
};
/*!
@brief free meeting need upgrade type.
*/
typedef NS_ENUM(NSUInteger, FreeMeetingNeedUpgradeType) {
FreeMeetingNeedUpgradeType_NONE = 0,
FreeMeetingNeedUpgradeType_BY_ADMIN,
FreeMeetingNeedUpgradeType_BY_GIFTURL,
};
/*!
@brief enum for BO status.
*/
typedef NS_ENUM(NSUInteger, MobileRTCBOStatus) {
MobileRTCBOStatus_Invalid = 0,
MobileRTCBOStatus_Edit = 1, //<edit & assign
MobileRTCBOStatus_Started, //<BO is started
MobileRTCBOStatus_Stopping, //<stopping BO
MobileRTCBOStatus_Ended //<BO is ended
};
/*!
@brief Result for requested help from attendee in BO Meeting
*/
typedef NS_ENUM(NSUInteger, MobileRTCBOHelpReply) {
MobileRTCBOHelpReply_Idle = 0, //host receive the help request and there is no other one currently requesting for help
MobileRTCBOHelpReply_Busy, //host is handling other's request with the request dialog, no chance to show dialog for this request
MobileRTCBOHelpReply_Ignore, //host click "later" button or close the request dialog directly
MobileRTCBOHelpReply_alreadyInBO //host already in your BO meeting
};
/*!
@brief Error type of Starting BO Failed
*/
typedef NS_ENUM(NSUInteger, MobileRTCBOControllerError) {
MobileRTCBOControllerError_NULL_POINTER = 0,
MobileRTCBOControllerError_WRONG_CURRENT_STATUS,
MobileRTCBOControllerError_TOKEN_NOT_READY,
MobileRTCBOControllerError_NO_PRIVILEGE,
MobileRTCBOControllerError_BO_LIST_IS_UPLOADING,
MobileRTCBOControllerError_UPLOAD_FAIL,
MobileRTCBOControllerError_NO_ONE_HAS_BEEN_ASSIGNED,
MobileRTCBOControllerError_UNKNOWN = 100
};
/*!
@brief Direct sharing status.
*/
typedef NS_ENUM(NSUInteger, MobileRTCDirectShareStatus) {
MobileRTCDirectShareStatus_Unknown = 0, //<Only for initialization.
MobileRTCDirectShareStatus_Connecting, //<Waiting for enabling the direct sharing.
MobileRTCDirectShareStatus_In_Direct_Share_Mode, //<In direct sharing mode.
MobileRTCDirectShareStatus_Ended, //<End the direct sharing.
MobileRTCDirectShareStatus_Need_MeetingID_Or_PairingCode, //<Re-enter the meeting ID/paring code.
MobileRTCDirectShareStatus_NetWork_Error, //<Network error. Please try again later.
MobileRTCDirectShareStatus_Other_Error, //<Other errors. Mainly occur in SIP call mode.
MobileRTCDirectShareStatus_WrongMeetingID_Or_SharingKey, //<Wrong meeting id or sharing key.
MobileRTCDirectShareStatus_Need_Input_New_ParingCode, //<require input paringCode again for users on a different network.
MobileRTCDirectShareStatus_DirectShare_Prepared // Direct share prepared
};
/*!
@brief emoji reacion type.
*/
typedef NS_ENUM(NSUInteger, MobileRTCEmojiReactionType) {
MobileRTCEmojiReactionType_Unknown = 0, /// unknow
MobileRTCEmojiReactionType_Clap, /// clap
MobileRTCEmojiReactionType_Thumbsup, /// thumbsup
MobileRTCEmojiReactionType_Heart, /// heart
MobileRTCEmojiReactionType_Joy, /// joy
MobileRTCEmojiReactionType_Openmouth, /// openmouth
MobileRTCEmojiReactionType_Tada, /// tada
};
/*!
@brief emoji reaction skin tone.
*/
typedef NS_ENUM(NSUInteger, MobileRTCEmojiReactionSkinTone) {
MobileRTCEmojiReactionSkinTone_Unknown = 0,/// unknow
MobileRTCEmojiReactionSkinTone_Default, /// default skin tone
MobileRTCEmojiReactionSkinTone_Light, /// light skin tone
MobileRTCEmojiReactionSkinTone_MediumLight, /// medium light skin tone
MobileRTCEmojiReactionSkinTone_Medium, /// medium skin tone
MobileRTCEmojiReactionSkinTone_MediumDark, /// medium dark skin tone
MobileRTCEmojiReactionSkinTone_Dark, /// dark skin tone
};
/*!
@brief Enumeration of meeting types
*/
typedef NS_ENUM(NSUInteger, MobileRTCMeetingType) {
//There is no meeting.
MobileRTCMeetingType_None,
//Normal meeting.
MobileRTCMeetingType_Normal,
//Breakout meeting.
MobileRTCMeetingType_BreakoutRoom,
//Webinar.
MobileRTCMeetingType_Webinar,
};
/*!
@brief Enumeration of user roles.
*/
typedef NS_ENUM(NSUInteger, MobileRTCUserRole) {
//For initialization.
MobileRTCUserRole_None,
//Host.
MobileRTCUserRole_Host,
//Co-host.
MobileRTCUserRole_CoHost,
//Attendee in the webinar.
MobileRTCUserRole_Attendee,
//Panelist.
MobileRTCUserRole_Panelist,
//Moderator of breakout room.
MobileRTCUserRole_BreakoutRoom_Moderator,
};
/*!
@brief Enumeration of recording status.
*/
typedef NS_ENUM(NSUInteger, MobileRTCRecordingStatus) {
//recording start.
MobileRTCRecording_Start,
//recording stop.
MobileRTCRecording_Stop,
//Pause recording.
MobileRTCRecording_Pause,
//recording connecting.
MobileRTCRecording_Connecting,
//recording disk full.
MobileRTCRecording_DiskFull,
};
/*!
@brief Enumeration of LockShare Status changed.
*/
typedef NS_ENUM(NSUInteger, MobileRTCShareSettingType)
{
/// share settings type none
MobileRTCShareSettingType_None,
/// Only host can share, the same as "lock share"
MobileRTCShareSettingType_LockShare,
/// Anyone can share, but one sharing only at one moment, and only host can grab other's sharing
MobileRTCShareSettingType_HostGrab,
/// Anyone can share, but one sharing only at one moment, and anyone can grab other's sharing
MobileRTCShareSettingType_AnyoneGrab,
/// Anyone can share, Multi-share can exist at the same time
MobileRTCShareSettingType_MultiShare,
};
/*!
@brief Enumeration of virtual background type in MobileRTCVirtualBGImageInfo .
*/
typedef NS_ENUM(NSInteger, MobileRTCVBType)
{
/// virtual background type none
MobileRTCVBType_None,
/// virtual background type blur
MobileRTCVBType_Blur,
/// virtual background type with image
MobileRTCVBType_Item
};