Agora RTC Objective-C API Reference Refactor

Enumerations
AgoraEnumerates.h File Reference

Go to the source code of this file.

## Enumerations
enum | AgoraVideoCodecTypeForStream { AgoraVideoCodecTypeH264ForStream = 1, AgoraVideoCodecTypeH265ForStream = 2 }
enum | AgoraChannelProfile { AgoraChannelProfileCommunication = 0, AgoraChannelProfileLiveBroadcasting = 1, AgoraChannelProfileGame = 2, AgoraChannelProfileCloudGaming = 3, AgoraChannelProfileCommunication_1v1 = 4 }
enum | AgoraClientRole { AgoraClientRoleBroadcaster = 1, AgoraClientRoleAudience = 2 }
enum | AgoraAudienceLatencyLevelType { AgoraAudienceLatencyLevelLowLatency = 1, AgoraAudienceLatencyLevelUltraLowLatency = 2 }
enum | AgoraCaptureBrightnessLevelType { AgoraCaptureBrightnessLevelInvalid = -1, AgoraCaptureBrightnessLevelNormal = 0, AgoraCaptureBrightnessLevelBright = 1, AgoraCaptureBrightnessLevelDark = 2 }
enum | AgoraCloudProxyType { AgoraNoneProxy = 0, AgoraUdpProxy = 1, AgoraTcpProxy = 2 }
enum | AgoraUserOfflineReason { AgoraUserOfflineReasonQuit = 0, AgoraUserOfflineReasonDropped = 1, AgoraUserOfflineReasonBecomeAudience = 2 }
enum | AgoraLogFilter { AgoraLogFilterOff = 0, AgoraLogFilterDebug = 0x080f, AgoraLogFilterInfo = 0x000f, AgoraLogFilterWarning = 0x000e, AgoraLogFilterError = 0x000c, AgoraLogFilterCritical = 0x0008 }
enum | AgoraAudioFileRecordingType { AgoraAudioFileRecordingTypeMic = 1, AgoraAudioFileRecordingTypePlayback = 2, AgoraAudioFileRecordingTypeMixed = 3 }
enum | AgoraAudioEncodedFrameDelegatePosition { AgoraAudioEncodedFrameObserverPositionRecord = 1, AgoraAudioEncodedFrameObserverPositionPlayback = 2, AgoraAudioEncodedFrameObserverPositionMixed = 3 }
enum | AgoraAudioCodecType
enum | AgoraAudioEncodingType { AgoraAudioEncodingTypeAAC16000Low = 0x010101, AgoraAudioEncodingTypeAAC16000Medium = 0x010102, AgoraAudioEncodingTypeAAC32000Low = 0x010201, AgoraAudioEncodingTypeAAC32000Medium = 0x010202, AgoraAudioEncodingTypeAAC32000High = 0x010203, AgoraAudioEncodingTypeAAC48000Medium = 0x010302, AgoraAudioEncodingTypeAAC48000High = 0x010303, AgoraAudioEncodingTypeOPUS16000Low = 0x020101, AgoraAudioEncodingTypeOPUS6000Medium = 0x020102, AgoraAudioEncodingTypeOPUS48000Medium = 0x020302, AgoraAudioEncodingTypeOPUS48000High = 0x020303 }
enum | AgoraNetworkQuality { AgoraNetworkQualityUnknown = 0, AgoraNetworkQualityExcellent = 1, AgoraNetworkQualityGood = 2, AgoraNetworkQualityPoor = 3, AgoraNetworkQualityBad = 4, AgoraNetworkQualityVBad = 5, AgoraNetworkQualityDown = 6, AgoraNetworkQualityUnsupported = 7, AgoraNetworkQualityDetecting = 8 }
enum | AgoraExperienceQuality { AgoraExperienceQualityGood = 0, AgoraExperienceQualityBad = 1 }
enum | AgoraExperiencePoorReason { AgoraExperiencePoorReasonNone = 0, AgoraExperiencePoorReasonRemoteNetworkQualityPoor = 1, AgoraExperiencePoorReasonLocalNetworkQualityPoor = 2, AgoraExperiencePoorReasonWirelessSignalPoor = 4, AgoraExperiencePoorReasonWifiBluetoothCoexist = 8 }
enum | AgoraLastmileProbeResultState { AgoraLastmileProbeResultComplete = 1, AgoraLastmileProbeResultIncompleteNoBwe = 2, AgoraLastmileProbeResultUnavailable = 3 }
enum | AgoraVideoStreamType { AgoraVideoStreamTypeHigh = 0, AgoraVideoStreamTypeLow = 1 }
enum | AgoraVideoQualityAdaptIndication { AgoraVideoQualityAdaptNone = 0, AgoraVideoQualityAdaptUpBandwidth = 1, AgoraVideoQualityAdaptDownBandwidth = 2 }
enum | AgoraVideoRenderMode { AgoraVideoRenderModeHidden = 1, AgoraVideoRenderModeFit = 2, AgoraVideoRenderModeAdaptive =("AgoraVideoRenderModeAdaptive is deprecated.") = 3 }
enum | AgoraVideoRotation { AgoraVideoRotation_0 = 0, AgoraVideoRotation_90 = 90, AgoraVideoRotation_180 = 180, AgoraVideoRotation_270 = 270, AgoraVideoRotationNone = 0, AgoraVideoRotation90 = 90, AgoraVideoRotation180 = 180, AgoraVideoRotation270 = 270 }
enum | AgoraVideoLocalState { AgoraVideoLocalStateStopped = 0, AgoraVideoLocalStateCapturing = 1, AgoraVideoLocalStateEncoding = 2, AgoraVideoLocalStateFailed = 3 }
enum | AgoraLocalVideoStreamError { AgoraLocalVideoStreamErrorOK = 0, AgoraLocalVideoStreamErrorFailure = 1, AgoraLocalVideoStreamErrorDeviceNoPermission = 2, AgoraLocalVideoStreamErrorDeviceBusy = 3, AgoraLocalVideoStreamErrorCaptureFailure = 4, AgoraLocalVideoStreamErrorEncodeFailure = 5, AgoraLocalVideoStreamErrorCaptureInBackGround = 6, AgoraLocalVideoStreamErrorCaptureMultipleForegroundApps = 7, AgoraLocalVideoStreamErrorCaptureNoDeviceFound = 8, AgoraLocalVideoStreamErrorCaptureDeviceDisconnected = 9, AgoraLocalVideoStreamErrorCaptureDeviceInvalidId = 10, AgoraLocalVideoStreamErrorScreenCaptureWindowMinimized = 11, AgoraLocalVideoStreamErrorScreenCaptureWindowClosed = 12, AgoraLocalVideoStreamErrorScreenCaptureNoPermission = 22, AgoraLocalVideoStreamErrorScreenCaptureDisplayDisconnected = 30 }
enum | AgoraVideoRemoteReason { AgoraVideoRemoteReasonInternal = 0, AgoraVideoRemoteReasonCongestion = 1, AgoraVideoRemoteReasonRecovery = 2, AgoraVideoRemoteReasonLocalMuted = 3, AgoraVideoRemoteReasonLocalUnmuted = 4, AgoraVideoRemoteReasonRemoteMuted = 5, AgoraVideoRemoteReasonRemoteUnmuted = 6, AgoraVideoRemoteReasonRemoteOffline = 7, AgoraVideoRemoteReasonAudioFallback = 8, AgoraVideoRemoteReasonAudioFallbackRecovery = 9, AgoraVideoRemoteReasonSDKInBackground = 12, AgoraVideoRemoteReasonCodecNotSupport = 13 }
enum | AgoraAudioLocalState { AgoraAudioLocalStateStopped = 0, AgoraAudioLocalStateRecording = 1, AgoraAudioLocalStateEncoding = 2, AgoraAudioLocalStateFailed = 3 }
enum | AgoraAudioLocalError { AgoraAudioLocalErrorOK = 0, AgoraAudioLocalErrorFailure = 1, AgoraAudioLocalErrorDeviceNoPermission = 2, AgoraAudioLocalErrorDeviceBusy = 3, AgoraAudioLocalErrorRecordFailure = 4, AgoraAudioLocalErrorEncodeFailure = 5, AgoraAudioLocalErrorNoRecordingDevice = 6, AgoraAudioLocalErrorNoPlayoutDevice = 7, AgoraAudioLocalErrorInterrupted = 8 }
enum | AgoraAudioCodecProfileType { AgoraAudioCodecProfileLCAAC = 0, AgoraAudioCodecProfileHEAAC = 1, AgoraAudioCodecProfileHEAACv2 = 2 }
enum | AgoraAudioRemoteState { AgoraAudioRemoteStateStopped = 0, AgoraAudioRemoteStateStarting = 1, AgoraAudioRemoteStateDecoding = 2, AgoraAudioRemoteStateFrozen = 3, AgoraAudioRemoteStateFailed = 4 }
enum | AgoraAudioRemoteReason { AgoraAudioRemoteReasonInternal = 0, AgoraAudioRemoteReasonNetworkCongestion = 1, AgoraAudioRemoteReasonNetworkRecovery = 2, AgoraAudioRemoteReasonLocalMuted = 3, AgoraAudioRemoteReasonLocalUnmuted = 4, AgoraAudioRemoteReasonRemoteMuted = 5, AgoraAudioRemoteReasonRemoteUnmuted = 6, AgoraAudioRemoteReasonRemoteOffline = 7 }
enum | AgoraAudioProfile { AgoraAudioProfileDefault = 0, AgoraAudioProfileSpeechStandard = 1, AgoraAudioProfileMusicStandard = 2, AgoraAudioProfileMusicStandardStereo = 3, AgoraAudioProfileMusicHighQuality = 4, AgoraAudioProfileMusicHighQualityStereo = 5, AgoraAudioProfileIot = 6 }
enum | AgoraAudioScenario { AgoraAudioScenarioDefault = 0, AgoraAudioScenarioGameStreaming = 3, AgoraAudioScenarioChatRoom = 5, AgoraAudioScenarioChorus = 7, AgoraAudioScenarioMeeting = 8 }
enum | AgoraAudioRawFrameOperationMode { AgoraAudioRawFrameOperationModeReadOnly = 0, AgoraAudioRawFrameOperationModeReadWrite = 2 }
enum | AgoraVoiceBeautifierPreset { AgoraVoiceBeautifierPresetOff = 0x00000000, AgoraVoiceBeautifierPresetChatBeautifierMagnetic = 0x01010100, AgoraVoiceBeautifierPresetChatBeautifierFresh = 0x01010200, AgoraVoiceBeautifierPresetChatBeautifierVitality = 0x01010300, AgoraVoiceBeautifierPresetSingingBeautifier = 0x01020100, AgoraVoiceBeautifierTimbreTransformationVigorous = 0x01030100, AgoraVoiceBeautifierTimbreTransformationDeep = 0x01030200, AgoraVoiceBeautifierTimbreTransformationMellow = 0x01030300, AgoraVoiceBeautifierTimbreTransformationFalsetto = 0x01030400, AgoraVoiceBeautifierTimbreTransformationFull = 0x01030500, AgoraVoiceBeautifierTimbreTransformationClear = 0x01030600, AgoraVoiceBeautifierTimbreTransformationResounding = 0x01030700, AgoraVoiceBeautifierTimbreTransformatRinging = 0x01030800 }
enum | AgoraVoiceConversionPreset { AgoraVoiceConversionPresetOff = 0x00000000, AgoraVoiceConversionPresetNeutral = 0x03010100, AgoraVoiceConversionPresetSweet = 0x03010200, AgoraVoiceConversionPresetChangerSolid = 0x03010300, AgoraVoiceConversionPresetChangerBass = 0x03010400, AgoraVoiceConversionPresetChangerCartoon = 0x03010500, AgoraVoiceConversionPresetChangerChildlike = 0x03010600, AgoraVoiceConversionPresetChangerPhoneOperator = 0x03010700, AgoraVoiceConversionPresetChangerMonster = 0x03010800, AgoraVoiceConversionPresetChangerTransformers = 0x03010900, AgoraVoiceConversionPresetChangerGroot = 0x03010A00, AgoraVoiceConversionPresetChangerDarthVader = 0x03010B00, AgoraVoiceConversionPresetChangerIronLady = 0x03010C00, AgoraVoiceConversionPresetChangerShinchan = 0x03010D00, AgoraVoiceConversionPresetChangerGirlishMan = 0x03010E00, AgoraVoiceConversionPresetChangerChipmunk = 0x03010F00 }
enum | AgoraVideoFormat { AgoraVideoFormatI420 = 1, AgoraVideoFormatBGRA = 2, AgoraVideoFormatNV21 = 3, AgoraVideoFormatRGBA = 4, AgoraVideoFormatNV12 = 8, AgoraVideoFormatCVPixelNV12 = 12, AgoraVideoFormatCVPixelI420 = 13, AgoraVideoFormatCVPixelBGRA = 14, AgoraVideoFormatI422 = 16, AgoraVideoFormatDefault = 0 }
enum | AgoraVideoFrameType { AgoraVideoFrameTypeBlankFrame = 0, AgoraVideoFrameTypeKeyFrame = 3, AgoraVideoFrameTypeDeltaFrame = 4, AgoraVideoFrameTypeBFrame = 5, AgoraVideoFrameTypeDroppableFrame = 6, AgoraVideoFrameTypeUnknow }
enum | AgoraConnectionState { AgoraConnectionStateDisconnected = 1, AgoraConnectionStateConnecting = 2, AgoraConnectionStateConnected = 3, AgoraConnectionStateReconnecting = 4, AgoraConnectionStateFailed = 5 }
enum | AgoraNetworkType { AgoraNetworkTypeUnknown = -1, AgoraNetworkTypeDisconnected = 0, AgoraNetworkTypeLAN = 1, AgoraNetworkTypeWIFI = 2, AgoraNetworkType2G = 3, AgoraNetworkType3G = 4, AgoraNetworkType4G = 5, AgoraNetworkType5G = 6 }
enum | AgoraDegradationPreference { AgoraDegradationMaintainQuality = 0, AgoraDegradationMaintainFramerate = 1, AgoraDegradationBalanced = 2, AgoraDegradationMaintainResolution = 3 }
enum | AgoraEncodingPreference { AgoraEncodingPreferAuto = -1, AgoraEncodingPrefersoftware = 0, AgoraEncodingPreferhardware = 1 }
enum | AgoraCompressionPreference { AgoraCompressionLowLatency = 0, AgoraCompressionQuality = 1 }
enum | AgoraCodecCapMask { AgoraCodecMaskNone = 0, AgoraCodecMaskHwDec = 1, AgoraCodecMaskHwEnc = 2, AgoraCodecMaskSwDec = 4, AgoraCodecMaskSwEnc = 8 }
enum | AgoraLighteningContrastLevel { AgoraLighteningContrastLow = 0, AgoraLighteningContrastNormal = 1, AgoraLighteningContrastHigh = 2 }
enum | AgoraVideoDenoiserMode { AgoraVideoDenoiserModeAuto = 0, AgoraVideoDenoiserModeManual = 1 }
enum | AgoraVideoDenoiserLevel { AgoraVideoDenoiserLevelHighQuality = 0, AgoraVideoDenoiserLevelFast = 1, AgoraVideoDenoiserLevelStrength = 2 }
enum | AgoraLowlightEnhanceMode { AgoraLowlightEnhanceModeAuto = 0, AgoraLowlightEnhanceModeManual = 1 }
enum | AgoraLowlightEnhanceLevel { AgoraLowlightEnhanceLevelQuality = 0, AgoraLowlightEnhanceLevelFast = 1 }
enum | AgoraVirtualBackgroundSourceType { AgoraVirtualBackgroundNone = 0, AgoraVirtualBackgroundColor = 1, AgoraVirtualBackgroundImg = 2, AgoraVirtualBackgroundBlur = 3, AgoraVirtualBackgroundVideo = 4 }
enum | AgoraBlurDegree { AgoraBlurLow = 1, AgoraBlurMedium = 2, AgoraBlurHigh = 3 }
enum | AgoraMaxMetadataSizeType
enum | AgoraLogLevel { AgoraLogLevelNone = 0x0000, AgoraLogLevelInfo = 0x0001, AgoraLogLevelWarn = 0x0002, AgoraLogLevelError = 0x0004, AgoraLogLevelFatal = 0x0008 }
enum | AgoraAreaCodeType { AgoraAreaCodeTypeCN = 0x1, AgoraAreaCodeTypeNA = 0x2, AgoraAreaCodeTypeEUR = 0x4, AgoraAreaCodeTypeAS = 0x8, AgoraAreaCodeTypeJP = 0x10, AgoraAreaCodeTypeIN = 0x20, AgoraAreaCodeTypeRU = 0x1000, AgoraAreaCodeTypeGlobal = 0xFFFFFFFF }
enum | AgoraRtmpStreamingState { AgoraRtmpStreamingStateIdle = 0, AgoraRtmpStreamingStateConnecting = 1, AgoraRtmpStreamingStateRunning = 2, AgoraRtmpStreamingStateRecovering = 3, AgoraRtmpStreamingStateFailure = 4, AgoraRtmpStreamingStateDisconnecting = 5 }
enum | AgoraRtmpStreamingErrorCode { AgoraRtmpStreamingErrorCodeOK = 0, AgoraRtmpStreamingErrorCodeInvalidParameters = 1, AgoraRtmpStreamingErrorCodeEncryptedStreamNotAllowed = 2, AgoraRtmpStreamingErrorCodeConnectionTimeout = 3, AgoraRtmpStreamingErrorCodeInternalServerError = 4, AgoraRtmpStreamingErrorCodeRtmpServerError = 5, AgoraRtmpStreamingErrorCodeTooOften = 6, AgoraRtmpStreamingErrorCodeReachLimit = 7, AgoraRtmpStreamingErrorCodeNotAuthorized = 8, AgoraRtmpStreamingErrorCodeStreamNotFound = 9, AgoraRtmpStreamingErrorCodeFormatNotSupported = 10, AgoraRtmpStreamingErrorNotBroadcaster = 11, AgoraRtmpStreamingErrorTranscodingNoMixStream = 13, AgoraRtmpStreamingErrorNetDown = 14, AgoraRtmpStreamingErrorInvalidAppId = 15, AgoraRtmpStreamingErrorInvalidPrivilege = 16, AgoraRtmpStreamingErrorCodeUnpublishOK = 100 }
enum | AgoraRtmpStreamingEvent { AgoraRtmpStreamingEventFailedLoadImage = 1, AgoraRtmpStreamingEventUrlAlreadyInUse = 2, AgoraRtmpStreamingEventAdvancedFeatureNotSupport = 3, AgoraRtmpStreamingEventRequestTooOften = 4 }
enum | AgoraEncryptionErrorType { ENCRYPTION_ERROR_INTERNAL_FAILURE = 0, ENCRYPTION_ERROR_DECRYPTION_FAILURE = 1, ENCRYPTION_ERROR_ENCRYPTION_FAILURE = 2, ENCRYPTION_ERROR_DATASTREAM_DECRYPTION_FAILURE = 3, ENCRYPTION_ERROR_DATASTREAM_ENCRYPTION_FAILURE = 4 }
enum | AgoraCameraDirection { AgoraCameraDirectionRear = 0, AgoraCameraDirectionFront = 1 }
enum | AgoraCameraStabilizationMode { AgoraCameraStabilizationModeOff = -1, AgoraCameraStabilizationModeAuto = 0, AgoraCameraStabilizationModeLevel1 = 1, AgoraCameraStabilizationModeLevel2 = 2, AgoraCameraStabilizationModeLevel3 = 3 }
enum | AgoraChannelMediaRelayState { AgoraChannelMediaRelayStateIdle = 0, AgoraChannelMediaRelayStateConnecting = 1, AgoraChannelMediaRelayStateRunning = 2, AgoraChannelMediaRelayStateFailure = 3 }
enum | AgoraChannelMediaRelayEvent { AgoraChannelMediaRelayEventDisconnect = 0, AgoraChannelMediaRelayEventConnected = 1, AgoraChannelMediaRelayEventJoinedSourceChannel = 2, AgoraChannelMediaRelayEventJoinedDestinationChannel = 3, AgoraChannelMediaRelayEventSentToDestinationChannel = 4, AgoraChannelMediaRelayEventReceivedVideoPacketFromSource = 5, AgoraChannelMediaRelayEventReceivedAudioPacketFromSource = 6, AgoraChannelMediaRelayEventUpdateDestinationChannel = 7, AgoraChannelMediaRelayEventUpdateDestinationChannelRefused = 8, AgoraChannelMediaRelayEventUpdateDestinationChannelNotChange = 9, AgoraChannelMediaRelayEventUpdateDestinationChannelIsNil = 10, AgoraChannelMediaRelayEventVideoProfileUpdate = 11 }
enum | AgoraChannelMediaRelayError { AgoraChannelMediaRelayErrorNone = 0, AgoraChannelMediaRelayErrorServerErrorResponse = 1, AgoraChannelMediaRelayErrorServerNoResponse = 2, AgoraChannelMediaRelayErrorNoResourceAvailable = 3, AgoraChannelMediaRelayErrorFailedJoinSourceChannel = 4, AgoraChannelMediaRelayErrorFailedJoinDestinationChannel = 5, AgoraChannelMediaRelayErrorFailedPacketReceivedFromSource = 6, AgoraChannelMediaRelayErrorFailedPacketSentToDestination = 7, AgoraChannelMediaRelayErrorServerConnectionLost = 8, AgoraChannelMediaRelayErrorInternalError = 9, AgoraChannelMediaRelayErrorSourceTokenExpired = 10, AgoraChannelMediaRelayErrorDestinationTokenExpired = 11 }
enum | AgoraStreamPublishState
enum | AgoraApplicationScenarioType { AgoraApplicationGeneralScenario = 0 }
enum | AgoraScreenScenarioType { AgoraScreenScenarioDocument = 1, AgoraScreenScenarioGaming = 2, AgoraScreenScenarioVideo = 3, AgoraScreenScenarioRDC = 4 }
enum | AgoraMediaSourceType { AgoraMediaSourceTypeAudioPlayout = 0, AgoraMediaSourceTypeRecording = 1, AgoraMediaSourceTypePrimaryCamera = 2, AgoraMediaSourceTypeSecondaryCamera = 3, AgoraMediaSourceTypePrimaryScreen = 4, AgoraMediaSourceTypeSecondaryScreen = 5, AgoraMediaSourceTypeCustomVideo = 6, AgoraMediaSourceTypeMediaPlayer = 7, AgoraMediaSourceTypeRtcImagePng = 8, AgoraMediaSourceTypeRtcImageJpeg = 9, AgoraMediaSourceTypeRtcImageGif = 10, AgoraMediaSourceTypeRemoteVideo = 11, AgoraMediaSourceTypeTranscodedVideo = 12, AgoraMediaSourceTypeSpeechDriven = 13, AgoraMediaSourceTypeUnknown = 100 }
enum | AgoraVideoSourceType { AgoraVideoSourceTypeCamera = 0, AgoraVideoSourceTypeCameraSecondary = 1, AgoraVideoSourceTypeScreen = 2, AgoraVideoSourceTypeScreenSecondary = 3, AgoraVideoSourceTypeCustom = 4, AgoraVideoSourceTypeMediaPlayer = 5, AgoraVideoSourceTypeImagePNG = 6, AgoraVideoSourceTypeImageJPEG = 7, AgoraVideoSourceTypeImageGIF = 8, AgoraVideoSourceTypeRemote = 9, AgoraVideoSourceTypeTransCoded = 10, AgoraVideoSourceTypeCameraThird = 11, AgoraVideoSourceTypeCameraFourth = 12, AgoraVideoSourceTypeScreenThird = 13, AgoraVideoSourceTypeScreenFourth = 14, AgoraVideoSourceTypeSpeechDriven = 15, AgoraVideoSourceTypeUnknown = 100 }
enum | AgoraExternalVideoSourceType { AgoraExternalVideoSourceTypeVideoFrame = 0, AgoraExternalVideoSourceTypeEncodedVideoFrame }
enum | AgoraSimulcastStreamMode { AgoraAutoSimulcastStream = -1, AgoraDisableSimulcastStream = 0, AgoraEnableSimulcastStream = 1 }
enum | AgoraMediaStreamType { AgoraMediaStreamTypeUnknown = 0, AgoraMediaStreamTypeVideo = 1, AgoraMediaStreamTypeAudio = 2, AgoraMediaStreamTypeSubtitle = 3, AgoraMediaStreamTypeUnknow = 0, AgoraMediaStreamTypeVideo = 1, AgoraMediaStreamTypeAudio = 2, AgoraMediaStreamTypeSubtitle = 3 }
enum | AgoraMediaPlayerRenderMode { AgoraMediaPlayerRenderModeHidden = 1, AgoraMediaPlayerRenderModeFit = 2, AgoraMediaPlayerRenderModeHidden = 1, AgoraMediaPlayerRenderModeFit = 2 }
enum | AgoraMediaPlayerError { AgoraMediaPlayerErrorNone = 0, AgoraMediaPlayerErrorInvalidArguments = -1, AgoraMediaPlayerErrorInternal = -2, AgoraMediaPlayerErrorNoSource = -3, AgoraMediaPlayerErrorInvalidMediaSource = -4, AgoraMediaPlayerErrorUnknowStreamType = -5, AgoraMediaPlayerErrorObjNotInitialized = -6, AgoraMediaPlayerErrorCodecNotSupported = -7, AgoraMediaPlayerErrorVideoRenderFailed = -8, AgoraMediaPlayerErrorInvalidState = -9, AgoraMediaPlayerErrorUrlNotFound = -10, AgoraMediaPlayerErrorInvalidConnectState = -11, AgoraMediaPlayerErrorSrcBufferUnderflow = -12, AgoraMediaPlayerErrorInterrupted = -13, AgoraMediaPlayerErrorNotSupported = -14, AgoraMediaPlayerErrorTokenExpired = -15, AgoraMediaPlayerErrorIpExpired = -16, AgoraMediaPlayerErrorUnknown = -17, AgoraMediaPlayerErrorNone = 0, AgoraMediaPlayerErrorInvalidArguments = -1, AgoraMediaPlayerErrorInternal = -2, AgoraMediaPlayerErrorNoSource = -3, AgoraMediaPlayerErrorInvalidMediaSource = -4, AgoraMediaPlayerErrorUnknowStreamType = -5, AgoraMediaPlayerErrorObjNotInitialized = -6, AgoraMediaPlayerErrorCodecNotSupported = -7, AgoraMediaPlayerErrorVideoRenderFailed = -8, AgoraMediaPlayerErrorInvalidState = -9, AgoraMediaPlayerErrorUrlNotFound = -10, AgoraMediaPlayerErrorInvalidConnectState = -11, AgoraMediaPlayerErrorSrcBufferUnderflow = -12 }
enum | AgoraMediaPlayerEvent { AgoraMediaPlayerEventSeekBegin = 0, AgoraMediaPlayerEventSeekComplete = 1, AgoraMediaPlayerEventSeekError = 2, AgoraMediaPlayerEventAudioTrackChanged = 5, AgoraMediaPlayerEventBufferLow = 6, AgoraMediaPlayerEventBufferRecover = 7, AgoraMediaPlayerEventFreezeStart = 8, AgoraMediaPlayerEventFreezeStop = 9, AgoraMediaPlayerEventSwitchBegin = 10, AgoraMediaPlayerEventSwitchComplete = 11, AgoraMediaPlayerEventSwitchError = 12, AgoraMediaPlayerEventFirstDisplayed = 13, AgoraMediaPlayerEventReachCacheFileMaxCount = 14, AgoraMediaPlayerEventReachCacheFileMaxSize = 15, AgoraMediaPlayerEventTryOpenStart = 16, AgoraMediaPlayerEventTryOpenSucceed = 17, AgoraMediaPlayerEventTryOpenFailed = 18, AgoraMediaPlayerEventSeekBegin = 0, AgoraMediaPlayerEventSeekComplete = 1, AgoraMediaPlayerEventSeekError = 2, AgoraMediaPlayerEventAudioTrackChanged = 5, AgoraMediaPlayerEventBufferLow = 6, AgoraMediaPlayerEventBufferRecover = 7 }
enum | AgoraMediaPlayerMetaDataType { AgoraMediaPlayerMetaDataTypeUnknown = 0, AgoraMediaPlayerMetaDataTypeSEI = 1, AgoraMediaPlayerMetaDataTypeUnknown = 0, AgoraMediaPlayerMetaDataTypeSEI = 1 }
enum | AgoraPermissionType { AgoraPermissionTypeRecordAudio = 0, AgoraPermissionTypeCamera = 1 }
enum | AgoraEarMonitoringFilterType { AgoraEarMonitoringFilterNone = (1<<0), AgoraEarMonitoringFilterBuiltInAudioFilters = (1<<1), AgoraEarMonitoringFilterNoiseSuppression = (1<<2), AgoraEarMonitoringFilterReusePostProcessingFilter = (1<<15) }
enum | AgoraAudioFramePosition { AgoraAudioFramePositionPlayback = 1 << 0, AgoraAudioFramePositionRecord = 1 << 1, AgoraAudioFramePositionMixed = 1 << 2, AgoraAudioFramePositionBeforeMixing = 1 << 3, AgoraAudioFramePositionEarMonitoring = 1 << 4 }
enum | AgoraVideoContentHint { AgoraVideoContentHintNone = 0, AgoraVideoContentHintMotion = 1, AgoraVideoContentHintDetails = 2 }
enum | AgoraThreadPriorityType { AgoraThreadPriorityTypeLowest = 0, AgoraThreadPriorityTypeLow = 1, AgoraThreadPriorityTypeNormal = 2, AgoraThreadPriorityTypeHigh = 3, AgoraThreadPriorityTypeHighest = 4, AgoraThreadPriorityTypeCritical = 5 }
enum | AgoraAudioDualMonoMode { AgoraAudioDualMonoStereo, AgoraAudioDualMonoL, AgoraAudioDualMonoR }
enum | AgoraRhythmPlayerState { AgoraRhythmPlayerStateIdle = 810, AgoraRhythmPlayerStateOpening, AgoraRhythmPlayerStateDecoding, AgoraRhythmPlayerStatePlaying, AgoraRhythmPlayerStateFailed }
enum | AgoraRhythmPlayerError { AgoraRhythmPlayerErrorOK = 0, AgoraRhythmPlayerErrorFailed = 1, AgoraRhythmPlayerErrorCanNotOpen = 801, AgoraRhythmPlayerErrorCanNotPlay, AgoraRhythmPlayerErrorFileOverDurationLimit }
enum | AgoraVideoTranscoderError { AgoraVideoTranscoderErrorOK = 0, AgoraVideoTranscoderErrorVideoSourceNotReady = 1, AgoraVideoTranscoderErrorInvalidVideoSourceType = 2, AgoraVideoTranscoderErrorInvalidImagePath = 3, AgoraVideoTranscoderErrorUnsupportImageFormat = 4, AgoraVideoTranscoderErrorInvalidLayout = 5, AgoraVideoTranscoderErrorInternal = 20 }
enum | AgoraProxyType { AgoraNoneProxyType = 0, AgoraUdpProxyType = 1, AgoraTcpProxyType = 2, AgoraLocalProxyType = 3, AgoraTcpProxyAutoFallbackType = 4, AgoraHttpProxyType = 5, AgoraHttpsProxyType = 6 }
enum | AgoraVideoViewSetupMode
enum | AgoraVideoFramePosition { AgoraVideoFramePositionPostCapture = 1 << 0, AgoraVideoFramePositionPreRenderer = 1 << 1, AgoraVideoFramePositionPreEncoder = 1 << 2 }
enum | AgoraWlAccReason { AgoraWlAccMessageReasonWeakSignal = 0, AgoraWlAccMessageReasonChannelCongestion = 1 }
enum | AgoraWlAccAction { AgoraWlAccSuggestActionCloseToWIFI = 0, AgoraWlAccSuggestActionConnectSSID = 1, AgoraWlAccSuggestActionCheck5G = 2, AgoraWlAccSuggestActionModifySSID = 3 }
enum | AgoraMediaRecorderState { AgoraMediaRecorderStateError = -1, AgoraMediaRecorderStateStarted = 2, AgoraMediaRecorderStateStopped = 3 }
enum | AgoraMediaRecorderErrorCode { AgoraMediaRecorderErrorCodeNoError = 0, AgoraMediaRecorderErrorCodeWriteFailed = 1, AgoraMediaRecorderErrorCodeNoStream = 2, AgoraMediaRecorderErrorCodeOverMaxDuration = 3, AgoraMediaRecorderErrorCodeConfigChange = 4 }
enum | AgoraMediaRecorderStreamType { AgoraMediaRecorderStreamTypeAudio = 1, AgoraMediaRecorderStreamTypeVideo = 2, AgoraMediaRecorderStreamTypeBoth = 3 }
enum | AgoraMediaRecorderContainerFormat { AgoraMediaRecorderContainerFormatMP4 = 1 }
enum | AgoraScreenCaptureSourceType { AgoraScreenCaptureSourceTypeUnknown = -1, AgoraScreenCaptureSourceTypeWindow = 0, AgoraScreenCaptureSourceTypeScreen = 1, AgoraScreenCaptureSourceTypeCustom = 2 }
enum | AUDIO_AINS_MODE { AINS_MODE_BALANCED = 0, AINS_MODE_AGGRESSIVE = 1, AINS_MODE_ULTRALOWLATENCY = 2 }
enum | AgoraMediaTraceEvent { AgoraMediaTraceEventVideoRendered = 0, AgoraMediaTraceEventVideoDecoded = 1 }

## Enumeration Type Documentation

## ◆ AgoraVideoCodecCapabilityLevel

enum AgoraVideoCodecCapabilityLevel

Enumerator
AgoraVideoCodecCapabilityLevelUnspecified |
AgoraVideoCodecCapabilityLevelBasicSupport |
AgoraVideoCodecCapabilityLevel1080p30fps |
AgoraVideoCodecCapabilityLevel1080p60fps |
AgoraVideoCodecCapabilityLevel4k60fps |

## ◆ AgoraVideoHwEncoderAccelerating

enum AgoraVideoHwEncoderAccelerating

Enumerator
AgoraVideoHwEncoderSoftware |
AgoraVideoHwEncoderHardware |

## ◆ AgoraVideoFrameOrientation

enum AgoraVideoFrameOrientation

Enumerator
AgoraVideoFrameOrientation0 |
AgoraVideoFrameOrientation90 |
AgoraVideoFrameOrientation180 |
AgoraVideoFrameOrientation270 |

## ◆ AgoraVideoCodecTypeForStream

enum AgoraVideoCodecTypeForStream

The video codec type of the output video stream.

Since
  v3.2.0

Enumerator
AgoraVideoCodecTypeH264ForStream | 1: (Default) H.264
AgoraVideoCodecTypeH265ForStream | 2: H.265

## ◆ AgoraChannelProfile

enum AgoraChannelProfile

The channel profile.

Enumerator
AgoraChannelProfileCommunication | 0: Communication. This profile prioritizes smoothness and applies to the one-to-one scenario.
AgoraChannelProfileLiveBroadcasting | 1: (Default) Live Broadcast. This profile prioritizes supporting a large audience in a live broadcast channel.
AgoraChannelProfileGame | Deprecated: 2: Gaming.
AgoraChannelProfileCloudGaming | Deprecated: 3: Cloud Gaming.
AgoraChannelProfileCommunication_1v1 | Deprecated: 4：1-to-1 communication.

## ◆ AgoraClientRole

enum AgoraClientRole

Client role.

Enumerator
AgoraClientRoleBroadcaster | Broadcaster
AgoraClientRoleAudience | Audience

## ◆ AgoraAudienceLatencyLevelType

enum AgoraAudienceLatencyLevelType

Audience latency levels in broadcaster mode.

Enumerator
AgoraAudienceLatencyLevelLowLatency | 1: Low latency. A low latency audience's jitter buffer is 1.2 second.
AgoraAudienceLatencyLevelUltraLowLatency | 2: Default Ultra low latency. An ultra low latency audience's jitter buffer is 0.5 second.

## ◆ AgoraCaptureBrightnessLevelType

enum AgoraCaptureBrightnessLevelType

The brightness level of the video image captured by the local camera.

Enumerator
AgoraCaptureBrightnessLevelInvalid | -1: The SDK does not detect the brightness level of the video image. Wait a few seconds to get the brightness level in the next callback.
AgoraCaptureBrightnessLevelNormal | 0: The brightness level of the video image is normal.
AgoraCaptureBrightnessLevelBright | 1: The brightness level of the video image is too bright.
AgoraCaptureBrightnessLevelDark | 2: The brightness level of the video image is too dark.

## ◆ AgoraCloudProxyType

enum AgoraCloudProxyType

The cloud proxy type.

Enumerator
AgoraNoneProxy | Do not use the cloud proxy.
AgoraUdpProxy | The cloud proxy for the UDP protocol.
AgoraTcpProxy | The cloud proxy for the TCP (encrypted) protocol.

## ◆ AgoraUserOfflineReason

enum AgoraUserOfflineReason

Reason for the user being offline

Enumerator
AgoraUserOfflineReasonQuit | A user has quit the call.
AgoraUserOfflineReasonDropped | The SDK timed out and the user dropped offline because it has not received any data package within a certain period of time. If a user quits the call and the message is not passed to the SDK (due to an unreliable channel), the SDK assumes the event has timed out.
AgoraUserOfflineReasonBecomeAudience | User switched to an audience

## ◆ AgoraLogFilter

enum AgoraLogFilter

Output log filter level

Enumerator
AgoraLogFilterOff | Do not output any log information.
AgoraLogFilterDebug | Output all API log information
AgoraLogFilterInfo | Output CRITICAL, ERROR, WARNING, and INFO level log information.
AgoraLogFilterWarning | Outputs CRITICAL, ERROR, and WARNING level log information.
AgoraLogFilterError | Outputs CRITICAL and ERROR level log information
AgoraLogFilterCritical | Outputs CRITICAL level log information.

## ◆ AgoraAudioFileRecordingType

enum AgoraAudioFileRecordingType

The audio file record type.

Enumerator
AgoraAudioFileRecordingTypeMic | mic audio file recording.
AgoraAudioFileRecordingTypePlayback | playback audio file recording.
AgoraAudioFileRecordingTypeMixed | mixed audio file recording.

## ◆ AgoraAudioEncodedFrameDelegatePosition

enum AgoraAudioEncodedFrameDelegatePosition

The encoded audio frame observer position.

Enumerator
AgoraAudioEncodedFrameObserverPositionRecord | mic audio file recording.
AgoraAudioEncodedFrameObserverPositionPlayback | playback audio file recording.
AgoraAudioEncodedFrameObserverPositionMixed | mixed audio file recording.

## ◆ AgoraAudioCodecType

enum AgoraAudioCodecType

The codec type of audio

Enumerator
AgoraAudioCodecTypeOPUS |
AgoraAudioCodecTypeAACLC |
AgoraAudioCodecTypeHEAAC |
AgoraAudioCodecTypeHEAAC2 |

## ◆ AgoraAudioEncodingType

enum AgoraAudioEncodingType

the audio encoding type of audio encoded frame delegate

Enumerator
AgoraAudioEncodingTypeAAC16000Low | codecType AAC; sampleRate 16000; quality low which around 1.2 MB after 10 minutes
AgoraAudioEncodingTypeAAC16000Medium | codecType AAC; sampleRate 16000; quality medium which around 2 MB after 10 minutes
AgoraAudioEncodingTypeAAC32000Low | codecType AAC; sampleRate 32000; quality low which around 1.2 MB after 10 minutes
AgoraAudioEncodingTypeAAC32000Medium | codecType AAC; sampleRate 32000; quality medium which around 2 MB after 10 minutes
AgoraAudioEncodingTypeAAC32000High | codecType AAC; sampleRate 32000; quality high which around 3.5 MB after 10 minutes
AgoraAudioEncodingTypeAAC48000Medium | codecType AAC; sampleRate 48000; quality medium which around 2 MB after 10 minutes
AgoraAudioEncodingTypeAAC48000High | codecType AAC; sampleRate 48000; quality high which around 3.5 MB after 10 minutes
AgoraAudioEncodingTypeOPUS16000Low | codecType OPUS; sampleRate 16000; quality low which around 1.2 MB after 10 minutes
AgoraAudioEncodingTypeOPUS6000Medium | codecType OPUS; sampleRate 16000; quality medium which around 2 MB after 10 minutes
AgoraAudioEncodingTypeOPUS48000Medium | codecType OPUS; sampleRate 48000; quality medium which around 2 MB after 10 minutes
AgoraAudioEncodingTypeOPUS48000High | codecType OPUS; sampleRate 48000; quality high which around 3.5 MB after 10 minutes

## ◆ AgoraNetworkQuality

enum AgoraNetworkQuality

Network quality

Enumerator
AgoraNetworkQualityUnknown | The network quality is unknown.
AgoraNetworkQualityExcellent | The network quality is excellent.
AgoraNetworkQualityGood | The network quality is quite good, but the bitrate may be slightly lower than excellent.
AgoraNetworkQualityPoor | Users can feel the communication slightly impaired.
AgoraNetworkQualityBad | Users can communicate only not very smoothly.
AgoraNetworkQualityVBad | The network is so bad that users can hardly communicate.
AgoraNetworkQualityDown | The network is down and users cannot communicate at all.
AgoraNetworkQualityUnsupported | Users cannot detect the network quality. (Not in use.)
AgoraNetworkQualityDetecting | Detecting the network quality.

## ◆ AgoraExperienceQuality

enum AgoraExperienceQuality

Quality of experience (QoE) of the local user when receiving a remote audio stream.

Enumerator
AgoraExperienceQualityGood | QoE of the local user is good.
AgoraExperienceQualityBad | QoE of the local user is poor.

## ◆ AgoraExperiencePoorReason

enum AgoraExperiencePoorReason

The reason for poor QoE of the local user when receiving a remote audio stream.

Enumerator
AgoraExperiencePoorReasonNone | 0: No reason, indicating good QoE of the local user.
AgoraExperiencePoorReasonRemoteNetworkQualityPoor | 1: The remote user's network quality is poor.
AgoraExperiencePoorReasonLocalNetworkQualityPoor | 2: The local user's network quality is poor.
AgoraExperiencePoorReasonWirelessSignalPoor | 4: The local user's Wi-Fi or mobile network signal is weak.
AgoraExperiencePoorReasonWifiBluetoothCoexist | 8: The local user enables both Wi-Fi and bluetooth, and their signals interfere with each other. As a result, audio transmission quality is undermined.

## ◆ AgoraLastmileProbeResultState

enum AgoraLastmileProbeResultState

The state of the probe test.

Enumerator
AgoraLastmileProbeResultComplete | 1: The last-mile network probe test is complete.
AgoraLastmileProbeResultIncompleteNoBwe | 2: The last-mile network probe test is incomplete and the bandwidth estimation is not available, probably due to limited test resources.
AgoraLastmileProbeResultUnavailable | 3: The last-mile network probe test is not carried out, probably due to poor network conditions.

## ◆ AgoraUploadErrorReason

enum AgoraUploadErrorReason

Enumerator
AgoraUploadErrorReasonSuccess |
AgoraUploadErrorReasonNetError |
AgoraUploadErrorReasonServerError |

## ◆ AgoraVideoStreamType

enum AgoraVideoStreamType

Video stream type

Enumerator
AgoraVideoStreamTypeHigh | High-video stream
AgoraVideoStreamTypeLow | Low-video stream

## ◆ AgoraVideoQualityAdaptIndication

enum AgoraVideoQualityAdaptIndication

Quality change of the local video in terms of target frame rate and target bit rate since last count.

Enumerator
AgoraVideoQualityAdaptNone | The quality of the local video stays the same.
AgoraVideoQualityAdaptUpBandwidth | The quality improves because the network bandwidth increases.
AgoraVideoQualityAdaptDownBandwidth | The quality worsens because the network bandwidth decreases.

## ◆ AgoraVideoRenderMode

enum AgoraVideoRenderMode

Video display mode

Enumerator
AgoraVideoRenderModeHidden | Hidden(1): Uniformly scale the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents.
AgoraVideoRenderModeFit | Fit(2): Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to the disparity in the aspect ratio will be filled with black.
AgoraVideoRenderModeAdaptive | Deprecated: Adaptive(3)：This mode is obsolete.

## ◆ AgoraVideoRotation

enum AgoraVideoRotation

Video rotation

Enumerator
AgoraVideoRotation_0 | 0: Rotate the video by 0 degree clockwise.
AgoraVideoRotation_90 | 90: Rotate the video by 90 degrees clockwise.
AgoraVideoRotation_180 | 180: Rotate the video by 180 degrees clockwise.
AgoraVideoRotation_270 | 270: Rotate the video by 270 degrees clockwise.
AgoraVideoRotationNone | No rotation
AgoraVideoRotation90 | 90 degrees
AgoraVideoRotation180 | 180 degrees
AgoraVideoRotation270 | 270 degrees

## ◆ AgoraVideoLocalState

enum AgoraVideoLocalState

States of the local video.

Enumerator
AgoraVideoLocalStateStopped | 0: The local video is in the initial state.
AgoraVideoLocalStateCapturing | 1: The capturer starts successfully.
AgoraVideoLocalStateEncoding | 2: The first video frame is encoded successfully.
AgoraVideoLocalStateFailed | 3: The local video fails to start.

## ◆ AgoraLocalVideoStreamError

enum AgoraLocalVideoStreamError

States of the local video.

Enumerator
AgoraLocalVideoStreamErrorOK | 0: The local video is normal.
AgoraLocalVideoStreamErrorFailure | 1: No specified reason for the local video failure.
AgoraLocalVideoStreamErrorDeviceNoPermission | 2: The application does not have permission to start the local video capture device. Remind your user to grant permission and rejoin the channel.
AgoraLocalVideoStreamErrorDeviceBusy | 3: The local video capture device is in use. Check whether the camera is occupied by another application or try to rejoin the channel.
AgoraLocalVideoStreamErrorCaptureFailure | 4: The local video capture failed. Check whether the video capture device is working properly, check whether the camera is occupied by another application, or try to rejoin the channel.
AgoraLocalVideoStreamErrorEncodeFailure | 5: The local video encoding fails.
AgoraLocalVideoStreamErrorCaptureInBackGround | 6: (iOS only) The application is in the background. Remind your user that the application cannot capture video properly when the application is in the background.
AgoraLocalVideoStreamErrorCaptureMultipleForegroundApps | 7: (iOS only) The application is running in Slide Over, Split View, or Picture in Picture mode. Remind your user that the application cannot capture video properly when the application is running in Slide Over, Split View, or Picture in Picture mode.
AgoraLocalVideoStreamErrorCaptureNoDeviceFound | 8: The SDK cannot find the local video capture device. Check whether the camera is connected to the device properly, check whether the camera is working properly, or try to rejoin the channel.
AgoraLocalVideoStreamErrorCaptureDeviceDisconnected | 9: (macOS only) The external camera currently in use is disconnected (such as being unplugged).
AgoraLocalVideoStreamErrorCaptureDeviceInvalidId | 10: The SDK cannot find the local video device id in device list, device id is invalid.
AgoraLocalVideoStreamErrorScreenCaptureWindowMinimized | 11: (macOS only) The shared window is minimized when you call [startScreenCaptureByWindowId]([AgoraRtcEngineKit startScreenCaptureByWindowId:rectangle:parameters:]) to share a window. Remind your user that the window cannot be shared properly when the shared window is minimized.
AgoraLocalVideoStreamErrorScreenCaptureWindowClosed | 12: (macOS only) The error code indicates that a window shared by the window ID has been closed, or a full-screen window shared by the window ID has exited full-screen mode. After exiting full-screen mode, remote users cannot see the shared window. To prevent remote users from seeing a black screen, Agora recommends that you immediately stop screen sharing. Common scenarios for reporting this error code: When the local user closes the shared window, the SDK reports this error code.t The local user shows some slides in full-screen mode first, and then shares the windows of the slides. After the user exits full-screen mode, the SDK reports this error code. The local user watches web video or reads web document in full-screen mode first, and then shares the window of the web video or document. After the user exits full-screen mode, the SDK reports this error code.
AgoraLocalVideoStreamErrorScreenCaptureNoPermission | 22: No permision to capture screen.
AgoraLocalVideoStreamErrorScreenCaptureDisplayDisconnected | 30: The shared display has been disconnected

## ◆ AgoraVideoRemoteReason

enum AgoraVideoRemoteReason

The reason of the remote video state change.

Enumerator
AgoraVideoRemoteReasonInternal | 0: Internal reasons.
AgoraVideoRemoteReasonCongestion | 1: Network congestion.
AgoraVideoRemoteReasonRecovery | 2: Network recovery.
AgoraVideoRemoteReasonLocalMuted | 3: The local user stops receiving the remote video stream or disables the video module.
AgoraVideoRemoteReasonLocalUnmuted | 4: The local user resumes receiving the remote video stream or enables the video module.
AgoraVideoRemoteReasonRemoteMuted | 5: The remote user stops sending the video stream or disables the video module.
AgoraVideoRemoteReasonRemoteUnmuted | 6: The remote user resumes sending the video stream or enables the video module.
AgoraVideoRemoteReasonRemoteOffline | 7: The remote user leaves the channel.
AgoraVideoRemoteReasonAudioFallback | 8: The remote media stream falls back to the audio-only stream due to poor network conditions.
AgoraVideoRemoteReasonAudioFallbackRecovery | 9: The remote media stream switches back to the video stream after the network conditions improve.
AgoraVideoRemoteReasonSDKInBackground | 12: (iOS only) The app of the remote user is in background.
AgoraVideoRemoteReasonCodecNotSupport | 13: The remote video stream is not supported by the decoder.

## ◆ AgoraAudioLocalState

enum AgoraAudioLocalState

The state of the local audio.

Enumerator
AgoraAudioLocalStateStopped | 0: The local audio is in the initial state.
AgoraAudioLocalStateRecording | 1: The recording device starts successfully.
AgoraAudioLocalStateEncoding | 2: The first audio frame encodes successfully.
AgoraAudioLocalStateFailed | 3: The local audio fails to start.

## ◆ AgoraAudioLocalError

enum AgoraAudioLocalError

The error information of the local audio.

Enumerator
AgoraAudioLocalErrorOK | 0: No error.
AgoraAudioLocalErrorFailure | 1: No specified reason for the local audio failure.
AgoraAudioLocalErrorDeviceNoPermission | 2: No permission to use the local audio device.
AgoraAudioLocalErrorDeviceBusy | 3: The microphone is in use.
AgoraAudioLocalErrorRecordFailure | 4: The local audio recording fails. Check whether the recording device is working properly.
AgoraAudioLocalErrorEncodeFailure | 5: The local audio encoding fails.
AgoraAudioLocalErrorNoRecordingDevice | 6: (macOS only) The SDK cannot find the local audio recording device.
AgoraAudioLocalErrorNoPlayoutDevice | 7: (macOS only) The SDK cannot find the local audio playback device.
AgoraAudioLocalErrorInterrupted | 8: (iOS only) The local audio is interrupted by system calls, Siri, alarm clock, etc.

## ◆ AgoraAudioCodecProfileType

enum AgoraAudioCodecProfileType

Audio codec profile.

Enumerator
AgoraAudioCodecProfileLCAAC | (Default) LC-AAC, the low-complexity audio codec profile.
AgoraAudioCodecProfileHEAAC | HE-AAC, the high-efficiency audio codec profile.
AgoraAudioCodecProfileHEAACv2 | HE-AACv2, which is the high-efficiency audio codec type.

## ◆ AgoraLicenseVerifyCode

enum AgoraLicenseVerifyCode

Enumerator
AgoraLicenseVerifyInvalid | 1: Invalid license
AgoraLicenseVerifyExpire | 2: License expired
AgoraLicenseVerifyMinutesExceed | 3: Exceed license minutes limit
AgoraLicenseVerifyLimitedPeriod | 4: License use in limited period
AgoraLicenseVerifyDiffDevices | 5: Same license used in different devices at the same time
AgoraLicenseVerifyInternal | 99: SDK internal error

## ◆ AgoraAudioRemoteState

enum AgoraAudioRemoteState

The state of the remote audio.

Enumerator
AgoraAudioRemoteStateStopped | 0: The remote audio stops (the default state). The following are possible reasons: AgoraAudioRemoteReasonLocalMuted(3) AgoraAudioRemoteReasonRemoteMuted(5) AgoraAudioRemoteReasonRemoteOffline(7)
AgoraAudioRemoteStateStarting | 1: The first remote audio packet is received.
AgoraAudioRemoteStateDecoding | 2: The remote audio stream is decoded and plays normally. The following are possible reasons: AgoraAudioRemoteReasonNetworkRecovery(2) AgoraAudioRemoteReasonLocalUnmuted(4) AgoraAudioRemoteReasonRemoteUnmuted(6)
AgoraAudioRemoteStateFrozen | 3: The remote audio is frozen. The possible reason is AgoraAudioRemoteReasonNetworkCongestion(1).
AgoraAudioRemoteStateFailed | 4: The remote audio fails to start. The possible reason is AgoraAudioRemoteReasonInternal(0).

## ◆ AgoraAudioRemoteReason

enum AgoraAudioRemoteReason

The reason of the remote audio state change.

Enumerator
AgoraAudioRemoteReasonInternal | 0: Internal reasons.
AgoraAudioRemoteReasonNetworkCongestion | 1: Network congestion.
AgoraAudioRemoteReasonNetworkRecovery | 2: Network recovery.
AgoraAudioRemoteReasonLocalMuted | 3: The local user stops receiving the remote audio stream or disables the audio module.
AgoraAudioRemoteReasonLocalUnmuted | 4: The local user resumes receiving the remote audio stream or enables the audio module.
AgoraAudioRemoteReasonRemoteMuted | 5: The remote user stops sending the audio stream or disables the audio module.
AgoraAudioRemoteReasonRemoteUnmuted | 6: The remote user resumes sending the audio stream or enables the audio module.
AgoraAudioRemoteReasonRemoteOffline | 7: The remote user leaves the channel.

## ◆ AgoraAudioProfile

enum AgoraAudioProfile

Audio profile types.

Enumerator
AgoraAudioProfileDefault | 0: The default audio profile. In the Communication profile, it represents a sample rate of 16 kHz, music encoding, mono, and a bitrate of up to 16 Kbps. In the Live-broadcast profile, it represents a sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 64 Kbps.
AgoraAudioProfileSpeechStandard | 1: A sample rate of 32 kHz, audio encoding, mono, and a bitrate up to 18 Kbps.
AgoraAudioProfileMusicStandard | 2: A sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 64 Kbps.
AgoraAudioProfileMusicStandardStereo | 3: A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 80 Kbps.
AgoraAudioProfileMusicHighQuality | 4: A sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 96 Kbps.
AgoraAudioProfileMusicHighQualityStereo | 5: A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 128 Kbps.
AgoraAudioProfileIot | 6: A sample rate of 16 kHz, audio encoding, mono, and a bitrate of up to 64 Kbps.

## ◆ AgoraAudioScenario

enum AgoraAudioScenario

Audio application scenarios.

Enumerator
AgoraAudioScenarioDefault | 0: (Recommended) The default audio scenario.
AgoraAudioScenarioGameStreaming | 3: (Recommended) The live gaming scenario, which needs to enable gaming audio effects in the speaker. Choose this scenario to achieve high-fidelity music playback.
AgoraAudioScenarioChatRoom | 5: The chatroom scenario.
AgoraAudioScenarioChorus | Chorus
AgoraAudioScenarioMeeting | Meeting

## ◆ AgoraAudioRawFrameOperationMode

enum AgoraAudioRawFrameOperationMode

Use mode of the onRecordAudioFrame callback

Enumerator
AgoraAudioRawFrameOperationModeReadOnly | Read-only mode: Users only read the AudioFrame data without modifying anything. For example, when users acquire data with the Agora SDK then push the RTMP streams.
AgoraAudioRawFrameOperationModeReadWrite | Read and write mode: Users read the data from AudioFrame, modify it, and then play it. For example, when users have their own sound-effect processing module and do some voice pre-processing such as a voice change.

## ◆ AgoraVoiceBeautifierPreset

enum AgoraVoiceBeautifierPreset

The options for SDK preset voice beautifier effects.

Enumerator
AgoraVoiceBeautifierPresetOff | Turn off voice beautifier effects and use the original voice.
AgoraVoiceBeautifierPresetChatBeautifierMagnetic | A more magnetic voice. Note Agora recommends using this enumerator to process a male-sounding voice; otherwise, you may experience vocal distortion.
AgoraVoiceBeautifierPresetChatBeautifierFresh | A fresher voice. Note Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may experience vocal distortion.
AgoraVoiceBeautifierPresetChatBeautifierVitality | A more vital voice. Note Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may experience vocal distortion.
AgoraVoiceBeautifierPresetSingingBeautifier | Since v3.3.0 Singing beautifier effect. If you call setVoiceBeautifierPreset (SINGING_BEAUTIFIER), you can beautify a male-sounding voice and add a reverberation effect that sounds like singing in a small room. Agora recommends not using setVoiceBeautifierPreset (SINGING_BEAUTIFIER) to process a female-sounding voice; otherwise, you may experience vocal distortion. If you call setVoiceBeautifierParameters(SINGING_BEAUTIFIER, param1, param2), you can beautify a male- or female-sounding voice and add a reverberation effect.
AgoraVoiceBeautifierTimbreTransformationVigorous | A more vigorous voice.
AgoraVoiceBeautifierTimbreTransformationDeep | A deeper voice.
AgoraVoiceBeautifierTimbreTransformationMellow | A mellower voice.
AgoraVoiceBeautifierTimbreTransformationFalsetto | A falsetto voice.
AgoraVoiceBeautifierTimbreTransformationFull | A fuller voice.
AgoraVoiceBeautifierTimbreTransformationClear | A clearer voice.
AgoraVoiceBeautifierTimbreTransformationResounding | A more resounding voice.
AgoraVoiceBeautifierTimbreTransformatRinging | A more ringing voice.
AgoraVoiceBeautifierUltraHighQuality |

## ◆ AgoraVoiceConversionPreset

enum AgoraVoiceConversionPreset

The options for SDK preset voice conversion.

Enumerator
AgoraVoiceConversionPresetOff | Turn off voice conversion and use the original voice.
AgoraVoiceConversionPresetNeutral | A neutral voice.
AgoraVoiceConversionPresetSweet | A sweet voice.
AgoraVoiceConversionPresetChangerSolid | A solid voice.
AgoraVoiceConversionPresetChangerBass | A bass voice.
AgoraVoiceConversionPresetChangerCartoon | A voice like a cartoon character.
AgoraVoiceConversionPresetChangerChildlike | A voice like a child.
AgoraVoiceConversionPresetChangerPhoneOperator | A voice like a phone operator.
AgoraVoiceConversionPresetChangerMonster | A monster voice.
AgoraVoiceConversionPresetChangerTransformers | A voice like Transformers.
AgoraVoiceConversionPresetChangerGroot | A voice like Groot.
AgoraVoiceConversionPresetChangerDarthVader | A voice like Darth Vader.
AgoraVoiceConversionPresetChangerIronLady | A rough female voice.
AgoraVoiceConversionPresetChangerShinchan | A voice like Crayon Shin-chan.
AgoraVoiceConversionPresetChangerGirlishMan | A voice like a castrato.
AgoraVoiceConversionPresetChangerChipmunk | A voice like chipmunk.

## ◆ AgoraHeadphoneEQPreset

enum AgoraHeadphoneEQPreset

Enumerator
AgoraAudioHeadphoneEQPresetOff | Turn off headphone EQ and use the original voice.
AgoraAudioHeadphoneEQPresetOverear | For over-ear headphones.
AgoraAudioHeadphoneEQPresetInear | For in-ear headphones.

## ◆ AgoraVideoFormat

enum AgoraVideoFormat

Video frame format

Enumerator
AgoraVideoFormatI420 | i420 video frame fromat
AgoraVideoFormatBGRA | BGRA video frame fromat
AgoraVideoFormatNV21 | NV21 video frame fromat
AgoraVideoFormatRGBA | RGBA video frame fromat
AgoraVideoFormatNV12 | NV12 video frame fromat
AgoraVideoFormatCVPixelNV12 | iOS texture NV12 (CVPixelBufferRef)
AgoraVideoFormatCVPixelI420 | iOS texture I420 (CVPixelBufferRef)
AgoraVideoFormatCVPixelBGRA | iOS texture BGRA (CVPixelBufferRef)
AgoraVideoFormatI422 | I422 video frame fromat
AgoraVideoFormatDefault | Internal default fromat

## ◆ AgoraVideoFrameType

enum AgoraVideoFrameType

Types of the video frame.

Enumerator
AgoraVideoFrameTypeBlankFrame | (Default) Blank frame
AgoraVideoFrameTypeKeyFrame | (Default) Key frame
AgoraVideoFrameTypeDeltaFrame | (Default) Delta frame
AgoraVideoFrameTypeBFrame | (Default) B frame
AgoraVideoFrameTypeDroppableFrame | (Default) Droppable frame
AgoraVideoFrameTypeUnknow | (Default) Unknown frame type

## ◆ AgoraVideoFrameProcessMode

enum AgoraVideoFrameProcessMode

Enumerator
AgoraVideoFrameProcessModeReadOnly |
AgoraVideoFrameProcessModeReadWrite |

## ◆ AgoraConnectionState

enum AgoraConnectionState

The connection state of the SDK.

Enumerator
AgoraConnectionStateDisconnected | 1: The SDK is disconnected from the edge server.
AgoraConnectionStateConnecting | 2: The SDK is connecting to the edge server.
AgoraConnectionStateConnected | 3: The SDK is connected to the edge server and has joined a channel. You can now publish or subscribe to a media stream in the channel.
AgoraConnectionStateReconnecting | 4: The SDK keeps rejoining the channel after being disconnected from a joined channel because of network issues.
AgoraConnectionStateFailed | 5: The SDK fails to connect to the edge server or join the channel.

## ◆ AgoraNetworkType

enum AgoraNetworkType

The network type.

Enumerator
AgoraNetworkTypeUnknown | -1: The network type is unknown.
AgoraNetworkTypeDisconnected | 0: The network type is disconnected.
AgoraNetworkTypeLAN | 1: The network type is LAN.
AgoraNetworkTypeWIFI | 2: The network type is Wi-Fi.
AgoraNetworkType2G | 3: The network type is mobile 2G.
AgoraNetworkType3G | 4: The network type is mobile 3G.
AgoraNetworkType4G | 5: The network type is mobile 4G.
AgoraNetworkType5G | 6: The network type is mobile 5G.

## ◆ AgoraDegradationPreference

enum AgoraDegradationPreference

The video encoding degradation preference under limited bandwidth.

Enumerator
AgoraDegradationMaintainQuality | (Default) Degrade the frame rate and keep resolution to guarantee the video quality.
AgoraDegradationMaintainFramerate | Degrade resolution in order to maintain framerate.
AgoraDegradationBalanced | Maintain resolution in video quality control process. Under limited bandwidth, degrade video quality first and then degrade frame rate.
AgoraDegradationMaintainResolution | Degrade framerate in order to maintain resolution.

## ◆ AgoraEncodingPreference

enum AgoraEncodingPreference

The video AgoraHardwareEncoding.

Enumerator
AgoraEncodingPreferAuto | Default encoding.
AgoraEncodingPrefersoftware | Software encoding.
AgoraEncodingPreferhardware | Hardware encoding

## ◆ AgoraCompressionPreference

enum AgoraCompressionPreference

The video compression preference.

Enumerator
AgoraCompressionLowLatency | (Default) Prefer low latency, it is default behavior, normally in real-time communication, latency is the first priority.
AgoraCompressionQuality | Prefer quality in sacrifice of a degree of latency, usually around 30ms ~ 150ms, depends target fps

## ◆ AgoraCodecCapMask

enum AgoraCodecCapMask

Supported codec bit mask types.

Enumerator
AgoraCodecMaskNone | No codec support.
AgoraCodecMaskHwDec | bit 1: Hardware decoder support flag
AgoraCodecMaskHwEnc | bit 2: Hardware encoder support flag
AgoraCodecMaskSwDec | bit 3: Software decoder support flag
AgoraCodecMaskSwEnc | bit 4: Software encoder support flag

## ◆ AgoraLighteningContrastLevel

enum AgoraLighteningContrastLevel

The lightening contrast level.

Enumerator
AgoraLighteningContrastLow | Low contrast level.
AgoraLighteningContrastNormal | (Default) Normal contrast level.
AgoraLighteningContrastHigh | High contrast level.

## ◆ AgoraVideoDenoiserMode

enum AgoraVideoDenoiserMode

The video noise reduction mode.

Since
  v4.0.0

Enumerator
AgoraVideoDenoiserModeAuto | 0: (Default) Automatic mode. The SDK automatically enables or disables the video noise reduction feature according to the ambient light.
AgoraVideoDenoiserModeManual | 1: Manual mode. Users need to enable or disable the video noise reduction feature manually.

## ◆ AgoraVideoDenoiserLevel

enum AgoraVideoDenoiserLevel

The video noise reduction level.

Since
  v4.0.0

Enumerator
AgoraVideoDenoiserLevelHighQuality | 0: (Default) Promotes video quality during video noise reduction. `HighQuality` balances performance consumption and video noise reduction quality. The performance consumption is moderate, the video noise reduction speed is moderate, and the overall video quality is optimal.
AgoraVideoDenoiserLevelFast | 1: Promotes reducing performance consumption during video noise reduction. `Fast` prioritizes reducing performance consumption over video noise reduction quality. The performance consumption is lower, and the video noise reduction speed is faster. To avoid a noticeable shadowing effect (shadows trailing behind moving objects) in the processed video, Agora recommends that you use `Fast` when the camera is fixed.
AgoraVideoDenoiserLevelStrength | 2: Enhanced video noise reduction. `Strength` prioritizes video noise reduction quality over reducing performance consumption. The performance consumption is higher, the video noise reduction speed is slower, and the video noise reduction quality is better. If `HighQuality` is not enough for your video noise reduction needs, you can use `Strength`.

## ◆ AgoraLowlightEnhanceMode

enum AgoraLowlightEnhanceMode

The low-light enhancement mode.

Since
  v4.0.0

Enumerator
AgoraLowlightEnhanceModeAuto | 0: (Default) Automatic mode. The SDK automatically enables or disables the low-light enhancement feature according to the ambient light to compensate for the lighting level or prevent overexposure, as necessary.
AgoraLowlightEnhanceModeManual | 1: Manual mode. Users need to enable or disable the low-light enhancement feature manually.

## ◆ AgoraLowlightEnhanceLevel

enum AgoraLowlightEnhanceLevel

The low-light enhancement level.

Since
  v4.0.0

Enumerator
AgoraLowlightEnhanceLevelQuality | 0: (Default) Promotes video quality during low-light enhancement. It processes the brightness, details, and noise of the video image. The performance consumption is moderate, the processing speed is moderate, and the overall video quality is optimal.
AgoraLowlightEnhanceLevelFast | 1: Promotes performance during low-light enhancement. It processes the brightness and details of the video image. The processing speed is faster.

## ◆ AgoraVirtualBackgroundSourceType

enum AgoraVirtualBackgroundSourceType

The type of the custom background image.

Since
  v3.7.200

Enumerator
AgoraVirtualBackgroundNone | 0: Enable segementation with the captured video frame without replacing the background.
AgoraVirtualBackgroundColor | 1: (Default) The background is a solid color.
AgoraVirtualBackgroundImg | 2: The background source is a file in PNG or JPG format.
AgoraVirtualBackgroundBlur | 3: The background source is the blurred original video frame.
AgoraVirtualBackgroundVideo | 4: The background source is a file in MP4, AVI, MKV, FLV format.

## ◆ AgoraBlurDegree

enum AgoraBlurDegree

The lightening contrast level.

Enumerator
AgoraBlurLow | Background few things
AgoraBlurMedium | Background blur more things
AgoraBlurHigh | Background blur most

## ◆ SegModelType

enum SegModelType

Enumerator
SegModelAgoraAi |
SegModelAgoraGreen |

## ◆ AgoraConnectionChangedReason

enum AgoraConnectionChangedReason

Enumerator
AgoraConnectionChangedReasonConnecting | 0: The SDK is connecting to Agora's edge server.
AgoraConnectionChangedReasonJoinSuccess | 1: The SDK has joined the channel successfully.
AgoraConnectionChangedReasonInterrupted | 2: The connection between the SDK and Agora's edge server is interrupted.
AgoraConnectionChangedReasonBannedByServer | 3: The connection between the SDK and Agora's edge server is banned by Agora's edge server.
AgoraConnectionChangedReasonJoinFailed | 4: The SDK fails to join the channel for more than 20 minutes and stops reconnecting to the channel.
AgoraConnectionChangedReasonLeaveChannel | 5: The SDK has left the channel.
AgoraConnectionChangedReasonInvalidAppId | 6: The connection failed since Appid is not valid.
AgoraConnectionChangedReasonInvalidChannelName | 7: The connection failed since channel name is not valid.
AgoraConnectionChangedReasonInvalidToken | 8: The connection failed since token is not valid, possibly because: The App Certificate for the project is enabled in Console, but you do not use Token when joining the channel. If you enable the App Certificate, you must use a token to join the channel. The uid that you specify in the `joinChannel` method is different from the uid that you pass for generating the token.
AgoraConnectionChangedReasonTokenExpired | 9: The connection failed since token is expired.
AgoraConnectionChangedReasonRejectedByServer | 10: The connection is rejected by server.
AgoraConnectionChangedReasonSettingProxyServer | 11: The connection changed to reconnecting since SDK has set a proxy server.
AgoraConnectionChangedReasonRenewToken | 12: When SDK is in connection failed, the renew token operation will make it connecting.
AgoraConnectionChangedReasonClientIpAddressChanged | 13: The IP Address of SDK client has changed. i.e., Network type or IP/Port changed by network operator might change client IP address.
AgoraConnectionChangedReasonKeepAliveTimeout | 14: Timeout for the keep-alive of the connection between the SDK and Agora's edge server. The connection state changes to CONNECTION_STATE_RECONNECTING(4).
AgoraConnectionChangedReasonRejoinSuccess | 15: The SDK has rejoined the channel successfully.
AgoraConnectionChangedReasonLost | 16: The connection between the SDK and Agora's edge server is lost.
AgoraConnectionChangedReasonEchoTest | 17: The change of connection state is caused by echo test.
AgoraConnectionChangedClientIpAddressChangedByUser | 18: The local IP Address is changed by user.
AgoraConnectionChangedSameUidLogin | 19: There is a disconnection due to joining channel on another device with the same uid.
AgoraConnectionChangedTooManyBroadcasters | 20: The connection is failed due to too many broadcasters in the channel.
AgoraConnectionChangedLicenseValidationFailure | 21: The connection is failed due to license validation failure.
AgoraConnectionChangedCertificationVerifyFailure | 22: The connection is failed due to certification verify failure.

## ◆ AgoraClientRoleChangeFailedReason

enum AgoraClientRoleChangeFailedReason

Enumerator
AgoraClientRoleChangeFailedTooManyBroadcasters | 1: Too many broadcasters in the channel.
AgoraClientRoleChangeFailedNotAuthorized | 2: The operation of changing role is not authorized.
AgoraClientRoleChangeFailedRequestTimeout | 3: The operation of changing role is timeout.
AgoraClientRoleChangeFailedConnectionFailed | 4: The operation of changing role is interrupted since we lost connection with agora service.

## ◆ AgoraMetadataType

enum AgoraMetadataType

Enumerator
AgoraMetadataTypeUnknown | -1: The metadata type is unknown.
AgoraMetadataTypeVideo | 0: The metadata type is video.

## ◆ AgoraMaxMetadataSizeType

enum AgoraMaxMetadataSizeType

The maximum metadata size.

Enumerator
AgoraMaxMetadataSizeTypeInvalid |
AgoraMaxMetadataSizeTypeDefault |
AgoraMaxMetadataSizeTypeMax |

## ◆ AgoraLogLevel

enum AgoraLogLevel

Supported logging severities of SDK.

Enumerator
AgoraLogLevelNone | Do not output any log file.
AgoraLogLevelInfo | (Recommended) Output log files of the Info level.
AgoraLogLevelWarn | Output log files of the Warning level.
AgoraLogLevelError | Output log files of the Error level.
AgoraLogLevelFatal | Output log files of the Critical level.

## ◆ AgoraAreaCodeType

enum AgoraAreaCodeType

Areas for geofencing.

Enumerator
AgoraAreaCodeTypeCN | Mainland China.
AgoraAreaCodeTypeNA | North America.
AgoraAreaCodeTypeEUR | Europe.
AgoraAreaCodeTypeAS | Asia, excluding Mainland China.
AgoraAreaCodeTypeJP | Japan.
AgoraAreaCodeTypeIN | India
AgoraAreaCodeTypeRU | Russia
AgoraAreaCodeTypeGlobal | (Default) Global.

## ◆ AgoraRtmpStreamingState

enum AgoraRtmpStreamingState

The RTMP or RTMPS streaming state.

Enumerator
AgoraRtmpStreamingStateIdle | The RTMP or RTMPS streaming has not started or has ended. This state is also triggered after you remove an RTMP or RTMPS stream from the CDN by calling [removePublishStreamUrl]([AgoraRtcEngineKit removePublishStreamUrl:]).
AgoraRtmpStreamingStateConnecting | The SDK is connecting to Agora's streaming server and the CDN server. This state is triggered after you call the [addPublishStreamUrl]([AgoraRtcEngineKit addPublishStreamUrl:transcodingEnabled:]) method.
AgoraRtmpStreamingStateRunning | The RTMP or RTMPS streaming is being published. The SDK successfully publishes the RTMP or RTMPS streaming and returns this state.
AgoraRtmpStreamingStateRecovering | The RTMP or RTMPS streaming is recovering. When exceptions occur to the CDN, or the streaming is interrupted, the SDK attempts to resume RTMP or RTMPS streaming and returns this state. If the SDK successfully resumes the streaming, `AgoraRtmpStreamingStateRunning(2)` returns. If the streaming does not resume within 60 seconds or server errors occur, AgoraRtmpStreamingStateFailure(4) returns. You can also reconnect to the server by calling the [removePublishStreamUrl]([AgoraRtcEngineKit removePublishStreamUrl:]) and [addPublishStreamUrl]([AgoraRtcEngineKit addPublishStreamUrl:transcodingEnabled:]) methods.
AgoraRtmpStreamingStateFailure | The RTMP or RTMPS streaming fails. See the errorCode parameter for the detailed error information. You can also call the [addPublishStreamUrl]([AgoraRtcEngineKit addPublishStreamUrl:transcodingEnabled:]) method to publish the RTMP or RTMPS streaming again.
AgoraRtmpStreamingStateDisconnecting | The SDK is disconnecting to Agora's streaming server and the CDN server. This state is triggered after you call the [removePublishStreamUrl]([AgoraRtcEngineKit removePublishStreamUrl:transcodingEnabled:]) method.

## ◆ AgoraRtmpStreamingErrorCode

enum AgoraRtmpStreamingErrorCode

The detailed error information for streaming.

Enumerator
AgoraRtmpStreamingErrorCodeOK | The RTMP or RTMPS streaming publishes successfully.
AgoraRtmpStreamingErrorCodeInvalidParameters | Invalid argument used. If, for example, you do not call the [setLiveTranscoding]([AgoraRtcEngineKit setLiveTranscoding:]) method to configure the LiveTranscoding parameters before calling the [addPublishStreamUrl]([AgoraRtcEngineKit addPublishStreamUrl:transcodingEnabled:]) method, the SDK returns this error. Check whether you set the parameters in the setLiveTranscoding method properly.
AgoraRtmpStreamingErrorCodeEncryptedStreamNotAllowed | The RTMP or RTMPS streaming is encrypted and cannot be published.
AgoraRtmpStreamingErrorCodeConnectionTimeout | Timeout for the RTMP or RTMPS streaming. Call the [addPublishStreamUrl]([AgoraRtcEngineKit addPublishStreamUrl:transcodingEnabled:]) method to publish the streaming again.
AgoraRtmpStreamingErrorCodeInternalServerError | An error occurs in Agora's streaming server. Call the [addPublishStreamUrl]([AgoraRtcEngineKit addPublishStreamUrl:transcodingEnabled:]) method to publish the streaming again.
AgoraRtmpStreamingErrorCodeRtmpServerError | An error occurs in the CDN server.
AgoraRtmpStreamingErrorCodeTooOften | The RTMP or RTMPS streaming publishes too frequently.
AgoraRtmpStreamingErrorCodeReachLimit | The host publishes more than 10 URLs. Delete the unnecessary URLs before adding new ones.
AgoraRtmpStreamingErrorCodeNotAuthorized | The host manipulates other hosts' URLs. Check your app logic.
AgoraRtmpStreamingErrorCodeStreamNotFound | Agora's server fails to find the RTMP or RTMPS streaming.
AgoraRtmpStreamingErrorCodeFormatNotSupported | The format of the RTMP or RTMPS streaming URL is not supported. Check whether the URL format is correct.
AgoraRtmpStreamingErrorNotBroadcaster | Current role is not broadcaster. Check whether the role of the current channel.
AgoraRtmpStreamingErrorTranscodingNoMixStream | Call updateTranscoding, but no mix stream.
AgoraRtmpStreamingErrorNetDown | Network error.
AgoraRtmpStreamingErrorInvalidAppId | User AppId have not authorized to push stream.
AgoraRtmpStreamingErrorInvalidPrivilege | invalid privilege.
AgoraRtmpStreamingErrorCodeUnpublishOK | The streaming has been stopped normally. After you call [removePublishStreamUrl]([AgoraRtcEngineKit removePublishStreamUrl:]) to stop streaming, the SDK returns this value. Since v3.4.5

## ◆ AgoraRtmpStreamingEvent

enum AgoraRtmpStreamingEvent

Events during the RTMP or RTMPS streaming.

Enumerator
AgoraRtmpStreamingEventFailedLoadImage | 1: An error occurs when you add a background image or a watermark image to the RTMP stream.
AgoraRtmpStreamingEventUrlAlreadyInUse | 2: The streaming URL is already being used for CDN live streaming. If you want to start new streaming, use a new streaming URL. Since v3.4.5
AgoraRtmpStreamingEventAdvancedFeatureNotSupport | advanced feature not support.
AgoraRtmpStreamingEventRequestTooOften | Client request too frequently.

## ◆ AgoraEncryptionErrorType

enum AgoraEncryptionErrorType

Encryption error type.

Enumerator
ENCRYPTION_ERROR_INTERNAL_FAILURE | 0: Internal reason.
ENCRYPTION_ERROR_DECRYPTION_FAILURE | 1: MediaStream decryption errors. Ensure that the receiver and the sender use the same encryption mode and key.
ENCRYPTION_ERROR_ENCRYPTION_FAILURE | 2: MediaStream encryption errors.
ENCRYPTION_ERROR_DATASTREAM_DECRYPTION_FAILURE | 3: DataStream decryption errors. Ensure that the receiver and the sender use the same encryption mode and key.
ENCRYPTION_ERROR_DATASTREAM_ENCRYPTION_FAILURE | 4: DataStream encryption errors.

## ◆ AgoraCameraDirection

enum AgoraCameraDirection

The camera direction

Enumerator
AgoraCameraDirectionRear | 0: Uses the rear camera.
AgoraCameraDirectionFront | 1: Uses the front camera.

## ◆ AgoraCameraStabilizationMode

enum AgoraCameraStabilizationMode

The camera stabilization mode. Higher stabilization level represent more stable picture and smaller fov and higher capture latency

Enumerator
AgoraCameraStabilizationModeOff | -1: disable stabilization mode.
AgoraCameraStabilizationModeAuto | 0: stabilization auto mode. Camera chooses appropriate mode.
AgoraCameraStabilizationModeLevel1 | 1: stabilization mode level 1.
AgoraCameraStabilizationModeLevel2 | 2: stabilization mode level 2.
AgoraCameraStabilizationModeLevel3 | 3: stabilization mode level 3.

## ◆ AgoraChannelMediaRelayState

enum AgoraChannelMediaRelayState

The state code in AgoraChannelMediaRelayState.

Enumerator
AgoraChannelMediaRelayStateIdle | 0: The SDK is initializing.
AgoraChannelMediaRelayStateConnecting | 1: The SDK tries to relay the media stream to the destination channel.
AgoraChannelMediaRelayStateRunning | 2: The SDK successfully relays the media stream to the destination channel.
AgoraChannelMediaRelayStateFailure | 3: A failure occurs. See the details in `error`.

## ◆ AgoraChannelMediaRelayEvent

enum AgoraChannelMediaRelayEvent

The event code in AgoraChannelMediaRelayEvent.

Enumerator
AgoraChannelMediaRelayEventDisconnect | 0: The user disconnects from the server due to poor network connections.
AgoraChannelMediaRelayEventConnected | 1: The network reconnects.
AgoraChannelMediaRelayEventJoinedSourceChannel | 2: The user joins the source channel.
AgoraChannelMediaRelayEventJoinedDestinationChannel | 3: The user joins the destination channel.
AgoraChannelMediaRelayEventSentToDestinationChannel | 4: The SDK starts relaying the media stream to the destination channel.
AgoraChannelMediaRelayEventReceivedVideoPacketFromSource | 5: The server receives the video stream from the source channel.
AgoraChannelMediaRelayEventReceivedAudioPacketFromSource | 6: The server receives the audio stream from the source channel.
AgoraChannelMediaRelayEventUpdateDestinationChannel | 7: The destination channel is updated.
AgoraChannelMediaRelayEventUpdateDestinationChannelRefused | 8: The destination channel update fails due to internal reasons.
AgoraChannelMediaRelayEventUpdateDestinationChannelNotChange | 9: The destination channel does not change, which means that the destination channel fails to be updated.
AgoraChannelMediaRelayEventUpdateDestinationChannelIsNil | 10: The destination channel name is NULL.
AgoraChannelMediaRelayEventVideoProfileUpdate | 11: The video profile is sent to the server.

## ◆ AgoraChannelMediaRelayError

enum AgoraChannelMediaRelayError

The error code in AgoraChannelMediaRelayError.

Enumerator
AgoraChannelMediaRelayErrorNone | 0: The state is normal.
AgoraChannelMediaRelayErrorServerErrorResponse | 1: An error occurs in the server response.
AgoraChannelMediaRelayErrorServerNoResponse | 2: No server response. You can call the [leaveChannel]([AgoraRtcEngineKit leaveChannel:]) method to leave the channel.
AgoraChannelMediaRelayErrorNoResourceAvailable | 3: The SDK fails to access the service, probably due to limited resources of the server.
AgoraChannelMediaRelayErrorFailedJoinSourceChannel | 4: Fails to send the relay request.
AgoraChannelMediaRelayErrorFailedJoinDestinationChannel | 5: Fails to accept the relay request.
AgoraChannelMediaRelayErrorFailedPacketReceivedFromSource | 6: The server fails to receive the media stream.
AgoraChannelMediaRelayErrorFailedPacketSentToDestination | 7: The server fails to send the media stream.
AgoraChannelMediaRelayErrorServerConnectionLost | 8: The SDK disconnects from the server due to poor network connections. You can call the [leaveChannel]([AgoraRtcEngineKit leaveChannel:]) method to leave the channel.
AgoraChannelMediaRelayErrorInternalError | 9: An internal error occurs in the server.
AgoraChannelMediaRelayErrorSourceTokenExpired | 10: The token of the source channel has expired.
AgoraChannelMediaRelayErrorDestinationTokenExpired | 11: The token of the destination channel has expired.

## ◆ AgoraStreamSubscribeState

enum AgoraStreamSubscribeState

Enumerator
AgoraStreamSubscribeStateIdle |
AgoraStreamSubscribeStateNoSubscribed |
AgoraStreamSubscribeStateSubscribing |
AgoraStreamSubscribeStateSubscribed |

## ◆ AgoraStreamPublishState

enum AgoraStreamPublishState

The stream publish state.

Enumerator
AgoraStreamPublishStateIdle |
AgoraStreamPublishStateNoPublished |
AgoraStreamPublishStatePublishing |
AgoraStreamPublishStatePublished |

## ◆ AgoraApplicationScenarioType

enum AgoraApplicationScenarioType

The application scenario scenario.

Since
  v4.2.0

Enumerator
AgoraApplicationGeneralScenario | 0: Default Scenario.
AgoraApplicationMeetingScenario |

## ◆ AgoraScreenScenarioType

enum AgoraScreenScenarioType

The screen sharing scenario.

Since
  v4.0.0

Enumerator
AgoraScreenScenarioDocument | 1: (Default) Document. This scenario prioritizes the video quality of screen sharing and reduces the latency of the shared video for the receiver. If you share documents, slides, and tables, you can set this scenario.
AgoraScreenScenarioGaming | 2: Game. This scenario prioritizes the smoothness of screen sharing. If you share games, you can set this scenario.
AgoraScreenScenarioVideo | 3: Video. This scenario prioritizes the smoothness of screen sharing. If you share movies or live videos, you can set this scenario.
AgoraScreenScenarioRDC | 4: Remote control. This scenario prioritizes the video quality of screen sharing and reduces the latency of the shared video for the receiver. If you share the device desktop being remotely controlled, you can set this scenario.

## ◆ AgoraMediaSourceType

enum AgoraMediaSourceType

Media source types definition.

Enumerator
AgoraMediaSourceTypeAudioPlayout | 0: The audio playback device.
AgoraMediaSourceTypeRecording | 1: Microphone.
AgoraMediaSourceTypePrimaryCamera | 2: Video captured by primary camera.
AgoraMediaSourceTypeSecondaryCamera | 3: Video captured by secondary camera.
AgoraMediaSourceTypePrimaryScreen | 4: Video captured by primary screen capturer.
AgoraMediaSourceTypeSecondaryScreen | 5: Video captured by secondary screen capturer.
AgoraMediaSourceTypeCustomVideo | 6: Video captured by custom video source.
AgoraMediaSourceTypeMediaPlayer | 7: Video for media player sharing.
AgoraMediaSourceTypeRtcImagePng | 8: Video for png image.
AgoraMediaSourceTypeRtcImageJpeg | 9: Video for jpeg image.
AgoraMediaSourceTypeRtcImageGif | 10: Video for gif image.
AgoraMediaSourceTypeRemoteVideo | 11: Remote video received from network.
AgoraMediaSourceTypeTranscodedVideo | 12: Video for transcoded.
AgoraMediaSourceTypeSpeechDriven | 13: Video for voice drive.
AgoraMediaSourceTypeUnknown | 100: unknown media source.

## ◆ AgoraVideoSourceType

enum AgoraVideoSourceType

Video source types definition.

Enumerator
AgoraVideoSourceTypeCamera | Video captured by the camera.
AgoraVideoSourceTypeCameraSecondary | Video captured by the secondary camera.
AgoraVideoSourceTypeScreen | Video for screen sharing.
AgoraVideoSourceTypeScreenSecondary | Video for secondary screen sharing.
AgoraVideoSourceTypeCustom | Video for custom video.
AgoraVideoSourceTypeMediaPlayer | Video for media player sharing.
AgoraVideoSourceTypeImagePNG | Video for png image.
AgoraVideoSourceTypeImageJPEG | Video for JPEG image.
AgoraVideoSourceTypeImageGIF | Video for GIF image.
AgoraVideoSourceTypeRemote | Remote video received from network.
AgoraVideoSourceTypeTransCoded | Video for transcoded.
AgoraVideoSourceTypeCameraThird | Video captured by the third camera.
AgoraVideoSourceTypeCameraFourth | Video captured by the fourth camera.
AgoraVideoSourceTypeScreenThird | Video for third screen sharing.
AgoraVideoSourceTypeScreenFourth | Video for fourth screen sharing.
AgoraVideoSourceTypeSpeechDriven | Video for voice drive.
AgoraVideoSourceTypeUnknown | Not define.

## ◆ AgoraExternalVideoSourceType

enum AgoraExternalVideoSourceType

The external video source type.

Enumerator
AgoraExternalVideoSourceTypeVideoFrame | 0: non-encoded video frame.
AgoraExternalVideoSourceTypeEncodedVideoFrame | 1: encoded video frame.

## ◆ AgoraSimulcastStreamMode

enum AgoraSimulcastStreamMode

The dual stream mode

Enumerator
AgoraAutoSimulcastStream | -1 : disable simulcast stream until receive request for enable simulcast stream by other broadcaster
AgoraDisableSimulcastStream | 0 : disable simulcast stream
AgoraEnableSimulcastStream | 1 : always enable simulcast stream

## ◆ AgoraMediaStreamType

enum AgoraMediaStreamType

AgoraMediaStreamType, reporting the type of the media stream.

Enumerator
AgoraMediaStreamTypeUnknown | `0`: The type is unknown.
AgoraMediaStreamTypeVideo | `1`: The video stream.
AgoraMediaStreamTypeAudio | `2`: The audio stream.
AgoraMediaStreamTypeSubtitle | `3`: The subtitle stream.
AgoraMediaStreamTypeUnknow | `0`: The type is unknown.
AgoraMediaStreamTypeVideo | `1`: The video stream.
AgoraMediaStreamTypeAudio | `2`: The audio stream.
AgoraMediaStreamTypeSubtitle | `3`: The subtitle stream.

## ◆ AgoraMediaPlayerState

enum AgoraMediaPlayerState

Player state.

Enumerator
AgoraMediaPlayerStateIdle | Player idle
AgoraMediaPlayerStateOpening | Opening media file
AgoraMediaPlayerStateOpenCompleted | Media file opened successfully
AgoraMediaPlayerStatePlaying | Player playing
AgoraMediaPlayerStatePaused | Player paused
AgoraMediaPlayerStatePlayBackCompleted | Player playback one loop completed
AgoraMediaPlayerStatePlayBackAllLoopsCompleted | Player playback all loops completed
AgoraMediaPlayerStateStopped | Player stopped
AgoraMediaPlayerStatePausingInternal | Player pausing (internal)
AgoraMediaPlayerStateStoppingInternal | Player stopping (internal)
AgoraMediaPlayerStateSeekingInternal | Player seeking state (internal)
AgoraMediaPlayerStateGettingInternal | Player getting state (internal)
AgoraMediaPlayerStateNoneInternal | None state for state machine (internal)
AgoraMediaPlayerStateDoNothingInternal | Do nothing state for state machine (internal)
AgoraMediaPlayerStateSetTrackInternal | Player set track state (internal)
AgoraMediaPlayerStateFailed | Player failed
AgoraMediaPlayerStateIdle | `0`: Default state.
AgoraMediaPlayerStateOpening | `1`: Opening the media resource.
AgoraMediaPlayerStateOpenCompleted | `2`: Opens the media resource successfully.
AgoraMediaPlayerStatePlaying | `3`: Playing the media resource.
AgoraMediaPlayerStatePaused | `4`: Pauses the playback.
AgoraMediaPlayerStatePlayBackCompleted | `5`: The playback is completed.
AgoraMediaPlayerStatePlayBackAllLoopsCompleted | `6`: The loop playback is completed.
AgoraMediaPlayerStateStopped | `7`: Stops the playback.
AgoraMediaPlayerStatePausingInternal | `8`: Player pausing (internal).
AgoraMediaPlayerStateStoppingInternal | `9`: Player stopping (internal).
AgoraMediaPlayerStateSeekingInternal | `10`: Player seeking state (internal).
AgoraMediaPlayerStateGettingInternal | `11`: Player getting state (internal).
AgoraMediaPlayerStateNoneInternal | `12`: None state for state machine (internal).
AgoraMediaPlayerStateDoNothingInternal | `13`: Do nothing state for state machine (internal).
AgoraMediaPlayerStateFailed | `100`: Fails to play the media resource.

## ◆ AgoraMediaPlayerRenderMode

enum AgoraMediaPlayerRenderMode

The video display mode.

Enumerator
AgoraMediaPlayerRenderModeHidden | 1: Uniformly scale the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents.
AgoraMediaPlayerRenderModeFit | 2: Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to the disparity in the aspect ratio will be filled with black.
AgoraMediaPlayerRenderModeHidden | `1`: Uniformly scale the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents.
AgoraMediaPlayerRenderModeFit | `2`: Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to disparity in the aspect ratio are filled with black.

## ◆ AgoraMediaPlayerError

enum AgoraMediaPlayerError

AgoraMediaPlayerError, reporting the player's error code.

Enumerator
AgoraMediaPlayerErrorNone | `0`: No error.
AgoraMediaPlayerErrorInvalidArguments | `-1`: Invalid arguments.
AgoraMediaPlayerErrorInternal | `-2`: Internal error.
AgoraMediaPlayerErrorNoSource | `-3`: No resource.
AgoraMediaPlayerErrorInvalidMediaSource | `-4`: Invalid media resource.
AgoraMediaPlayerErrorUnknowStreamType | `-5`: The type of the media stream is unknown.
AgoraMediaPlayerErrorObjNotInitialized | `-6`: The object is not initialized.
AgoraMediaPlayerErrorCodecNotSupported | `-7`: The codec is not supported.
AgoraMediaPlayerErrorVideoRenderFailed | `-8`: Invalid renderer.
AgoraMediaPlayerErrorInvalidState | `-9`: Error occurs in the internal state of the player.
AgoraMediaPlayerErrorUrlNotFound | `-10`: The URL of the media resource can not be found.
AgoraMediaPlayerErrorInvalidConnectState | `-11`: Invalid connection between the player and Agora's Server.
AgoraMediaPlayerErrorSrcBufferUnderflow | `-12`: The playback buffer is insufficient.
AgoraMediaPlayerErrorInterrupted | `-13`: The audio mixing file playback is interrupted.
AgoraMediaPlayerErrorNotSupported | `-14`: The SDK does not support this function.
AgoraMediaPlayerErrorTokenExpired | `-15`: The token has expired.
AgoraMediaPlayerErrorIpExpired | `-16`: The ip has expired.
AgoraMediaPlayerErrorUnknown | `-17`: An unknown error occurs.
AgoraMediaPlayerErrorNone | `0`: No error.
AgoraMediaPlayerErrorInvalidArguments | `-1`: Invalid arguments.
AgoraMediaPlayerErrorInternal | `-2`: Internal error.
AgoraMediaPlayerErrorNoSource | `-3`: No resource.
AgoraMediaPlayerErrorInvalidMediaSource | `-4`: Invalid media resource.
AgoraMediaPlayerErrorUnknowStreamType | `-5`: The type of the media stream is unknown.
AgoraMediaPlayerErrorObjNotInitialized | `-6`: The object is not initialized.
AgoraMediaPlayerErrorCodecNotSupported | `-7`: The codec is not supported.
AgoraMediaPlayerErrorVideoRenderFailed | `-8`: Invalid renderer.
AgoraMediaPlayerErrorInvalidState | `-9`: Error occurs in the internal state of the player.
AgoraMediaPlayerErrorUrlNotFound | `-10`: The URL of the media resource can not be found.
AgoraMediaPlayerErrorInvalidConnectState | `-11`: Invalid connection between the player and Agora's Server.
AgoraMediaPlayerErrorSrcBufferUnderflow | `-12`: The playback buffer is insufficient.

## ◆ AgoraMediaPlayerEvent

enum AgoraMediaPlayerEvent

AgoraMediaPlayerEvent, reporting the result of the seek operation to the new playback position.

Enumerator
AgoraMediaPlayerEventSeekBegin | `0`: Begins to seek to the new playback position.
AgoraMediaPlayerEventSeekComplete | `1`: Finish seeking to the new playback position.
AgoraMediaPlayerEventSeekError | `2`: Error occurs when seeking to the new playback position.
AgoraMediaPlayerEventAudioTrackChanged | The player changes the audio track for playback.
AgoraMediaPlayerEventBufferLow | player buffer low.
AgoraMediaPlayerEventBufferRecover | player buffer recover.
AgoraMediaPlayerEventFreezeStart | `8`: The video or audio is interrupted.
AgoraMediaPlayerEventFreezeStop | `9`: Interrupt at the end of the video or audio.
AgoraMediaPlayerEventSwitchBegin | switch source begin.
AgoraMediaPlayerEventSwitchComplete | switch source complete.
AgoraMediaPlayerEventSwitchError | switch source error.
AgoraMediaPlayerEventFirstDisplayed | An application can render the video to less than a second.
AgoraMediaPlayerEventReachCacheFileMaxCount | cache resources exceed the maximum number
AgoraMediaPlayerEventReachCacheFileMaxSize | cache resources exceed the maximum file size
AgoraMediaPlayerEventTryOpenStart | Triggered when a retry is required to open the media
AgoraMediaPlayerEventTryOpenSucceed | Triggered when the retry to open the media is successful
AgoraMediaPlayerEventTryOpenFailed | Triggered when retrying to open media fails
AgoraMediaPlayerEventSeekBegin | `0`: Begins to seek to the new playback position.
AgoraMediaPlayerEventSeekComplete | `1`: Seeks to the new playback position.
AgoraMediaPlayerEventSeekError | `2`: Error occurs when seeking to the new playback position.
AgoraMediaPlayerEventAudioTrackChanged | `5`: The audio track used by the player has been chanaged.
AgoraMediaPlayerEventBufferLow | `6`: The currently buffered data is not enough to support playback.
AgoraMediaPlayerEventBufferRecover | `7`: The currently buffered data is just enough to support playback.

## ◆ AgoraMediaPlayerPreloadEvent

enum AgoraMediaPlayerPreloadEvent

The play preload another source event.

Enumerator
AgoraMediaPlayerPreloadEventBegin | preload source begin.
AgoraMediaPlayerPreloadEventComplete | preload source complete.
AgoraMediaPlayerPreloadEventError | preload source error.

## ◆ AgoraMediaPlayerMetaDataType

enum AgoraMediaPlayerMetaDataType

AgoraMediaPlayerMetaDataType, reporting the type of the media metadata.

Enumerator
AgoraMediaPlayerMetaDataTypeUnknown | `0`: The type is unknown.
AgoraMediaPlayerMetaDataTypeSEI | `1`: The type is SEI.
AgoraMediaPlayerMetaDataTypeUnknown | `0`: The type is unknown.
AgoraMediaPlayerMetaDataTypeSEI | `1`: The type is SEI.

## ◆ AgoraPermissionType

enum AgoraPermissionType

Type of permission.

Enumerator
AgoraPermissionTypeRecordAudio | 0: Permission, Record Audio
AgoraPermissionTypeCamera | 1:Permission, Camera

## ◆ AgoraDirectCdnStreamingState

enum AgoraDirectCdnStreamingState

Streaming state.

Enumerator
AgoraDirectCdnStreamingStateIdle | State idle.
AgoraDirectCdnStreamingStateRunning | Start pushing the stream.
AgoraDirectCdnStreamingStateStopped | Stop push stream.
AgoraDirectCdnStreamingStateFailed | Failed to push the stream.
AgoraDirectCdnStreamingStateRecovering | Retrying to push stream

## ◆ AgoraDirectCdnStreamingError

enum AgoraDirectCdnStreamingError

Enumerator
AgoraDirectCdnStreamingErrorOK |
AgoraDirectCdnStreamingErrorFailed |
AgoraDirectCdnStreamingErrorAudioPublication |
AgoraDirectCdnStreamingErrorVideoPublication |
AgoraDirectCdnStreamingErrorNetConnect |
AgoraDirectCdnStreamingErrorBadName |

## ◆ AgoraEarMonitoringFilterType

enum AgoraEarMonitoringFilterType

Type of ear monitoring.

Enumerator
AgoraEarMonitoringFilterNone | 1: Do not add an audio filter to the in-ear monitor.
AgoraEarMonitoringFilterBuiltInAudioFilters | 2: Add an audio filter to the in-ear monitor.
AgoraEarMonitoringFilterNoiseSuppression | 4: Enable noise suppression to the in-ear monitor.
AgoraEarMonitoringFilterReusePostProcessingFilter | 32768: Enable audio filters by reuse post-processing filter to the in-ear monitor.

## ◆ AgoraAudioFramePosition

enum AgoraAudioFramePosition

The bit mask that controls the audio observation positions.

Enumerator
AgoraAudioFramePositionPlayback | The position for observing the playback audio of all remote users after mixing, which enables the SDK to trigger the [onPlaybackAudioFrame]([AgoraAudioFrameDelegate onPlaybackAudioFrame:]) callback.
AgoraAudioFramePositionRecord | The position for observing the recorded audio of the local user, which enables the SDK to trigger the [onRecordAudioFrame]([AgoraAudioFrameDelegate onRecordAudioFrame:]) callback.
AgoraAudioFramePositionMixed | The position for observing the mixed audio of the local user and all remote users, which enables the SDK to trigger the [onMixedAudioFrame]([AgoraAudioFrameDelegate onMixedAudioFrame:]) callback.
AgoraAudioFramePositionBeforeMixing | The position for observing the audio of a single remote user before mixing, which enables the SDK to trigger the [onPlaybackAudioFrameBeforeMixing]([AgoraAudioFrameDelegate onPlaybackAudioFrameBeforeMixing:uid:]) callback.
AgoraAudioFramePositionEarMonitoring | The position for observing the ear monitoring audio of the local user [onEarMonitoringAudioFrame]([AgoraAudioFrameDelegate onEarMonitoringAudioFrame:]) callback.

## ◆ AgoraVideoContentHint

enum AgoraVideoContentHint

The content hint for screen sharing.

Enumerator
AgoraVideoContentHintNone | 0: (Default) No content hint.
AgoraVideoContentHintMotion | 1: Motion-intensive content. Choose this option if you prefer smoothness or when you are sharing a video clip, movie, or video game.
AgoraVideoContentHintDetails | 2: Motionless content. Choose this option if you prefer sharpness or when you are sharing a picture, PowerPoint slide, or text.

## ◆ AgoraThreadPriorityType

enum AgoraThreadPriorityType

Thread priority type.

Enumerator
AgoraThreadPriorityTypeLowest | 0: Lowest priority.
AgoraThreadPriorityTypeLow | 1: Low priority.
AgoraThreadPriorityTypeNormal | 2: Normal priority.
AgoraThreadPriorityTypeHigh | 3: High priority.
AgoraThreadPriorityTypeHighest | Highest priority.
AgoraThreadPriorityTypeCritical | Critical priority.

## ◆ AgoraContentInspectType

enum AgoraContentInspectType

Enumerator
AgoraContentInspectTypeInvalid | default type is invalid
AgoraContentInspectTypeModeration | Deprecated: content inspect type moderation
AgoraContentInspectTypeSupervise | content inspect type supervise
AgoraContentInspectTypeImageModeration | content inspect type image moderation

## ◆ AgoraContentInspectResult

enum AgoraContentInspectResult

Enumerator
AgoraContentInspectNeutral |
AgoraContentInspectSexy |
AgoraContentInspectPorn |

## ◆ AgoraAudioDualMonoMode

enum AgoraAudioDualMonoMode

The audio dual-mono output mode.

Enumerator
AgoraAudioDualMonoStereo | ChanLOut=ChanLin, ChanRout=ChanRin ChanLOut=ChanRout=ChanLin
AgoraAudioDualMonoL | ChanLOut=ChanRout=ChanRin
AgoraAudioDualMonoR | ChanLout=ChanRout=(ChanLin+ChanRin)/2
AgoraAudioDualMonoMix |

## ◆ AgoraRhythmPlayerState

enum AgoraRhythmPlayerState

The states of the rhythm player.

Enumerator
AgoraRhythmPlayerStateIdle | 810: The rhythm player is idle.
AgoraRhythmPlayerStateOpening | 811: The rhythm player is opening files.
AgoraRhythmPlayerStateDecoding | 812: 812: Files opened successfully, the rhythm player starts decoding files.
AgoraRhythmPlayerStatePlaying | 813: Files decoded successfully, the rhythm player starts mixing the two files and playing back them locally.
AgoraRhythmPlayerStateFailed | 814: The rhythm player is starting to fail, and you need to check the error code for detailed failure reasons.

## ◆ AgoraRhythmPlayerError

enum AgoraRhythmPlayerError

The error codes of the rhythm player.

Enumerator
AgoraRhythmPlayerErrorOK | 0: The rhythm player works well.
AgoraRhythmPlayerErrorFailed | 1: The rhythm player occurs a internal error.
AgoraRhythmPlayerErrorCanNotOpen | 801: The rhythm player can not open the file.
AgoraRhythmPlayerErrorCanNotPlay | 802: The rhythm player can not play the file.
AgoraRhythmPlayerErrorFileOverDurationLimit | 803: The file duration over the limit. The file duration limit is 1.2 seconds.

## ◆ AgoraVideoTranscoderError

enum AgoraVideoTranscoderError

The error codes of the local video transcoder.

Enumerator
AgoraVideoTranscoderErrorOK | No error
AgoraVideoTranscoderErrorVideoSourceNotReady | Occurs when video track not started of video source.
AgoraVideoTranscoderErrorInvalidVideoSourceType | Occurs when source type not on support list.
AgoraVideoTranscoderErrorInvalidImagePath | Occurs when image url is not correctly of image source.
AgoraVideoTranscoderErrorUnsupportImageFormat | Occurs when image format not the type png/jpeg/gif of image source.
AgoraVideoTranscoderErrorInvalidLayout | Occurs when layout is invalid such as width is zero.
AgoraVideoTranscoderErrorInternal | Internal error.

## ◆ AgoraLocalProxyMode

enum AgoraLocalProxyMode

Enumerator
AgoraConnectivityFirst | Connect local proxy with high priority, if not connected to local proxy, fallback to sdrtn.
AgoraLocalOnly | Only connect local proxy.

## ◆ AgoraProxyType

enum AgoraProxyType

The proxy type.

Enumerator
AgoraNoneProxyType | Not connected cloud proxy or local proxy.
AgoraUdpProxyType | The cloud proxy for the UDP protocol.
AgoraTcpProxyType | The cloud proxy for the TCP (encrypted) protocol.
AgoraLocalProxyType | The local proxy
AgoraTcpProxyAutoFallbackType | The cloud proxy, auto fallback.
AgoraHttpProxyType | The http proxy.
AgoraHttpsProxyType | The https proxy.

## ◆ AgoraVideoViewSetupMode

enum AgoraVideoViewSetupMode

mode of setting view.

Enumerator
AgoraVideoViewSetupReplace |
AgoraVideoViewSetupAdd |
AgoraVideoViewSetupRemove |

## ◆ AgoraAudioProcessChannels

enum AgoraAudioProcessChannels

Enumerator
AgoraAudioProcessChannelsMono |
AgoraAudioProcessChannelstereo |

## ◆ AgoraVideoFramePosition

enum AgoraVideoFramePosition

The frame position of the video observer.

Enumerator
AgoraVideoFramePositionPostCapture | 1: The post-capturer position, which corresponds to the video data in the onCaptureVideoFrame callback.
AgoraVideoFramePositionPreRenderer | 2: The pre-renderer position, which corresponds to the video data in the onRenderVideoFrame callback.
AgoraVideoFramePositionPreEncoder | 4: The pre-encoder position, which corresponds to the video data in the onPreEncodeVideoFrame callback.

## ◆ AgoraWlAccReason

enum AgoraWlAccReason

The reason of notifying the user of a message.

Enumerator
AgoraWlAccMessageReasonWeakSignal | WIFI signal is weak.
AgoraWlAccMessageReasonChannelCongestion | Channel congestion.

## ◆ AgoraWlAccAction

enum AgoraWlAccAction

Suggest an action for the user.

Enumerator
AgoraWlAccSuggestActionCloseToWIFI | Please get close to AP.
AgoraWlAccSuggestActionConnectSSID | The user is advised to connect to the prompted SSID.
AgoraWlAccSuggestActionCheck5G | The user is advised to check whether the AP supports 5G band and enable 5G band (the aciton link is attached), or purchases an AP that supports 5G. AP does not support 5G band.
AgoraWlAccSuggestActionModifySSID | The user is advised to change the SSID of the 2.4G or 5G band (the aciton link is attached). The SSID of the 2.4G band AP is the same as that of the 5G band.

## ◆ AgoraMediaRecorderState

enum AgoraMediaRecorderState

The state of agora media recorder.

Enumerator
AgoraMediaRecorderStateError | -1: Media recorder is in wrong state.
AgoraMediaRecorderStateStarted | 2: Media recorder is started.
AgoraMediaRecorderStateStopped | 3: Media recorder is stopped.

## ◆ AgoraMediaRecorderErrorCode

enum AgoraMediaRecorderErrorCode

Recorder error code.

Enumerator
AgoraMediaRecorderErrorCodeNoError | 0: No error occurs.
AgoraMediaRecorderErrorCodeWriteFailed | 1: Store media data into local file failed.
AgoraMediaRecorderErrorCodeNoStream | 2: Occurs when there is no media stream.
AgoraMediaRecorderErrorCodeOverMaxDuration | 3: Occurs when duration of media stream is already over maxmium stream duration.
AgoraMediaRecorderErrorCodeConfigChange | 4: Occurs when recording configuration changes.

## ◆ AgoraMediaRecorderStreamType

enum AgoraMediaRecorderStreamType

Recorder stream type.

Enumerator
AgoraMediaRecorderStreamTypeAudio | 1: Record audio only.
AgoraMediaRecorderStreamTypeVideo | 2: Record video only.
AgoraMediaRecorderStreamTypeBoth | 3: Record both audio and video.

## ◆ AgoraMediaRecorderContainerFormat

enum AgoraMediaRecorderContainerFormat

Recorder container format.

Enumerator
AgoraMediaRecorderContainerFormatMP4 | 1: Format of mp4.

## ◆ AgoraScreenCaptureSourceType

enum AgoraScreenCaptureSourceType

The type of the shared target.

Enumerator
AgoraScreenCaptureSourceTypeUnknown | -1: Unknown type.
AgoraScreenCaptureSourceTypeWindow | 0: The shared target is a window.
AgoraScreenCaptureSourceTypeScreen | 1: The shared target is a screen of a particular monitor.
AgoraScreenCaptureSourceTypeCustom | 2: Reserved parameter.

## ◆ AgoraScreenCaptureFrameRateCapability

enum AgoraScreenCaptureFrameRateCapability

Enumerator
AgoraScreenCaptureFrameRateUnKonw |
AgoraScreenCaptureFrameRate15FPS |
AgoraScreenCaptureFrameRate30FPS |
AgoraScreenCaptureFrameRate60FPS |

## ◆ AgoraAudioTrackType

enum AgoraAudioTrackType

Enumerator
AgoraAudioTrackTypeMixable | 0: Mixable audio track You can push more than one mixable Audio tracks into one RTC connection(channel id + uid), and SDK will mix these tracks into one audio track automatically. However, compare to direct audio track, mixable track might cause extra 30ms+ delay.
AgoraAudioTrackTypeDirect | 1: Direct audio track You can only push one direct (non-mixable) audio track into one RTC connection(channel id + uid). Compare to mixable stream, you can have lower lantency using direct audio track.

## ◆ AUDIO_AINS_MODE

enum AUDIO_AINS_MODE

Audio AINS mode, decide the type of the audio noise suppression.

Enumerator
AINS_MODE_BALANCED | AINS mode with soft suppression level.
AINS_MODE_AGGRESSIVE | AINS mode with high suppression level.
AINS_MODE_ULTRALOWLATENCY | AINS mode with high suppression level and ultra-low-latency

## ◆ AgoraMediaTraceEvent

enum AgoraMediaTraceEvent

The tracing event of media rendering.

Enumerator
AgoraMediaTraceEventVideoRendered | 0: The media frame has been rendered.
AgoraMediaTraceEventVideoDecoded | 1: The media frame has been decoded.

## ◆ AgoraH265TranscodeResult

enum AgoraH265TranscodeResult

Enumerator
AgoraH265TranscodeResultUnknown | -1: Unknown error.
AgoraH265TranscodeResultSuccess | 0: The request of operation is successfully.
AgoraH265TranscodeResultRequestInvalid | This request is invalid. Possible reasons include incorrect parameters.
AgoraH265TranscodeResultUnauthorized | 2: Authentication failed, please check for correctnes of token.
AgoraH265TranscodeResultTokenExpired | 3: The token is expired, please update token.
AgoraH265TranscodeResultForbidden | 4: No permission to access the interface.
AgoraH265TranscodeResultNotFound | 5: The url of request is not found.
AgoraH265TranscodeResultConflict | 6: The request encountered a conflict, please try again.
AgoraH265TranscodeResultNotSupported | 7: Content type not supported.
AgoraH265TranscodeResultTooOften | 8: The requests are too frequent.
AgoraH265TranscodeResultServerInternalError | 9: Internal Server Error, you can try sending the request again.
AgoraH265TranscodeResultServiceUnavailable | 10: Service is unavailable.

## ◆ AgoraFeatureType

enum AgoraFeatureType

Enumerator
AgoraVideoPreprocessVirtualBackground |
AgoraVideoPreprocessBeauty |