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 | AgoraFaceShapeArea { AgoraFaceShapeAreaNone = -1, AgoraFaceShapeAreaHeadScale = 100, AgoraFaceShapeAreaForehead = 101, AgoraFaceShapeAreaFaceContour = 102, AgoraFaceShapeAreaFaceLength = 103, AgoraFaceShapeAreaFaceWidth = 104, AgoraFaceShapeAreaCheekbone = 105, AgoraFaceShapeAreaCheek = 106, AgoraFaceShapeAreaMandible = 107, AgoraFaceShapeAreaChin = 108, AgoraFaceShapeAreaEyeScale = 200, AgoraFaceShapeAreaEyeDistance = 201, AgoraFaceShapeAreaEyePosition = 202, AgoraFaceShapeAreaLowerEyelid = 203, AgoraFaceShapeAreaEyePupils = 204, AgoraFaceShapeAreaEyeInnerCorner = 205, AgoraFaceShapeAreaEyeOuterCorner = 206, AgoraFaceShapeAreaNoseLength = 300, AgoraFaceShapeAreaNoseWidth = 301, AgoraFaceShapeAreaNoseWing = 302, AgoraFaceShapeAreaNoseRoot = 303, AgoraFaceShapeAreaNoseBridge = 304, AgoraFaceShapeAreaNoseTip = 305, AgoraFaceShapeAreaNoseGeneral = 306, AgoraFaceShapeAreaMouthScale = 400, AgoraFaceShapeAreaMouthPosition = 401, AgoraFaceShapeAreaMouthSmile = 402, AgoraFaceShapeAreaMouthLip = 403, AgoraFaceShapeAreaEyebrowPosition = 500, AgoraFaceShapeAreaEyebrowThickness = 501 }
enum | AgoraFaceShapeStyle { AgoraFaceShapeStyleFemale = 0, AgoraFaceShapeStyleMale = 1, AgoraFaceShapeStyleNatural = 2 }
enum | AgoraVideoDenoiserMode { AgoraVideoDenoiserModeAuto = 0, AgoraVideoDenoiserModeManual = 1 }
enum | AgoraVideoDenoiserLevel { AgoraVideoDenoiserLevelHighQuality = 0, AgoraVideoDenoiserLevelFast = 1 }
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 | AgoraMaxMetadataSizeType
enum | AgoraCameraStabilizationMode { AgoraCameraStabilizationModeOff = -1, AgoraCameraStabilizationModeAuto = 0, AgoraCameraStabilizationModeLevel1 = 1, AgoraCameraStabilizationModeLevel2 = 2, AgoraCameraStabilizationModeLevel3 = 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 | AgoraApplicationScenarioType { AgoraApplicationGeneralScenario = 0, AgoraApplicationMeetingScenario = 1, AgoraApplication1V1Scenario = 2, AgoraApplicationLiveShowScenario = 3 }
enum | AgoraQoEPreferenceType { AgoraVideoQOEPreferenceBalance = 1, AgoraVideoQOEPreferenceDelayFirst = 2, AgoraVideoQOEPreferencePictureQualityFirst = 3, AgoraVideoQOEPreferenceFluencyFirst = 4 }
enum | AgoraScreenScenarioType { AgoraScreenScenarioDocument = 1, AgoraScreenScenarioGaming = 2, AgoraScreenScenarioVideo = 3, AgoraScreenScenarioRDC = 4 }
enum | AgoraStreamLayerIndex { AgoraStreamLayer1 = 0, AgoraStreamLayer2 = 1, AgoraStreamLayer3 = 2, AgoraStreamLayer4 = 3, AgoraStreamLayer5 = 4, AgoraStreamLayer6 = 5, AgoraStreamLow = 6, AgoraStreamLayerCountMax = 7 }
enum | AgoraDirectCdnStreamingState { AgoraDirectCdnStreamingStateIdle = 0, AgoraDirectCdnStreamingStateRunning = 1, AgoraDirectCdnStreamingStateStopped = 2, AgoraDirectCdnStreamingStateFailed = 3, AgoraDirectCdnStreamingStateRecovering = 4 }
enum | AgoraDirectCdnStreamingReason { AgoraDirectCdnStreamingReasonOK = 0, AgoraDirectCdnStreamingReasonFailed = 1, AgoraDirectCdnStreamingReasonAudioPublication = 2, AgoraDirectCdnStreamingReasonVideoPublication = 3, AgoraDirectCdnStreamingReasonNetConnect = 4, AgoraDirectCdnStreamingReasonBadName = 5 }
enum | AgoraAudioFramePosition { AgoraAudioFramePositionPlayback = 1 << 0, AgoraAudioFramePositionRecord = 1 << 1, AgoraAudioFramePositionMixed = 1 << 2, AgoraAudioFramePositionBeforeMixing = 1 << 3, AgoraAudioFramePositionEarMonitoring = 1 << 4 }
enum | AgoraThreadPriorityType { AgoraThreadPriorityTypeLowest = 0, AgoraThreadPriorityTypeLow = 1, AgoraThreadPriorityTypeNormal = 2, AgoraThreadPriorityTypeHigh = 3, AgoraThreadPriorityTypeHighest = 4, AgoraThreadPriorityTypeCritical = 5 }
enum | AgoraAudioProcessChannels { AgoraAudioProcessChannelsMono = 1, AgoraAudioProcessChannelstereo = 2 }
enum | WatermarkType { WatermarkTypeImage = 0, WatermarkTypeBuffer = 1 }
enum | WatermarkBufferFormat { WatermarkBufferFormatI420 = 1, WatermarkBufferFormatBGRA = 2, WatermarkBufferFormatNV21 = 3, WatermarkBufferFormatRGBA = 4 }
enum | AgoraRdtStreamType { AgoraRdtStreamCmd = 0, AgoraRdtStreamData = 1, AgoraRdtStreamCount = 2 }
enum | AgoraRdtState { AgoraRdtStateClose = 0, AgoraRdtStateOpened = 1 , AgoraRdtStatePending = 3, AgoraRdtStateBroken = 4 }
enum | AgoraMultipathMode { AgoraMultipathModeDuplicate = 0, AgoraMultipathModeDynamic = 1 }
enum | AgoraMultipathType { AgoraMultipathTypeLAN = 0, AgoraMultipathTypeWIFI = 1, AgoraMultipathTypeMobile = 2, AgoraMultipathTypeUnknown = 99 }
enum | AgoraRenewTokenErrorCode { AgoraRenewTokenSuccess = 0, AgoraRenewTokenFailure = 1, AgoraRenewTokenExpiredToken = 2, AgoraRenewTokenInvalidToken = 3, AgoraRenewTokenInvalidChannelName = 4, AgoraRenewTokenInconsistentAppId = 5, AgoraRenewTokenCanceledByNewRequest = 6 }

## Enumeration Type Documentation

## ◆ AgoraVideoCodecCapabilityLevel

enum AgoraVideoCodecCapabilityLevel

The level of the codec capability.

Enumerator
AgoraVideoCodecCapabilityLevelUnspecified | -1: Unsupported video type. Currently, only H.264 and H.265 formats are supported. If the video is in another format, this value will be returned.
AgoraVideoCodecCapabilityLevelBasicSupport | 5: Supports encoding and decoding videos up to 1080p and 30 fps.
AgoraVideoCodecCapabilityLevel1080p30fps | 10: Supports encoding and decoding videos up to1080p and 30 fps.
AgoraVideoCodecCapabilityLevel1080p60fps | 20: Support encoding and decoding videos up to 1080p and 60 fps.
AgoraVideoCodecCapabilityLevel4k60fps | 30: Support encoding and decoding videos up to 4K and 30 fps.

## ◆ AgoraVideoHwEncoderAccelerating

enum AgoraVideoHwEncoderAccelerating

The local video encoding acceleration type.

Enumerator
AgoraVideoHwEncoderSoftware | 0: Software encoding is applied without acceleration.
AgoraVideoHwEncoderHardware | 1: Hardware encoding is applied for acceleration.

## ◆ AgoraVideoFrameOrientation

enum AgoraVideoFrameOrientation

Enumerator
AgoraVideoFrameOrientation0 |
AgoraVideoFrameOrientation90 |
AgoraVideoFrameOrientation180 |
AgoraVideoFrameOrientation270 |

## ◆ AgoraVideoEncodedFrameDepth

enum AgoraVideoEncodedFrameDepth

Enumerator
AgoraVideoEncodedFrameOfSDR |
AgoraVideoEncodedFrameOfHDR |

## ◆ AgoraVideoCodecTypeForStream

enum AgoraVideoCodecTypeForStream

The codec type of the output video.

Since
  v3.2.0

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

## ◆ AgoraChannelProfile

enum AgoraChannelProfile

The channel profile.

Enumerator
AgoraChannelProfileCommunication | 0: Communication. Use this profile when there are only two users in the channel.
AgoraChannelProfileLiveBroadcasting | 1: Live streaming. Use this profile when there are more than two users in the channel.
AgoraChannelProfileGame | 2: Gaming. Deprecated:
AgoraChannelProfileCloudGaming | Cloud gaming. The scenario is optimized for latency. Use this profile if the use case requires frequent interactions between users. Deprecated:
AgoraChannelProfileCommunication_1v1 | Deprecated: 4：1-to-1 communication.

## ◆ AgoraClientRole

enum AgoraClientRole

The user role in the interactive live streaming.

Enumerator
AgoraClientRoleBroadcaster | 1: Host. A host can both send and receive streams.
AgoraClientRoleAudience | 2: (Default) Audience. An audience member can only receive streams.

## ◆ AgoraAudienceLatencyLevelType

enum AgoraAudienceLatencyLevelType

The latency level of an audience member in interactive live streaming. This enum takes effect only when the user role is set to AgoraClientRoleAudience .

Enumerator
AgoraAudienceLatencyLevelLowLatency | 1: Low latency.
AgoraAudienceLatencyLevelUltraLowLatency | 2: (Default) Ultra low latency.

## ◆ 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 from `captureBrightnessLevel` 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 | 0: The automatic mode. The SDK has this mode enabled by default. In this mode, the SDK attempts a direct connection to SD-RTN™ and automatically switches to TCP/TLS 443 if the attempt fails.
AgoraUdpProxy | 1: The cloud proxy for the UDP protocol, that is, the Force UDP cloud proxy mode. In this mode, the SDK always transmits data over UDP.
AgoraTcpProxy | 2: The cloud proxy for the TCP (encryption) protocol, that is, the Force TCP cloud proxy mode. In this mode, the SDK always transmits data over TCP/TLS 443.

## ◆ AgoraUserOfflineReason

enum AgoraUserOfflineReason

Reasons for a user being offline.

Enumerator
AgoraUserOfflineReasonQuit | 0: The user quits the call.
AgoraUserOfflineReasonDropped | 1: The SDK times out and the user drops offline because no data packet is received within a certain period of time. Note If the user quits the call and the message is not passed to the SDK (due to an unreliable channel), the SDK assumes the user dropped offline.
AgoraUserOfflineReasonBecomeAudience | 2: The user switches the client role from the host to the audience.

## ◆ AgoraLogFilter

enum AgoraLogFilter

The output log level of the SDK.

Enumerator
AgoraLogFilterOff | 0: Do not output any log information.
AgoraLogFilterDebug | 0x080f: Output all log information. Set your log filter to this level if you want to get the most complete log file.
AgoraLogFilterInfo | 0x000f: Output `AgoraLogFilterCritical`, `AgoraLogFilterError`, `AgoraLogFilterWarning`, and `AgoraLogFilterInfo` level log information. We recommend setting your log filter to this level.
AgoraLogFilterWarning | 0x000e: Output `AgoraLogFilterCritical`, `AgoraLogFilterError`, and `AgoraLogFilterWarning` level log information.
AgoraLogFilterError | 0x000c: Output `AgoraLogFilterCritical` and `AgoraLogFilterError` level log information.
AgoraLogFilterCritical | 0x0008: Output `AgoraLogFilterCritical` level log information.

## ◆ AgoraAudioFileRecordingType

enum AgoraAudioFileRecordingType

Recording content. Set in `startAudioRecordingWithConfig:`.

Enumerator
AgoraAudioFileRecordingTypeMic | 1: Only records the audio of the local user.
AgoraAudioFileRecordingTypePlayback | 2: Only records the audio of all remote users.
AgoraAudioFileRecordingTypeMixed | 3: Records the mixed audio of the local and all remote users.

## ◆ AgoraAudioEncodedFrameDelegatePosition

enum AgoraAudioEncodedFrameDelegatePosition

Audio frame observer position.

Enumerator
AgoraAudioEncodedFrameObserverPositionRecord | 1: Only records the audio of the local user.
AgoraAudioEncodedFrameObserverPositionPlayback | 2: Only records the audio of all remote users.
AgoraAudioEncodedFrameObserverPositionMixed | 3: Records the mixed audio of the local and all remote users.

## ◆ AgoraAudioCodecType

enum AgoraAudioCodecType

The codec type of audio.

Enumerator
AgoraAudioCodecTypeOPUS | 1: OPUS.
AgoraAudioCodecTypeAACLC | 8: LC-AAC.
AgoraAudioCodecTypeHEAAC | 9: HE-AAC.
AgoraAudioCodecTypeHEAAC2 | 11: HE-AAC v2.

## ◆ AgoraAudioEncodingType

enum AgoraAudioEncodingType

Audio encoding type.

Enumerator
AgoraAudioEncodingTypeAAC16000Low | 0x010101: AAC encoding format, 16000 Hz sampling rate, bass quality. A file with an audio duration of 10 minutes is approximately 1.2 MB after encoding.
AgoraAudioEncodingTypeAAC16000Medium | 0x010102: AAC encoding format, 16000 Hz sampling rate, medium sound quality. A file with an audio duration of 10 minutes is approximately 2 MB after encoding.
AgoraAudioEncodingTypeAAC32000Low | 0x010201: AAC encoding format, 32000 Hz sampling rate, bass quality. A file with an audio duration of 10 minutes is approximately 1.2 MB after encoding.
AgoraAudioEncodingTypeAAC32000Medium | 0x010202: AAC encoding format, 32000 Hz sampling rate, medium sound quality. A file with an audio duration of 10 minutes is approximately 2 MB after encoding.
AgoraAudioEncodingTypeAAC32000High | 0x010203: AAC encoding format, 32000 Hz sampling rate, high sound quality. A file with an audio duration of 10 minutes is approximately 3.5 MB after encoding.
AgoraAudioEncodingTypeAAC48000Medium | 0x010302: AAC encoding format, 48000 Hz sampling rate, medium sound quality. A file with an audio duration of 10 minutes is approximately 2 MB after encoding.
AgoraAudioEncodingTypeAAC48000High | 0x010303: AAC encoding format, 48000 Hz sampling rate, high sound quality. A file with an audio duration of 10 minutes is approximately 3.5 MB after encoding.
AgoraAudioEncodingTypeOPUS16000Low | 0x020101: OPUS encoding format, 16000 Hz sampling rate, bass quality. A file with an audio duration of 10 minutes is approximately 2 MB after encoding.
AgoraAudioEncodingTypeOPUS6000Medium | 0x020102: OPUS encoding format, 16000 Hz sampling rate, medium sound quality. A file with an audio duration of 10 minutes is approximately 2 MB after encoding.
AgoraAudioEncodingTypeOPUS48000Medium | 0x020302: OPUS encoding format, 48000 Hz sampling rate, medium sound quality. A file with an audio duration of 10 minutes is approximately 2 MB after encoding.
AgoraAudioEncodingTypeOPUS48000High | 0x020303: OPUS encoding format, 48000 Hz sampling rate, high sound quality. A file with an audio duration of 10 minutes is approximately 3.5 MB after encoding.

## ◆ AgoraNetworkQuality

enum AgoraNetworkQuality

Network quality types.

Enumerator
AgoraNetworkQualityUnknown | 0: The network quality is unknown.
AgoraNetworkQualityExcellent | 1: The network quality is excellent.
AgoraNetworkQualityGood | 2: The network quality is quite good, but the bitrate may be slightly lower than excellent.
AgoraNetworkQualityPoor | 3: Users can feel the communication is slightly impaired.
AgoraNetworkQualityBad | 4: Users cannot communicate smoothly.
AgoraNetworkQualityVBad | 5: The quality is so bad that users can barely communicate.
AgoraNetworkQualityDown | 6: The network is down and users cannot communicate at all.
AgoraNetworkQualityUnsupported | Users cannot detect the network quality. (Not in use.)
AgoraNetworkQualityDetecting | 8: The last-mile network probe test is in progress.

## ◆ AgoraExperienceQuality

enum AgoraExperienceQuality

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

Enumerator
AgoraExperienceQualityGood | 0: The QoE of the local user is good.
AgoraExperienceQualityBad | 1: The QoE of the local user is poor.

## ◆ AgoraExperiencePoorReason

enum AgoraExperiencePoorReason

Reasons why the QoE of the local user when receiving a remote audio stream is poor.

Enumerator
AgoraExperiencePoorReasonNone | 0: No reason, indicating a 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 status of the last-mile probe test.

Enumerator
AgoraLastmileProbeResultComplete | 1: The last-mile network probe test is complete.
AgoraLastmileProbeResultIncompleteNoBwe | 2: The last-mile network probe test is incomplete because the bandwidth estimation is not available due to limited test resources. One possible reason is that testing resources are temporarily limited.
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

The type of video streams.

Enumerator
AgoraVideoStreamTypeHigh | 0: High-quality video stream, that is, a video stream with the highest resolution and bitrate.
AgoraVideoStreamTypeLow | 1: Low-quality video stream, that is, a video stream with the lowest resolution and bitrate.
AgoraVideoStreamTypeLayer1 | Video stream layer 1. The resolution of this quality level is only lower than that of AgoraVideoStreamTypeHigh.
AgoraVideoStreamTypeLayer2 | 5: Video stream layer 2. The resolution of this quality level is only lower than that of AgoraVideoStreamTypeLayer1.
AgoraVideoStreamTypeLayer3 | 6: Video stream layer 3. The resolution of this quality level is only lower than that of AgoraVideoStreamTypeLayer2.
AgoraVideoStreamTypeLayer4 | 7: Video stream layer 4. The resolution of this quality level is only lower than that of AgoraVideoStreamTypeLayer3.
AgoraVideoStreamTypeLayer5 | 8: Video stream layer 5. The resolution of this quality level is only lower than that of AgoraVideoStreamTypeLayer4.
AgoraVideoStreamTypeLayer6 | 9: Video stream layer 6. The resolution of this quality level is only lower than that of AgoraVideoStreamTypeLayer5.

## ◆ AgoraVideoQualityAdaptIndication

enum AgoraVideoQualityAdaptIndication

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

Enumerator
AgoraVideoQualityAdaptNone | 0: The local video quality stays the same.
AgoraVideoQualityAdaptUpBandwidth | 1: The local video quality improves because the network bandwidth increases.
AgoraVideoQualityAdaptDownBandwidth | 2: The local video quality deteriorates because the network bandwidth decreases.

## ◆ AgoraVideoRenderMode

enum AgoraVideoRenderMode

Video display modes.

Enumerator
AgoraVideoRenderModeHidden | 1: Hidden mode. The priority is to fill the window. Any excess video that does not match the window size will be cropped.
AgoraVideoRenderModeFit | 2: Fit mode. The priority is to ensure that all video content is displayed. Any areas of the window that are not filled due to the mismatch between video size and window size will be filled with black.
AgoraVideoRenderModeAdaptive | Deprecated: Adaptive(3)：This mode is obsolete.

## ◆ AgoraVideoLocalState

enum AgoraVideoLocalState

Local video state types.

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

## ◆ AgoraLocalVideoStreamReason

enum AgoraLocalVideoStreamReason

Reasons for local video state changes.

Enumerator
AgoraLocalVideoStreamReasonOK | 0: The local video is normal.
AgoraLocalVideoStreamReasonFailure | 1: No specified reason for the local video failure.
AgoraLocalVideoStreamReasonDeviceNoPermission | 2: No permission to use the local video capturing device. Prompt the user to grant permissions and rejoin the channel.
AgoraLocalVideoStreamReasonDeviceBusy | 3: The local video capturing device is in use. Prompt the user to check if the camera is being used by another app, or try to rejoin the channel.
AgoraLocalVideoStreamReasonCaptureFailure | 4: The local video capture fails. Prompt the user to check whether the video capture device is working properly, whether the camera is used by another app, or try to rejoin the channel.
AgoraLocalVideoStreamReasonCodecNotSupport | 5: The local video encoding fails.
AgoraLocalVideoStreamReasonCaptureInBackGround | 6: (iOS only) The app is in the background. Prompt the user that video capture cannot be performed normally when the app is in the background.
AgoraLocalVideoStreamReasonCaptureMultipleForegroundApps | 7: (iOS only) The current app window is running in Slide Over, Split View, or Picture in Picture mode, and another app is occupying the camera. Prompt the user that the app cannot capture video properly when it is running in Slide Over, Split View, or Picture in Picture mode and another app is occupying the camera.
AgoraLocalVideoStreamReasonCaptureNoDeviceFound | 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.
AgoraLocalVideoStreamReasonCaptureDeviceDisconnected | 9: (macOS only) The video capture device currently in use is disconnected (such as being unplugged).
AgoraLocalVideoStreamReasonCaptureDeviceInvalidId | 10: (macOS only) The SDK cannot find the video device in the video device list. Check whether the ID of the video device is valid.
AgoraLocalVideoStreamReasonScreenCaptureWindowMinimized | 11: (macOS only) The shared window is minimized when you call the `startScreenCaptureByWindowId:regionRect:captureParams:` method to share a window. The SDK cannot share a minimized window. Please prompt the user to unminimize the shared window.
AgoraLocalVideoStreamReasonScreenCaptureWindowClosed | 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 reporting this error code: The local user closes the shared window. 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 a web video or reads a 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.
AgoraLocalVideoStreamReasonScreenCaptureNoPermission | 22: No permision to capture screen.
AgoraLocalVideoStreamReasonScreenCaptureRecoverFromMinimized | 27: (macOS only) The window for screen capture has been restored from the minimized state.
AgoraLocalVideoStreamReasonScreenCaptureDisplayDisconnected | 30: (macOS only) The displayer used for screen capture is disconnected. The current screen sharing has been paused. Prompt the user to restart the screen sharing.

## ◆ AgoraVideoRemoteReason

enum AgoraVideoRemoteReason

The reason for the remote video state change.

Enumerator
AgoraVideoRemoteReasonInternal | 0: The SDK reports this reason when the video state changes.
AgoraVideoRemoteReasonCongestion | 1: Network congestion.
AgoraVideoRemoteReasonRecovery | 2: Network is recovered.
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 audio-and-video stream falls back to the audio-only stream due to poor network conditions.
AgoraVideoRemoteReasonAudioFallbackRecovery | 9: The remote audio-only stream switches back to the audio-and-video stream after the network conditions improve.
AgoraVideoRemoteReasonSDKInBackground | 12: (iOS only) The remote user's app has switched to the background.
AgoraVideoRemoteReasonCodecNotSupport | 13: The local video decoder does not support decoding the remote video stream.

## ◆ AgoraAudioLocalState

enum AgoraAudioLocalState

The state of the local audio.

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

## ◆ AgoraAudioLocalReason

enum AgoraAudioLocalReason

Reasons for local audio state changes.

Enumerator
AgoraAudioLocalReasonOK | 0: The local audio is normal.
AgoraAudioLocalReasonFailure | 1: No specified reason for the local audio failure. Remind your users to try to rejoin the channel.
AgoraAudioLocalReasonDeviceNoPermission | 2: No permission to use the local audio capturing device. Remind your users to grant permission.
AgoraAudioLocalReasonDeviceBusy | 3: (iOS only) The local audio capture device is already in use. Remind your users to check whether another application occupies the microphone. Local audio capture automatically resumes after the microphone is idle for about five seconds. You can also try to rejoin the channel after the microphone is idle.
AgoraAudioLocalReasonRecordFailure | 4: The local audio capture fails.
AgoraAudioLocalReasonEncodeFailure | 5: The local audio encoding fails.
AgoraAudioLocalReasonNoRecordingDevice | 6: (macOS only) No local audio capture device. Remind your users to check whether the microphone is connected to the device properly in the control panel of the device or if the microphone is working properly.
AgoraAudioLocalReasonNoPlayoutDevice | 7: (macOS only) No local audio capture device. Remind your users to check whether the speaker is connected to the device properly in the control panel of the device or if the speaker is working properly.
AgoraAudioLocalReasonInterrupted | 8: (iOS only) The local audio capture is interrupted by a system call, smart assistants, or alarm clock. Prompt your users to end the phone call, smart assistants, or alarm clock if the local audio capture is required.

## ◆ AgoraAudioCodecProfileType

enum AgoraAudioCodecProfileType

Self-defined audio codec profile.

Enumerator
AgoraAudioCodecProfileLCAAC | 0: (Default) LC-AAC.
AgoraAudioCodecProfileHEAAC | 1: HE-AAC.
AgoraAudioCodecProfileHEAACv2 | 2: HE-AAC v2.

## ◆ 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

Remote audio states.

Enumerator
AgoraAudioRemoteStateStopped | 0: The local audio is in the initial state. The SDK reports this state in the case of `AgoraAudioRemoteReasonLocalMuted`, `AgoraAudioRemoteReasonRemoteMuted` or `AgoraAudioRemoteReasonRemoteOffline`.
AgoraAudioRemoteStateStarting | 1: The first remote audio packet is received.
AgoraAudioRemoteStateDecoding | 2: The remote audio stream is decoded and plays normally. The SDK reports this state in the case of `AgoraAudioRemoteReasonNetworkRecovery`, `AgoraAudioRemoteReasonLocalUnmuted` or `AgoraAudioRemoteReasonRemoteUnmuted`.
AgoraAudioRemoteStateFrozen | 3: The remote audio is frozen. The SDK reports this state in the case of `AgoraAudioRemoteReasonNetworkCongestion`.
AgoraAudioRemoteStateFailed | 4: The remote audio fails to start. The SDK reports this state in the case of `AgoraAudioRemoteReasonInternal`.

## ◆ AgoraAudioRemoteReason

enum AgoraAudioRemoteReason

The reason for the remote audio state change.

Enumerator
AgoraAudioRemoteReasonInternal | 0: The SDK reports this reason when the audio state changes.
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

The audio profile.

Enumerator
AgoraAudioProfileDefault | 0: The default audio profile. For the interactive streaming profile: A sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 64 Kbps. For the communication profile: A sample rate of 32 kHz, audio encoding, mono, and a bitrate of up to 18 Kbps.
AgoraAudioProfileSpeechStandard | 1: A sample rate of 32 kHz, audio encoding, mono, and a bitrate of 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. On iOS, to implement stereo audio, you also need to call `setAdvancedAudioOptions:` and set `audioProcessingChannels` to `AgoraAudioProcessChannelstereo` in `AgoraAdvancedAudioOptions`.
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. On iOS, to implement stereo audio, you also need to call `setAdvancedAudioOptions:` and set `audioProcessingChannels` to `AgoraAudioProcessChannelstereo` in `AgoraAdvancedAudioOptions`.
AgoraAudioProfileIot | 6: A sample rate of 16 kHz, audio encoding, mono, and Acoustic Echo Cancellation (AEC) enabled.

## ◆ AgoraAudioScenario

enum AgoraAudioScenario

The audio scenarios.

Enumerator
AgoraAudioScenarioDefault | 0: (Default) Automatic scenario match, where the SDK chooses the appropriate audio quality according to the user role and audio route.
AgoraAudioScenarioGameStreaming | 3: High-quality audio scenario, where users mainly play music. For example, instrument tutoring.
AgoraAudioScenarioChatRoom | 5: Chatroom scenario, where users need to frequently switch the user role or mute and unmute the microphone. For example, education scenarios.
AgoraAudioScenarioChorus | 7: Real-time chorus scenario, where users have good network conditions and require ultra-low latency.
AgoraAudioScenarioMeeting | 8: Meeting scenario that mainly contains the human voice.
AgoraAudioScenarioAIServer | AI Server @technical preview
AgoraAudioScenarioAiClient | 10: AI conversation scenario, which is only applicable to scenarios where the user interacts with the conversational AI agent created by `Conversational AI Engine`.

## ◆ AgoraAudioRawFrameOperationMode

enum AgoraAudioRawFrameOperationMode

The use mode of the audio data.

Enumerator
AgoraAudioRawFrameOperationModeReadOnly | 0: Read-only mode, For example, when users acquire the data with the Agora SDK, then start the media push.
AgoraAudioRawFrameOperationModeReadWrite | 2: Read and write mode, For example, when users have their own audio-effect processing module and perform some voice preprocessing, 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 | Singing beautifier effect. If you call `setVoiceBeautifierPreset:` ( AgoraVoiceBeautifierPresetSingingBeautifier ), you can beautify a male-sounding voice and add a reverberation effect that sounds like singing in a small room. Agora recommends using this enumerator to process a male-sounding voice; otherwise, you might experience vocal distortion. If you call `setVoiceBeautifierParameters:param1:param2:` ( AgoraVoiceBeautifierPresetSingingBeautifier, param1, param2), you can beautify a male or female-sounding voice and add a reverberation effect. Since v3.3.0
AgoraVoiceBeautifierTimbreTransformationVigorous | A more vigorous voice.
AgoraVoiceBeautifierTimbreTransformationDeep | A deep voice.
AgoraVoiceBeautifierTimbreTransformationMellow | A mellower voice.
AgoraVoiceBeautifierTimbreTransformationFalsetto | Falsetto.
AgoraVoiceBeautifierTimbreTransformationFull | A fuller voice.
AgoraVoiceBeautifierTimbreTransformationClear | A clearer voice.
AgoraVoiceBeautifierTimbreTransformationResounding | A more resounding voice.
AgoraVoiceBeautifierTimbreTransformatRinging | A more ringing voice.
AgoraVoiceBeautifierUltraHighQuality | A ultra-high quality voice, which makes the audio clearer and restores more details. To achieve better audio effect quality, Agora recommends that you set the `profile` of `setAudioProfile:` to `AgoraAudioProfileMusicHighQuality` (4) or `AgoraAudioProfileMusicHighQualityStereo` (5) and `scenario` to `AgoraAudioScenarioGameStreaming` (3) before calling `setVoiceBeautifierPreset:`. If you have an audio capturing device that can already restore audio details to a high degree, Agora recommends that you do not enable ultra-high quality; otherwise, the SDK may over-restore audio details, and you may not hear the anticipated voice effect.

## ◆ AgoraVoiceConversionPreset

enum AgoraVoiceConversionPreset

The options for SDK preset voice conversion effects.

Enumerator
AgoraVoiceConversionPresetOff | Turn off voice conversion effects and use the original voice.
AgoraVoiceConversionPresetNeutral | A gender-neutral voice. To avoid audio distortion, ensure that you use this enumerator to process a female-sounding voice.
AgoraVoiceConversionPresetSweet | A sweet voice. To avoid audio distortion, ensure that you use this enumerator to process a female-sounding voice.
AgoraVoiceConversionPresetChangerSolid | A steady voice. To avoid audio distortion, ensure that you use this enumerator to process a male-sounding voice.
AgoraVoiceConversionPresetChangerBass | A deep voice. To avoid audio distortion, ensure that you use this enumerator to process a male-sounding 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

Preset headphone equalizer types.

Enumerator
AgoraAudioHeadphoneEQPresetOff | The headphone equalizer is disabled, and the original audio is heard.
AgoraAudioHeadphoneEQPresetOverear | An equalizer is used for headphones.
AgoraAudioHeadphoneEQPresetInear | An equalizer is used for in-ear headphones.

## ◆ AgoraVoiceAITunerType

enum AgoraVoiceAITunerType

Voice AI tuner sound types.

Enumerator
AgoraVoiceAITunerMatureMale | 0: Mature male voice. A deep and magnetic male voice.
AgoraVoiceAITunerFreshMale | 1: Fresh male voice. A fresh and slightly sweet male voice.
AgoraVoiceAITunerElegantFemale | 2: Elegant female voice. A deep and charming female voice.
AgoraVoiceAITunerSweetFemale | 3: Sweet female voice. A high-pitched and cute female voice.
AgoraVoiceAITunerWarmMaleSinging | 4: Warm male singing. A warm and melodious male voice.
AgoraVoiceAITunerGentleFemaleSinging | 5: Gentle female singing. A soft and delicate female voice.
AgoraVoiceAITunerHuskyMaleSinging | 6: Husky male singing. A unique husky male voice.
AgoraVoiceAITunerWarmElegantFemaleSinging | 7: Warm elegant female singing. A warm and mature female voice.
AgoraVoiceAITunerPowerfulMaleSinging | 8: Powerful male singing. A strong and powerful male voice.
AgoraVoiceAITunerDreamyFemaleSinging | 9: Dreamy female singing. A dreamy and soft female voice.

## ◆ AgoraVideoFormat

enum AgoraVideoFormat

The video pixel format.

Enumerator
AgoraVideoFormatI420 | 1: The format is I420.
AgoraVideoFormatBGRA | BGRA video frame fromat
AgoraVideoFormatNV21 | NV21 video frame fromat
AgoraVideoFormatRGBA | 4: The format is RGBA.
AgoraVideoFormatNV12 | NV12 video frame fromat
AgoraVideoFormatCVPixelNV12 | 12: The format is CVPixelBufferRef NV12.
AgoraVideoFormatCVPixelI420 | 13: The format is CVPixelBufferRef I420.
AgoraVideoFormatCVPixelBGRA | 14: The format is CVPixelBufferRef BGRA.
AgoraVideoFormatCVPixelP010 | iOS texture P010 (CVPixelBufferRef)
AgoraVideoFormatI422 | 16: The format is I422.
AgoraVideoFormatI010 | I010 video frame fromat
AgoraVideoFormatDefault | 0: Raw video pixel format.

## ◆ AgoraVideoFrameType

enum AgoraVideoFrameType

The video frame type.

Enumerator
AgoraVideoFrameTypeBlankFrame | 0: A black frame.
AgoraVideoFrameTypeKeyFrame | 3: Key frame.
AgoraVideoFrameTypeDeltaFrame | 4: Delta frame.
AgoraVideoFrameTypeBFrame | 5: The B frame.
AgoraVideoFrameTypeDroppableFrame | 6: A discarded frame.
AgoraVideoFrameTypeUnknow | Unknown frame.

## ◆ AgoraColorPrimaryID

enum AgoraColorPrimaryID

Enumerator
AgoraColorPrimaryIDBT709 |
AgoraColorPrimaryIDUnspecified |
AgoraColorPrimaryIDSMPTE170M |
AgoraColorPrimaryIDBT2020 |
AgoraColorPrimaryIDInvalid |

## ◆ AgoraColorTransferID

enum AgoraColorTransferID

Enumerator
AgoraColorTransferIDBT709 |
AgoraColorTransferIDUnspecified |
AgoraColorTransferIDSMPTE170M |
AgoraColorTransferIDSMPTEST2084 |
AgoraColorTransferIDARIB_STD_B67 |
AgoraColorTransferIDInvalid |

## ◆ AgoraColorMatrixID

enum AgoraColorMatrixID

Enumerator
AgoraColorMatrixIDRGB |
AgoraColorMatrixIDBT709 |
AgoraColorMatrixIDUnspecified |
AgoraColorMatrixIDSMPTE170M |
AgoraColorMatrixIDBT2020_NCL |
AgoraColorMatrixIDInvalid |

## ◆ AgoraColorRangeID

enum AgoraColorRangeID

Enumerator
AgoraColorRangeIDInvalid |
AgoraColorRangeIDLimited |
AgoraColorRangeIDFull |
AgoraColorRangeIDDerived |

## ◆ AgoraVideoFrameProcessMode

enum AgoraVideoFrameProcessMode

The process mode of the video frame:

Enumerator
AgoraVideoFrameProcessModeReadOnly | Read-only mode. In this mode, you do not modify the video frame. The video frame observer is a renderer.
AgoraVideoFrameProcessModeReadWrite | Read and write mode. In this mode, you modify the video frame. The video frame observer is a video filter.

## ◆ AgoraConnectionState

enum AgoraConnectionState

Connection states.

Enumerator
AgoraConnectionStateDisconnected | 1: The SDK is disconnected from the Agora edge server. The state indicates the SDK is in one of the following phases: Theinitial state before calling the `joinChannelByToken:channelId:uid:mediaOptions:joinSuccess:` method. The app calls the `leaveChannel:` method.
AgoraConnectionStateConnecting | 2: The SDK is connecting to the Agora edge server. This state indicates that the SDK is establishing a connection with the specified channel after the app calls `joinChannelByToken:channelId:uid:mediaOptions:joinSuccess:`. If the SDK successfully joins the channel, it triggers the `rtcEngine:connectionChangedToState:reason:` callback and the connection state switches to AgoraConnectionStateConnected. After the connection is established, the SDK also initializes the media and triggers `rtcEngine:didJoinChannel:withUid:elapsed:` when everything is ready.
AgoraConnectionStateConnected | 3: The SDK is connected to the Agora edge server. This state also indicates that the user has joined a channel and can now publish or subscribe to a media stream in the channel. If the connection to the channel is lost because, for example, if the network is down or switched, the SDK automatically tries to reconnect and triggers `rtcEngine:connectionChangedToState:reason:` callback, notifying that the current network state becomes AgoraConnectionStateReconnecting.
AgoraConnectionStateReconnecting | 4: The SDK keeps reconnecting to the Agora edge server. The SDK keeps rejoining the channel after being disconnected from a joined channel because of network issues. If the SDK cannot rejoin the channel within 10 seconds, it triggers `rtcEngineConnectionDidLost:`, stays in the AgoraConnectionStateReconnecting state, and keeps rejoining the channel. If the SDK fails to rejoin the channel 20 minutes after being disconnected from the Agora edge server, the SDK triggers the `rtcEngine:connectionChangedToState:reason:` callback, switches to the AgoraConnectionStateFailed state, and stops rejoining the channel.
AgoraConnectionStateFailed | 5: The SDK fails to connect to the Agora edge server or join the channel. This state indicates that the SDK stops trying to rejoin the channel. You must call `leaveChannel:` to leave the channel. You can call `joinChannelByToken:channelId:uid:mediaOptions:joinSuccess:` to rejoin the channel. If the SDK is banned from joining the channel by the Agora edge server through the RESTful API, the SDK triggers the `rtcEngine:connectionChangedToState:reason:` callback.

## ◆ AgoraNetworkType

enum AgoraNetworkType

Network type.

Enumerator
AgoraNetworkTypeUnknown | -1: The network type is unknown.
AgoraNetworkTypeDisconnected | 0: The SDK disconnects from the network.
AgoraNetworkTypeLAN | 1: The network type is LAN.
AgoraNetworkTypeWIFI | 2: The network type is Wi-Fi (including hotspots).
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

Video degradation preferences when the bandwidth is a constraint.

Enumerator
AgoraDegradationMaintainAuto | -1: (Default) Automatic mode. The SDK will automatically select AgoraDegradationMaintainFramerate, AgoraDegradationBalanced or AgoraDegradationMaintainResolution based on the video scenario you set, in order to achieve the best overall quality of experience (QoE).
AgoraDegradationMaintainQuality | 0: Prefers to reduce the video frame rate while maintaining video resolution during video encoding under limited bandwidth. This degradation preference is suitable for scenarios where video quality is prioritized. Deprecated:
AgoraDegradationMaintainFramerate | 1: Reduces the video resolution while maintaining the video frame rate during video encoding under limited bandwidth. This degradation preference is suitable for scenarios where smoothness is prioritized and video quality is allowed to be reduced.
AgoraDegradationBalanced | 2: Reduces the video frame rate and video resolution simultaneously during video encoding under limited bandwidth. The AgoraDegradationBalanced has a lower reduction than AgoraDegradationMaintainQuality and AgoraDegradationMaintainFramerate, and this preference is suitable for scenarios where both smoothness and video quality are a priority. Note The resolution of the video sent may change, so remote users need to handle this issue. See `rtcEngine:videoSizeChangedOfSourceType:uid:size:rotation:`.
AgoraDegradationMaintainResolution | 3: Reduces the video frame rate while maintaining the video resolution during video encoding under limited bandwidth. This degradation preference is suitable for scenarios where video quality is prioritized.
AgoraDegradationDisable | Disable VQC adjustion.

## ◆ AgoraEncodingPreference

enum AgoraEncodingPreference

Video encoder preference.

Enumerator
AgoraEncodingPreferAuto | -1: Adaptive preference. The SDK automatically selects the optimal encoding type for encoding based on factors such as platform and device type.
AgoraEncodingPrefersoftware | 0: Software coding preference. The SDK prefers software encoders for video encoding.
AgoraEncodingPreferhardware | 1: Hardware encoding preference. The SDK prefers a hardware encoder for video encoding. When the device does not support hardware encoding, the SDK automatically uses software encoding and reports the currently used video encoder type through `hwEncoderAccelerating` in the `rtcEngine:localVideoStats:sourceType:` callback.

## ◆ AgoraCompressionPreference

enum AgoraCompressionPreference

Compression preference for video encoding.

Enumerator
AgoraCompressionAuto | -1: (Default) Automatic mode. The SDK will automatically select AgoraCompressionLowLatency or AgoraCompressionQuality based on the video scenario you set to achieve the best user experience.
AgoraCompressionLowLatency | 0: Low latency preference. The SDK compresses video frames to reduce latency. This preference is suitable for scenarios where smoothness is prioritized and reduced video quality is acceptable.
AgoraCompressionQuality | 1: High quality preference. The SDK compresses video frames while maintaining video quality. This preference is suitable for scenarios where video quality is prioritized.

## ◆ AgoraCodecCapMask

enum AgoraCodecCapMask

The bit mask of the codec type.

Enumerator
AgoraCodecMaskNone | (0): The device does not support encoding or decoding.
AgoraCodecMaskHwDec | (1 << 0): The device supports hardware decoding.
AgoraCodecMaskHwEnc | (1 << 1): The device supports hardware encoding.
AgoraCodecMaskSwDec | (1 << 2): The device supports software decoding.
AgoraCodecMaskSwEnc | (1 << 3): The device supports software ecoding.

## ◆ AgoraLighteningContrastLevel

enum AgoraLighteningContrastLevel

The contrast level.

Enumerator
AgoraLighteningContrastLow | 0: Low contrast level.
AgoraLighteningContrastNormal | 1: (Default) Normal contrast level.
AgoraLighteningContrastHigh | 2: High contrast level.

## ◆ AgoraFaceShapeArea

enum AgoraFaceShapeArea

Chooses the specific facial areas that need to be adjusted.

Since
  v4.4.0

Enumerator
AgoraFaceShapeAreaNone | -1: (Default) Invalid area; facial enhancement effects do not take effect.
AgoraFaceShapeAreaHeadScale | (100): Head, used to achieve a smaller head effect. The value range is 0 to 100, and the default value is 50. The larger the value, the more noticeable the adjustment.
AgoraFaceShapeAreaForehead | (101): Forehead, used to adjust the hairline height. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.
AgoraFaceShapeAreaFaceContour | (102): Face contour, used to achieve a slimmer face effect. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.
AgoraFaceShapeAreaFaceLength | (103): Face length, used to achieve a longer face effect. The range is [-100, 100], with a default value of 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.
AgoraFaceShapeAreaFaceWidth | (104): Face width, used to achieve a narrower face effect. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.
AgoraFaceShapeAreaCheekbone | (105): Cheekbone, used to adjust cheekbone width. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.
AgoraFaceShapeAreaCheek | (106): Cheek, used to adjust cheek width. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.
AgoraFaceShapeAreaMandible | (107): Adjustment of the mandible. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment. Since v4.6.0
AgoraFaceShapeAreaChin | (108): Chin, used to adjust chin length. The range is [-100, 100], with a default value of 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.
AgoraFaceShapeAreaEyeScale | (200): Eyes, used to achieve a larger eye effect. The value range is 0 to 100, and the default value is 50. The larger the value, the more noticeable the adjustment.
AgoraFaceShapeAreaEyeDistance | (201): Eye distance adjustment. The range is [-100, 100], with a default value of 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction. Since v4.6.0
AgoraFaceShapeAreaEyePosition | (202): Eye position adjustment. The range is [-100, 100], with a default value of 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction. Since v4.6.0
AgoraFaceShapeAreaLowerEyelid | (203): Lower eyelid adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment. Since v4.6.0
AgoraFaceShapeAreaEyePupils | (204): Pupil size adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment. Since v4.6.0
AgoraFaceShapeAreaEyeInnerCorner | (205): Inner eye corner adjustment. The range is [-100, 100], with a default value of 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction. Since v4.6.0
AgoraFaceShapeAreaEyeOuterCorner | (206): Outer eye corner adjustment. The range is [-100, 100], with a default value of 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction. Since v4.6.0
AgoraFaceShapeAreaNoseLength | (300): Nose length, used to achieve a longer nose effect. The range is [-100, 100], with a default value of 0.
AgoraFaceShapeAreaNoseWidth | (301): Nose width, used to achieve a slimmer nose effect. The range is [0, 100], with a default value of 0. The larger the value, the more noticiable the effect of narrowing the nose. Since v4.6.0
AgoraFaceShapeAreaNoseWing | (302): Nose wing adjustment. The value range is 0 to 100, and the default value is 10. The larger the value, the more noticeable the adjustment. Since v4.6.0
AgoraFaceShapeAreaNoseRoot | (303): Nose root adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment. Since v4.6.0
AgoraFaceShapeAreaNoseBridge | (304): Nose bridge adjustment. The value range is 0 to 100, and the default value is 50. The larger the value, the more noticeable the adjustment. Since v4.6.0
AgoraFaceShapeAreaNoseTip | (305): Nose tip adjustment. The value range is 0 to 100, and the default value is 50. The larger the value, the more noticeable the adjustment. Since v4.6.0
AgoraFaceShapeAreaNoseGeneral | (306): Overall nose adjustment. The range is [-100, 100], with a default value of 50. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction. Since v4.6.0
AgoraFaceShapeAreaMouthScale | (400): Mouth, used to achieve a larger mouth effect. The range is [-100, 100], with a default value of 20. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction. Since v4.6.0
AgoraFaceShapeAreaMouthPosition | (401): Mouth position adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment. Since v4.6.0
AgoraFaceShapeAreaMouthSmile | (402): Mouth smile adjustment. The value range is [0,1], and the default value is 0. The larger the value, the more noticeable the adjustment. Since v4.6.0
AgoraFaceShapeAreaMouthLip | (403): Lip shape adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment. Since v4.6.0
AgoraFaceShapeAreaEyebrowPosition | (500): Eyebrow position adjustment. The range is [-100, 100], with a default value of 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction. Since v4.6.0
AgoraFaceShapeAreaEyebrowThickness | (501): Eyebrow thickness adjustment. The range is [-100, 100], with a default value of 0. The larger the value, the more noticeable the adjustment. Since v4.6.0

## ◆ AgoraFaceShapeStyle

enum AgoraFaceShapeStyle

The facial enhancement style options.

Since
  v4.4.0

Enumerator
AgoraFaceShapeStyleFemale | 0: (Default) Feminine style.
AgoraFaceShapeStyleMale | 1: Masculine style.
AgoraFaceShapeStyleNatural | 2: The natural style beauty effect. Since v4.6.0

## ◆ AgoraVideoDenoiserMode

enum AgoraVideoDenoiserMode

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

Video noise reduction level.

Since
  v4.0.0

Enumerator
AgoraVideoDenoiserLevelHighQuality | 0: (Default) Promotes video quality during video noise reduction. 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. It 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 this setting when the camera is fixed.

## ◆ 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 custom background.

Since
  v3.7.200

Enumerator
AgoraVirtualBackgroundNone | 0: Process the background as alpha data without replacement, only separating the portrait and the background. After setting this value, you can call `startLocalVideoTranscoder:` to implement the picture-in-picture effect.
AgoraVirtualBackgroundColor | 1: (Default) The background image is a solid color.
AgoraVirtualBackgroundImg | 2: The background is an image in PNG or JPG format.
AgoraVirtualBackgroundBlur | 3: The background is a blurred version of the original background.
AgoraVirtualBackgroundVideo | 4: The background is a local video in MP4, AVI, MKV, FLV, or other supported formats.

## ◆ AgoraBlurDegree

enum AgoraBlurDegree

The degree of blurring applied to the custom background image.

Enumerator
AgoraBlurLow | 1: The degree of blurring applied to the custom background image is low. The user can almost see the background clearly.
AgoraBlurMedium | 2: The degree of blurring applied to the custom background image is medium. It is difficult for the user to recognize details in the background.
AgoraBlurHigh | 3: (Default) The degree of blurring applied to the custom background image is high. The user can barely see any distinguishing features in the background.

## ◆ SegModelType

enum SegModelType

The type of algorithms to user for background processing.

Enumerator
SegModelAgoraAi | 1: (Default) Use the algorithm suitable for all scenarios.
SegModelAgoraGreen | 2: Use the algorithm designed specifically for scenarios with a green screen background.

## ◆ ScreenColorType

enum ScreenColorType

Screen color type.

Enumerator
ScreenColorAuto | (0): Automatically selects the screen color type.
ScreenColorGreen | (1): Uses green as the screen color type.
ScreenColorBlue | (2): Uses blue as the screen color type.

## ◆ AgoraConnectionChangedReason

enum AgoraConnectionChangedReason

Reasons causing the change of the connection state.

Enumerator
AgoraConnectionChangedReasonConnecting | 0: The SDK is connecting to the Agora edge server.
AgoraConnectionChangedReasonJoinSuccess | 1: The SDK has joined the channel successfully.
AgoraConnectionChangedReasonInterrupted | 2: The connection between the SDK and the Agora edge server is interrupted.
AgoraConnectionChangedReasonBannedByServer | 3: The connection between the SDK and the Agora edge server is banned by the Agora edge server. For example, when a user is kicked out of the channel, this status will be returned.
AgoraConnectionChangedReasonJoinFailed | 4: The SDK fails to join the channel. When the SDK fails to join the channel for more than 20 minutes, this code will be returned and the SDK stops reconnecting to the channel. You need to prompt the user to try to switch to another network and rejoin the channel.
AgoraConnectionChangedReasonLeaveChannel | 5: The SDK has left the channel.
AgoraConnectionChangedReasonInvalidAppId | 6: The App ID is invalid. You need to rejoin the channel with a valid APP ID and make sure the App ID you are using is consistent with the one generated in the Agora Console.
AgoraConnectionChangedReasonInvalidChannelName | 7: Invalid channel name. Rejoin the channel with a valid channel name. A valid channel name is a string of up to 64 bytes in length. Supported characters (89 characters in total): All lowercase English letters: a to z. All uppercase English letters: A to Z. All numeric characters: 0 to 9. "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
AgoraConnectionChangedReasonInvalidToken | 8: Invalid token. Possible reasons are as follows: The App Certificate for the project is enabled in Agora Console, but you do not pass in a token when joining a channel. The uid specified when calling `joinChannelByToken:channelId:uid:mediaOptions:joinSuccess:` to join the channel is inconsistent with the uid passed in when generating the token. The generated token and the token used to join the channel are not consistent. Ensure the following: When your project enables App Certificate, you need to pass in a token to join a channel. The user ID specified when generating the token is consistent with the user ID used when joining the channel. The generated token is the same as the token passed in to join the channel.
AgoraConnectionChangedReasonTokenExpired | 9: The token currently being used has expired. You need to generate a new token on your server and rejoin the channel with the new token.
AgoraConnectionChangedReasonRejectedByServer | 10: The connection is rejected by server. Possible reasons are as follows: The user is already in the channel and still calls a method, for example, `joinChannelByToken:channelId:uid:mediaOptions:joinSuccess:`, to join the channel. Stop calling this method to clear this error. The user tries to join a channel while a test call is in progress. The user needs to join the channel after the call test ends.
AgoraConnectionChangedReasonSettingProxyServer | 11: The connection state changed to reconnecting because the SDK has set a proxy server.
AgoraConnectionChangedReasonRenewToken | 12: The connection state changed because the token is renewed.
AgoraConnectionChangedReasonClientIpAddressChanged | 13: Client IP address changed. If you receive this code multiple times, You need to prompt the user to switch networks and try joining the channel again.
AgoraConnectionChangedReasonKeepAliveTimeout | 14: Timeout for the keep-alive of the connection between the SDK and the Agora edge server. The SDK tries to reconnect to the server automatically.
AgoraConnectionChangedReasonRejoinSuccess | 15: The user has rejoined the channel successfully.
AgoraConnectionChangedReasonLost | 16: The connection between the SDK and the server is lost.
AgoraConnectionChangedReasonEchoTest | 17: The connection state changes due to the echo test.
AgoraConnectionChangedClientIpAddressChangedByUser | 18: The local IP address was changed by the user.
AgoraConnectionChangedSameUidLogin | 19: The user joined the same channel from different devices with the same UID.
AgoraConnectionChangedTooManyBroadcasters | 20: The number of hosts in the channel has reached the upper limit.
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

The reason for a user role switch failure.

Enumerator
AgoraClientRoleChangeFailedTooManyBroadcasters | 1: The number of hosts in the channel exceeds the limit. Note This enumerator is reported only when the support for 128 users is enabled. The maximum number of hosts is based on the actual number of hosts configured when you enable the 128-user feature.
AgoraClientRoleChangeFailedNotAuthorized | 2: The request is rejected by the Agora server. Agora recommends you prompt the user to try to switch their user role again.
AgoraClientRoleChangeFailedRequestTimeout | 3: The request is timed out. Agora recommends you prompt the user to check the network connection and try to switch their user role again.
AgoraClientRoleChangeFailedConnectionFailed | 4: The SDK is disconnected from the Agora edge server. You can troubleshoot the failure through the `reason` reported by `rtcEngine:connectionChangedToState:reason:`.

## ◆ AgoraMetadataType

enum AgoraMetadataType

Metadata type of the observer. We only support video metadata for now.

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

## ◆ AgoraMaxMetadataSizeType

enum AgoraMaxMetadataSizeType

The maximum metadata size.

Enumerator
AgoraMaxMetadataSizeTypeInvalid |
AgoraMaxMetadataSizeTypeDefault |
AgoraMaxMetadataSizeTypeMax |

## ◆ AgoraLogLevel

enum AgoraLogLevel

The output log level of the SDK.

Enumerator
AgoraLogLevelNone | 0: Do not output any log information.
AgoraLogLevelInfo | 0x0001: (Default) Output `FATAL`, `ERROR`, `WARN`, and `INFO` level log information. We recommend setting your log filter to this level.
AgoraLogLevelWarn | 0x0002: Output `FATAL`, `ERROR`, and `WARN` level log information.
AgoraLogLevelError | 0x0004: Output `FATAL` and `ERROR` level log information.
AgoraLogLevelFatal | 0x0008: Output `FATAL` level log information.

## ◆ AgoraAreaCodeType

enum AgoraAreaCodeType

The region for connection, which is the region where the server the SDK connects to is located.

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

## ◆ AgoraRtmpStreamingState

enum AgoraRtmpStreamingState

States of the Media Push.

Enumerator
AgoraRtmpStreamingStateIdle | 0: The Media Push has not started or has ended.
AgoraRtmpStreamingStateConnecting | 1: The streaming server and CDN server are being connected.
AgoraRtmpStreamingStateRunning | 2: The RTMP or RTMPS streaming publishes. The SDK successfully publishes the RTMP or RTMPS streaming and returns this state.
AgoraRtmpStreamingStateRecovering | 3: The RTMP or RTMPS streaming is recovering. When exceptions occur to the CDN, or the streaming is interrupted, the SDK tries 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. If you feel that 60 seconds is too long, you can also actively try to reconnect.
AgoraRtmpStreamingStateFailure | 4: The RTMP or RTMPS streaming fails. After a failure, you can troubleshoot the cause of the error through the returned error code.
AgoraRtmpStreamingStateDisconnecting | 5: The SDK is disconnecting from the Agora streaming server and CDN. When you call `stopRtmpStream:` to stop the Media Push normally, the SDK reports the Media Push state as `AgoraRtmpStreamingStateDisconnecting` and `AgoraRtmpStreamingStateIdle` in sequence.

## ◆ AgoraRtmpStreamingReason

enum AgoraRtmpStreamingReason

Reasons for changes in the status of RTMP or RTMPS streaming.

Enumerator
AgoraRtmpStreamingReasonOK | 0: The RTMP or RTMPS streaming has not started or has ended.
AgoraRtmpStreamingReasonInvalidParameters | 1: Invalid argument used. Check the parameter setting.
AgoraRtmpStreamingReasonEncryptedStreamNotAllowed | 2: The RTMP or RTMPS streaming is encrypted and cannot be published.
AgoraRtmpStreamingReasonConnectionTimeout | 3: Timeout for the RTMP or RTMPS streaming.
AgoraRtmpStreamingReasonInternalServerError | 4: An error occurs in Agora's streaming server.
AgoraRtmpStreamingReasonRtmpServerError | 5: An error occurs in the CDN server.
AgoraRtmpStreamingReasonTooOften | 6: The RTMP or RTMPS streaming publishes too frequently.
AgoraRtmpStreamingReasonReachLimit | 7: The host publishes more than 10 URLs. Delete the unnecessary URLs before adding new ones.
AgoraRtmpStreamingReasonNotAuthorized | 8: The host manipulates other hosts' URLs. For example, the host updates or stops other hosts' streams. Check your app logic.
AgoraRtmpStreamingReasonStreamNotFound | 9: Agora's server fails to find the RTMP or RTMPS streaming.
AgoraRtmpStreamingReasonFormatNotSupported | 10: The format of the RTMP or RTMPS streaming URL is not supported. Check whether the URL format is correct.
AgoraRtmpStreamingReasonNotBroadcaster | 11: The user role is not host, so the user cannot use the CDN live streaming function. Check your application code logic.
AgoraRtmpStreamingReasonTranscodingNoMixStream | 13: The `updateRtmpTranscoding:` method is called to update the transcoding configuration in a scenario where there is streaming without transcoding. Check your application code logic.
AgoraRtmpStreamingReasonNetDown | 14: Errors occurred in the host's network.
AgoraRtmpStreamingReasonInvalidAppId | User AppId have not authorized to push stream.
AgoraRtmpStreamingReasonInvalidPrivilege | 16: Your project does not have permission to use streaming services.
AgoraRtmpStreamingReasonUnpublishOK | 100: The streaming has been stopped normally. After you stop the Media Push, the SDK returns this value. Since v3.4.5

## ◆ AgoraRtmpStreamingEvent

enum AgoraRtmpStreamingEvent

Events during the Media Push.

Enumerator
AgoraRtmpStreamingEventFailedLoadImage | 1: An error occurs when you add a background image or a watermark image in the Media Push.
AgoraRtmpStreamingEventUrlAlreadyInUse | 2: The streaming URL is already being used for Media Push. If you want to start new streaming, use a new streaming URL. Since v3.4.5
AgoraRtmpStreamingEventAdvancedFeatureNotSupport | 3: The feature is not supported.
AgoraRtmpStreamingEventRequestTooOften | 4: Reserved.

## ◆ AgoraEncryptionErrorType

enum AgoraEncryptionErrorType

Encryption error type.

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

## ◆ AgoraCameraDirection

enum AgoraCameraDirection

The camera direction.

Enumerator
AgoraCameraDirectionRear | 0: The rear camera.
AgoraCameraDirectionFront | 1: (Default) The front camera.

## ◆ AgoraFocalLength

enum AgoraFocalLength

The camera focal length types.

Enumerator
AgoraFocalLengthDefault | 0: (Default) Standard lens.
AgoraFocalLengthWide | 1: Wide-angle lens.
AgoraFocalLengthUltraWide | 2: Ultra-wide-angle lens.
AgoraFocalLengthTelephoto | 3: Telephoto lens.

## ◆ AgoraCameraStabilizationMode

enum AgoraCameraStabilizationMode

Camera stabilization modes.

The camera stabilization effect increases in the order of 1 < 2 < 3, and the latency will also increase accordingly.

Enumerator
AgoraCameraStabilizationModeOff | -1: (Default) Camera stabilization mode off.
AgoraCameraStabilizationModeAuto | 0: Automatic camera stabilization. The system automatically selects a stabilization mode based on the status of the camera. However, the latency is relatively high in this mode, so it is recommended not to use this enumeration.
AgoraCameraStabilizationModeLevel1 | 1: (Recommended) Level 1 camera stabilization.
AgoraCameraStabilizationModeLevel2 | 2: Level 2 camera stabilization.
AgoraCameraStabilizationModeLevel3 | 3: Level 3 camera stabilization.

## ◆ AgoraChannelMediaRelayState

enum AgoraChannelMediaRelayState

The state code of the channel media relay.

Enumerator
AgoraChannelMediaRelayStateIdle | 0: The initial state. After you successfully stop the channel media relay by calling `stopChannelMediaRelay`, the `rtcEngine:channelMediaRelayStateDidChange:error:` callback returns this state.
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: An error occurs. See `code` in `rtcEngine:channelMediaRelayStateDidChange:error:` for the error code.

## ◆ 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 of the channel media relay.

Enumerator
AgoraChannelMediaRelayErrorNone | 0: No error.
AgoraChannelMediaRelayErrorServerErrorResponse | 1: An error occurs in the server response.
AgoraChannelMediaRelayErrorServerNoResponse | 2: No server response. This error may be caused by poor network connections. If this error occurs when initiating a channel media relay, you can try again later; if this error occurs during channel media relay, you can call `leaveChannel:leaveChannelBlock:` to leave the channel. This error can also occur if the channel media relay service is not enabled in the project. You can contact `technical support` to enable the service.
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 `leaveChannel:leaveChannelBlock:` 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

The subscribing state.

Enumerator
AgoraStreamSubscribeStateIdle | 0: The initial publishing state after joining the channel.
AgoraStreamSubscribeStateNoSubscribed | 1: Fails to subscribe to the remote stream. Possible reasons: The remote user: Calls `muteLocalAudioStream:` (`YES`) or `muteLocalVideoStream:` (`YES`) to stop sending local media stream. Calls `disableAudio` or `disableVideo` to disable the local audio or video module. Calls `enableLocalAudio:` ( NO ) or `enableLocalVideo:` ( NO ) to disable local audio or video capture. The role of the remote user is audience. The local user calls the following methods to stop receiving remote streams: Call `muteRemoteAudioStream:mute:` ( YES ) or `muteAllRemoteAudioStreams:` ( YES ) to stop receiving the remote audio stream. Call `muteRemoteVideoStream:mute:` ( YES ) or `muteAllRemoteVideoStreams:` ( YES ) to stop receiving the remote video stream.
AgoraStreamSubscribeStateSubscribing | 2: Subscribing.
AgoraStreamSubscribeStateSubscribed | 3: The remote stream is received, and the subscription is successful.

## ◆ AgoraStreamPublishState

enum AgoraStreamPublishState

The publishing state.

Enumerator
AgoraStreamPublishStateIdle | 0: The initial publishing state after joining the channel.
AgoraStreamPublishStateNoPublished | 1: Fails to publish the local stream. Possible reasons: The local user calls `muteLocalAudioStream:` (`YES`) or `muteLocalVideoStream:` (`YES`) to stop sending local media streams. The local user calls `disableAudio` or `disableVideo` to disable the local audio or video module. The local user calls `enableLocalAudio:` (`NO`) or `enableLocalVideo:` (`NO`) to disable the local audio or video capture. The role of the local user is audience.
AgoraStreamPublishStatePublishing | 2: Publishing.
AgoraStreamPublishStatePublished | 3: Publishes successfully.

## ◆ AgoraApplicationScenarioType

enum AgoraApplicationScenarioType

The video application scenarios.

Since
  v4.2.0

Enumerator
AgoraApplicationGeneralScenario | 0: (Default) The general scenario.
AgoraApplicationMeetingScenario | 1: The meeting scenario. `AgoraApplicationMeetingScenario` (1) is suitable for meeting scenarios. The SDK automatically enables the following strategies: In meeting scenarios where low-quality video streams are required to have a high bitrate, the SDK automatically enables multiple technologies used to deal with network congestions, to enhance the performance of the low-quality streams and to ensure the smooth reception by subscribers. The SDK monitors the number of subscribers to the high-quality video stream in real time and dynamically adjusts its configuration based on the number of subscribers. If nobody subscribers to the high-quality stream, the SDK automatically reduces its bitrate and frame rate to save upstream bandwidth. If someone subscribes to the high-quality stream, the SDK resets the high-quality stream to the `AgoraVideoEncoderConfiguration` configuration used in the most recent calling of `setVideoEncoderConfiguration:`. If no configuration has been set by the user previously, the following values are used: On iOS: Resolution: 960 × 540 Frame rate: 15 fps Bitrate: 1000 Kbps On macOS: Resolution: 1280 × 720 Frame rate: 15 fps Bitrate: 1600 Kbps The SDK monitors the number of subscribers to the low-quality video stream in real time and dynamically enables or disables it based on the number of subscribers. If nobody subscribes to the low-quality stream, the SDK automatically disables it to save upstream bandwidth. If someone subscribes to the low-quality stream, the SDK enables the low-quality stream and resets it to the `AgoraSimulcastStreamConfig` configuration used in the most recent calling of `setDualStreamMode:streamConfig:`. If no configuration has been set by the user previously, the following values are used: Resolution: 480 × 272 Frame rate: 15 fps Bitrate: 500 Kbps Note If the user has called `setDualStreamMode:streamConfig:` to set that never send low-quality video stream ( `AgoraDisableSimulcastStream` ), the dynamic adjustment of the low-quality stream in meeting scenarios will not take effect.
AgoraApplication1V1Scenario | 2: 1v1 video call scenario. `AgoraApplication1V1Scenario` (2) This is applicable to the `one to one live` scenario. To meet the requirements for low latency and high-quality video in this scenario, the SDK optimizes its strategies, improving performance in terms of video quality, first frame rendering, latency on mid-to-low-end devices, and smoothness under weak network conditions. Note This enumeration value is only applicable to the broadcaster vs. broadcaster scenario.
AgoraApplicationLiveShowScenario | Live show scenario. `AgoraApplicationLiveShowScenario` (3) This is applicable to the `show room` scenario. In this scenario, fast video rendering and high image quality are crucial. The SDK implements several performance optimizations, including automatically enabling accelerated audio and video frame rendering to minimize first-frame latency (no need to call `enableInstantMediaRendering` ), and B-frame encoding to achieve better image quality and bandwidth efficiency. The SDK also provides enhanced video quality and smooth playback, even in poor network conditions or on lower-end devices.

## ◆ AgoraQoEPreferenceType

enum AgoraQoEPreferenceType

The video qoe preference enum type.

Since
  v4.2.0

Enumerator
AgoraVideoQOEPreferenceBalance | 0: Default QoE type, balance the delay, picture quality and fluency.
AgoraVideoQOEPreferenceDelayFirst | 1: lower the e2e delay.
AgoraVideoQOEPreferencePictureQualityFirst | 2: picture quality.
AgoraVideoQOEPreferenceFluencyFirst | 3: more fluency.

## ◆ 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 type.

Enumerator
AgoraMediaSourceTypeAudioPlayout | 0: Audio playback device.
AgoraMediaSourceTypeRecording | 1: Audio capturing device.
AgoraMediaSourceTypePrimaryCamera | 2: The primary camera.
AgoraMediaSourceTypeSecondaryCamera | 3: A secondary camera.
AgoraMediaSourceTypePrimaryScreen | 4: Video captured by primary screen capturer.
AgoraMediaSourceTypeSecondaryScreen | 5: Video captured by secondary screen capturer.
AgoraMediaSourceTypeCustomVideo | 6: 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 processed by the speech driven extension.
AgoraMediaSourceTypeUnknown | 100: Unknown media source.

## ◆ AgoraAudioSourceType

enum AgoraAudioSourceType

The audio source type.

Enumerator
AgoraAudioSourceMicrophone | 0: (Default) Microphone.
AgoraAudioSourceCustom | 1: Custom audio stream.
AgoraAudioSourceMediaPlayer | 2: Media player.
AgoraAudioSourceLoopbackRecording | 3: System audio stream captured during screen sharing.
AgoraAudioSourceMixedStream | Audio generated by local mixed track.
AgoraAudioSourceRemoteUser | 5: Audio stream from a specified remote user.
AgoraAudioSourceRemoteChannel | 6: Mixed audio streams from all users in the current channel.
AgoraAudioSourceTypeUnknown | 100: An unknown audio source.

## ◆ AgoraVideoSourceType

enum AgoraVideoSourceType

The type of the video source.

Enumerator
AgoraVideoSourceTypeCamera | 0: (Default) The primary camera.
AgoraVideoSourceTypeCameraSecondary | 1: The secondary camera.
AgoraVideoSourceTypeScreen | 2: The primary screen.
AgoraVideoSourceTypeScreenSecondary | 3: The secondary screen.
AgoraVideoSourceTypeCustom | 4: A custom video source.
AgoraVideoSourceTypeMediaPlayer | 5: The media player.
AgoraVideoSourceTypeImagePNG | 6: One PNG image.
AgoraVideoSourceTypeImageJPEG | 7: One JPEG image.
AgoraVideoSourceTypeImageGIF | 8: One GIF image.
AgoraVideoSourceTypeRemote | 9: One remote video acquired by the network.
AgoraVideoSourceTypeTransCoded | 10: One transcoded video source.
AgoraVideoSourceTypeCameraThird | 11: (macOS only) The third camera.
AgoraVideoSourceTypeCameraFourth | 12: (macOS only) The fourth camera.
AgoraVideoSourceTypeScreenThird | 13: (macOS only) The third screen.
AgoraVideoSourceTypeScreenFourth | 14: (macOS only) The fourth screen.
AgoraVideoSourceTypeSpeechDriven | 15: Video processed by the speech driven extension.
AgoraVideoSourceTypeUnknown | 100: An unknown video source.

## ◆ AgoraExternalVideoSourceType

enum AgoraExternalVideoSourceType

The external video frame encoding type.

Enumerator
AgoraExternalVideoSourceTypeVideoFrame | 0: The video frame is not encoded.
AgoraExternalVideoSourceTypeEncodedVideoFrame | 1: The video frame is encoded.

## ◆ AgoraSimulcastStreamMode

enum AgoraSimulcastStreamMode

The mode in which the video stream is sent.

Enumerator
AgoraAutoSimulcastStream | -1: By default, do not send the low-quality video stream until a subscription request for the low-quality video stream is received from the receiving end, then automatically start sending low-quality video stream.
AgoraDisableSimulcastStream | 0: Never send low-quality video stream.
AgoraEnableSimulcastStream | 1: Always send low-quality video stream.

## ◆ AgoraStreamLayerIndex

enum AgoraStreamLayerIndex

Index of video streams of different quality levels.

Since
  v4.6.0

Enumerator
AgoraStreamLayer1 | 0: Video stream layer_1, with lower resolution and bitrate than AgoraVideoStreamTypeHigh.
AgoraStreamLayer2 | 1: Video stream layer_2, with lower resolution and bitrate than AgoraVideoStreamTypeLayer1.
AgoraStreamLayer3 | 2: Video stream layer_3, with lower resolution and bitrate than AgoraVideoStreamTypeLayer2.
AgoraStreamLayer4 | 3: Video stream layer_4, with lower resolution and bitrate than AgoraVideoStreamTypeLayer3.
AgoraStreamLayer5 | 4: Video stream layer_5, with lower resolution and bitrate than AgoraVideoStreamTypeLayer4.
AgoraStreamLayer6 | 5: Video stream layer_6, with lower resolution and bitrate than AgoraVideoStreamTypeLayer5.
AgoraStreamLow | 6: Low-quality video stream, with the lowest resolution and bitrate.
AgoraStreamLayerCountMax | 7: Maximum number of video stream layers.

## ◆ AgoraMediaStreamType

enum AgoraMediaStreamType

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.

## ◆ AgoraMediaPlayerState

enum AgoraMediaPlayerState

The playback state.

Enumerator
AgoraMediaPlayerStateIdle | 0: The default state. The media player returns this state code before you open the media resource or after you stop the playback.
AgoraMediaPlayerStateOpening | 1: Opening the media resource.
AgoraMediaPlayerStateOpenCompleted | 2: Opens the media resource successfully.
AgoraMediaPlayerStatePlaying | 3: The media resource is playing.
AgoraMediaPlayerStatePaused | 4: Pauses the playback.
AgoraMediaPlayerStatePlayBackCompleted | 5: The playback is complete.
AgoraMediaPlayerStatePlayBackAllLoopsCompleted | 6: The loop is complete.
AgoraMediaPlayerStateStopped | 7: The playback stops.
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 | 100: The media player fails to play the media resource.

## ◆ AgoraMediaPlayerRenderMode

enum AgoraMediaPlayerRenderMode

Video display modes.

Enumerator
AgoraMediaPlayerRenderModeHidden | 1: Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). Hidden mode. 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). Fit mode. Areas that are not filled due to disparity in the aspect ratio are filled with black.

## ◆ AgoraMediaPlayerReason

enum AgoraMediaPlayerReason

Reasons for the changes in the media player status.

Enumerator
AgoraMediaPlayerReasonNone | 0: No error.
AgoraMediaPlayerReasonInvalidArguments | -1: Invalid arguments.
AgoraMediaPlayerReasonInternal | -2: Internal error.
AgoraMediaPlayerReasonNoSource | -3: No resource.
AgoraMediaPlayerReasonInvalidMediaSource | -4: Invalid media resource.
AgoraMediaPlayerReasonUnknowStreamType | -5: The media stream type is unknown.
AgoraMediaPlayerReasonObjNotInitialized | -6: The object is not initialized.
AgoraMediaPlayerReasonCodecNotSupported | -7: The codec is not supported.
AgoraMediaPlayerReasonVideoRenderFailed | -8: Invalid renderer.
AgoraMediaPlayerReasonInvalidState | -9: An error with the internal state of the player occurs.
AgoraMediaPlayerReasonUrlNotFound | -10: The URL of the media resource cannot be found.
AgoraMediaPlayerReasonInvalidConnectState | -11: Invalid connection between the player and the Agora Server.
AgoraMediaPlayerReasonSrcBufferUnderflow | -12: The playback buffer is insufficient.
AgoraMediaPlayerReasonInterrupted | -13: The playback is interrupted.
AgoraMediaPlayerReasonNotSupported | -14: The SDK does not support the method being called.
AgoraMediaPlayerReasonTokenExpired | -15: The authentication information of the media resource is expired.
AgoraMediaPlayerReasonIpExpired | `-16`: The ip has expired.
AgoraMediaPlayerReasonUnknown | -17: An unknown error.

## ◆ AgoraMediaPlayerEvent

enum AgoraMediaPlayerEvent

Media player events.

Enumerator
AgoraMediaPlayerEventSeekBegin | 0: The player begins to seek to a new playback position.
AgoraMediaPlayerEventSeekComplete | 1: The player finishes seeking to a new playback position.
AgoraMediaPlayerEventSeekError | 2: An error occurs when seeking to a new playback position.
AgoraMediaPlayerEventAudioTrackChanged | 5: The audio track used by the player has been changed.
AgoraMediaPlayerEventBufferLow | 6: The currently buffered data is not enough to support playback.
AgoraMediaPlayerEventBufferRecover | 7: The currently buffered data is just enough to support playback.
AgoraMediaPlayerEventFreezeStart | 8: The audio or video playback freezes.
AgoraMediaPlayerEventFreezeStop | 9: The audio or video playback resumes without freezing.
AgoraMediaPlayerEventSwitchBegin | 10: The player starts switching the media resource.
AgoraMediaPlayerEventSwitchComplete | 11: Media resource switching is complete.
AgoraMediaPlayerEventSwitchError | 12: Media resource switching error.
AgoraMediaPlayerEventFirstDisplayed | 13: The first video frame is rendered.
AgoraMediaPlayerEventReachCacheFileMaxCount | 14: The cached media files reach the limit in number.
AgoraMediaPlayerEventReachCacheFileMaxSize | 15: The cached media files reach the limit in aggregate storage space.
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
AgoraMediaPlayerEventHttpRedirect | Triggered when an http redirect occurs @technical preview

## ◆ AgoraMediaPlayerPreloadEvent

enum AgoraMediaPlayerPreloadEvent

Events that occur when media resources are preloaded.

Enumerator
AgoraMediaPlayerPreloadEventBegin | 0: Starts preloading media resources.
AgoraMediaPlayerPreloadEventComplete | 1: Preloading media resources is complete.
AgoraMediaPlayerPreloadEventError | 2: An error occurs when preloading media resources.

## ◆ AgoraMediaPlayerMetaDataType

enum AgoraMediaPlayerMetaDataType

The type of media metadata.

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

## ◆ AgoraPermissionType

enum AgoraPermissionType

The type of the device permission.

Enumerator
AgoraPermissionTypeRecordAudio | 0: Permission for the audio capture device.
AgoraPermissionTypeCamera | 1: Permission for the camera.

## ◆ AgoraDirectCdnStreamingState

enum AgoraDirectCdnStreamingState

The current CDN streaming state.

Deprecated:
  v4.6.0.

Enumerator
AgoraDirectCdnStreamingStateIdle | 0: The initial state before the CDN streaming starts.
AgoraDirectCdnStreamingStateRunning | 1: Streams are being pushed to the CDN. The SDK returns this value when you call the `startDirectCdnStreaming:publishUrl:mediaOptions:` method to push streams to the CDN.
AgoraDirectCdnStreamingStateStopped | 2: Stops pushing streams to the CDN. The SDK returns this value when you call the `stopDirectCdnStreaming` method to stop pushing streams to the CDN.
AgoraDirectCdnStreamingStateFailed | 3: Fails to push streams to the CDN. You can troubleshoot the issue with the information reported by the `onDirectCdnStreamingStateChanged:reason:message:` callback, and then push streams to the CDN again.
AgoraDirectCdnStreamingStateRecovering | 4: Tries to reconnect the Agora server to the CDN. The SDK attempts to reconnect a maximum of 10 times; if the connection is not restored, the streaming state becomes AgoraDirectCdnStreamingStateFailed.

## ◆ AgoraDirectCdnStreamingReason

enum AgoraDirectCdnStreamingReason

Reasons for the changes in CDN streaming status.

Deprecated:
  v4.6.0.

Enumerator
AgoraDirectCdnStreamingReasonOK | 0: No error.
AgoraDirectCdnStreamingReasonFailed | 1: A general error; no specific reason. You can try to push the media stream again.
AgoraDirectCdnStreamingReasonAudioPublication | 2: An error occurs when pushing audio streams. For example, the local audio capture device is not working properly, is occupied by another process, or does not get the permission required.
AgoraDirectCdnStreamingReasonVideoPublication | 3: An error occurs when pushing video streams. For example, the local video capture device is not working properly, is occupied by another process, or does not get the permission required.
AgoraDirectCdnStreamingReasonNetConnect | 4: Fails to connect to the CDN.
AgoraDirectCdnStreamingReasonBadName | 5: The URL is already being used. Use a new URL for streaming.

## ◆ AgoraEarMonitoringFilterType

enum AgoraEarMonitoringFilterType

The audio filter types of in-ear monitoring.

Enumerator
AgoraEarMonitoringFilterNone | 1<<0: No audio filter added to in-ear monitoring.
AgoraEarMonitoringFilterBuiltInAudioFilters | 1<<1: Add vocal effects audio filter to in-ear monitoring. If you implement functions such as voice beautifier and audio effect, users can hear the voice after adding these effects.
AgoraEarMonitoringFilterNoiseSuppression | 1<<2: Add noise suppression audio filter to in-ear monitoring.
AgoraEarMonitoringFilterBuiltInAudioFiltersWithNoiseSuppression | 6: Enable both audio fileter and noise suppression to the in-ear monitor.
AgoraEarMonitoringFilterReusePostProcessingFilter | 1<<15: Reuse the audio filter that has been processed on the sending end for in-ear monitoring. This enumerator reduces CPU usage while increasing in-ear monitoring latency, which is suitable for latency-tolerant scenarios requiring low CPU consumption.

## ◆ 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 | (Default) No content hint.
AgoraVideoContentHintMotion | Motion-intensive content. Choose this option if you prefer smoothness or when you are sharing a video clip, movie, or video game.
AgoraVideoContentHintDetails | Motionless content. Choose this option if you prefer sharpness or when you are sharing a picture, PowerPoint slides, or texts.

## ◆ 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

The type of video content moderation module.

Enumerator
AgoraContentInspectTypeInvalid | 0: (Default) This module has no actual function. Do not set `type` to this value.
AgoraContentInspectTypeModeration | Deprecated: content inspect type moderation
AgoraContentInspectTypeSupervise | 2: Video screenshot and upload via Agora self-developed extension. SDK takes screenshots of the video stream in the channel and uploads them.
AgoraContentInspectTypeImageModeration | 3: Video screenshot and upload via extensions from Agora Extensions Marketplace. SDK uses video moderation extensions from Agora Extensions Marketplace to take screenshots of the video stream in the channel and uploads them.

## ◆ AgoraContentInspectResult

enum AgoraContentInspectResult

Enumerator
AgoraContentInspectNeutral |
AgoraContentInspectSexy |
AgoraContentInspectPorn |

## ◆ AgoraAudioDualMonoMode

enum AgoraAudioDualMonoMode

The channel mode.

Enumerator
AgoraAudioDualMonoStereo | 0: Original mode.
AgoraAudioDualMonoL | 1: Left channel mode. This mode replaces the audio of the right channel with the audio of the left channel, which means the user can only hear the audio of the left channel.
AgoraAudioDualMonoR | 2: Right channel mode. This mode replaces the audio of the left channel with the audio of the right channel, which means the user can only hear the audio of the right channel.
AgoraAudioDualMonoMix | 3: Mixed channel mode. This mode mixes the audio of the left channel and the right channel, which means the user can hear the audio of the left channel and the right channel at the same time.

## ◆ AgoraRhythmPlayerState

enum AgoraRhythmPlayerState

Virtual metronome state.

Enumerator
AgoraRhythmPlayerStateIdle | 810: The virtual metronome is not enabled or disabled already.
AgoraRhythmPlayerStateOpening | 811: Opening the beat files.
AgoraRhythmPlayerStateDecoding | 812: Decoding the beat files.
AgoraRhythmPlayerStatePlaying | 813: The beat files are playing.
AgoraRhythmPlayerStateFailed | 814: Failed to start virtual metronome. You can use the reported `errorCode` to troubleshoot the cause of the error, or you can try to start the virtual metronome again.

## ◆ AgoraRhythmPlayerReason

enum AgoraRhythmPlayerReason

Virtual Metronome error message.

Enumerator
AgoraRhythmPlayerReasonOK | 0: The beat files are played normally without errors.
AgoraRhythmPlayerReasonFailed | 1: A general error; no specific reason.
AgoraRhythmPlayerReasonCanNotOpen | 801: There is an error when opening the beat files.
AgoraRhythmPlayerReasonCanNotPlay | 802: There is an error when playing the beat files.
AgoraRhythmPlayerReasonFileOverDurationLimit | 803: The duration of the beat file exceeds the limit. The maximum duration is 1.2 seconds.

## ◆ AgoraVideoTranscoderError

enum AgoraVideoTranscoderError

The error code of the local video mixing failure.

Enumerator
AgoraVideoTranscoderErrorOK | No error
AgoraVideoTranscoderErrorVideoSourceNotReady | 1: The selected video source has not started video capture. You need to create a video track for it and start video capture.
AgoraVideoTranscoderErrorInvalidVideoSourceType | 2: The video source type is invalid. You need to re-specify the supported video source type.
AgoraVideoTranscoderErrorInvalidImagePath | 3: The image path is invalid. You need to re-specify the correct image path.
AgoraVideoTranscoderErrorUnsupportImageFormat | 4: The image format is invalid. Make sure the image format is one of PNG, JPEG, or GIF.
AgoraVideoTranscoderErrorInvalidLayout | 5: The video encoding resolution after video mixing is invalid.
AgoraVideoTranscoderErrorInternal | 20: Unknown internal error.

## ◆ AgoraLocalProxyMode

enum AgoraLocalProxyMode

Connection mode with Agora private media server.

Enumerator
AgoraConnectivityFirst | 0: The SDK first attempts to connect to the specified Agora private media server. If it fails to connect to the specified Agora private media server, it connects to the Agora SD-RTN™.
AgoraLocalOnly | 1: The SDK only attempts to connect to the specified Agora private media server.

## ◆ AgoraProxyType

enum AgoraProxyType

The cloud proxy type.

Enumerator
AgoraNoneProxyType | 0: Reserved for future use.
AgoraUdpProxyType | 1: The cloud proxy for the UDP protocol, that is, the Force UDP cloud proxy mode. In this mode, the SDK always transmits data over UDP.
AgoraTcpProxyType | 2: The cloud proxy for the TCP (encryption) protocol, that is, the Force TCP cloud proxy mode. In this mode, the SDK always transmits data over TCP/TLS 443.
AgoraLocalProxyType | 3: Reserved for future use.
AgoraTcpProxyAutoFallbackType | 4: Automatic mode. In this mode, the SDK attempts a direct connection to SD-RTN™ and automatically switches to TCP/TLS 443 if the attempt fails.
AgoraHttpProxyType | The http proxy.
AgoraHttpsProxyType | The https proxy.

## ◆ AgoraVideoViewSetupMode

enum AgoraVideoViewSetupMode

Setting mode of the view.

Enumerator
AgoraVideoViewSetupReplace | 0: (Default) Clear all added views and replace with a new view.
AgoraVideoViewSetupAdd | 1: Adds a view.
AgoraVideoViewSetupRemove | 2: Deletes a view. Note When you no longer need to use a certain view, it is recommended to delete the view by setting `setupMode` to AgoraVideoViewSetupRemove, otherwise it may lead to leak of rendering resources.

## ◆ AgoraAudioProcessChannels

enum AgoraAudioProcessChannels

The number of channels for audio preprocessing.

In scenarios that require enhanced realism, such as concerts, local users might need to capture stereo audio and send stereo signals to remote users. For example, the singer, guitarist, and drummer are standing in different positions on the stage. The audio capture device captures their stereo audio and sends stereo signals to remote users. Remote users can hear the song, guitar, and drum from different directions as if they were at the auditorium. You can set the dual-channel processing to implement stereo audio in this class. Agora recommends the following settings:1. Preprocessing: call `setAdvancedAudioOptions:` and set `audioProcessingChannels` to `AgoraAudioProcessChannelstereo` (2) in `AgoraAdvancedAudioOptions`.

1. Post-processing: call `setAudioProfile:` and set `profile` to `AgoraAudioProfileMusicStandardStereo` (3) or `AgoraAudioProfileMusicHighQualityStereo` (5).

Note
  - The stereo setting only takes effect when the SDK uses the media volume.
  - On iOS, the minimum version of system for stereo sound is 14.0. The minimum device requirements are as follows:
    - iPhone XS
    - iPhone XS Max
    - iPhone XR
    - iPhone 11
    - iPhone 11 Pro
    - iPhone 11 Pro Max
    - iPhone SE (2020)
    - iPad Pro 11" and 12.9" (3rd generation)
    - iPad Pro 11" and 12.9" (4th generation)

Enumerator
AgoraAudioProcessChannelsMono | 1: (Default) Mono.
AgoraAudioProcessChannelstereo | 2: Stereo.

## ◆ AgoraVideoFramePosition

enum AgoraVideoFramePosition

The frame position of the video observer.

Enumerator
AgoraVideoFramePositionPostCapture | 1: The location of the locally collected video data after preprocessing corresponds to the `onCaptureVideoFrame:sourceType:` callback. The observed video here has the effect of video pre-processing, which can be verified by enabling image enhancement, virtual background, or watermark.
AgoraVideoFramePositionPreRenderer | 2: The pre-renderer position , which corresponds to the video data in the `onRenderVideoFrame:uid:channelId:` callback.
AgoraVideoFramePositionPreEncoder | 4: The pre-encoder position , which corresponds to the video data in the `onPreEncodeVideoFrame:sourceType:` callback. The observed video here has the effects of video pre-processing and encoding pre-processing. To verify the pre-processing effects of the video, you can enable image enhancement, virtual background, or watermark. To verify the pre-encoding processing effect, you can set a lower frame rate (for example, 5 fps).

## ◆ AgoraMediaRecorderState

enum AgoraMediaRecorderState

The current recording state.

Enumerator
AgoraMediaRecorderStateError | -1: An error occurs during the recording. See `AgoraMediaRecorderReasonCode` for the reason.
AgoraMediaRecorderStateStarted | 2: The audio and video recording starts.
AgoraMediaRecorderStateStopped | 3: The audio and video recording stops.

## ◆ AgoraMediaRecorderReasonCode

enum AgoraMediaRecorderReasonCode

The reason for the state change.

Enumerator
AgoraMediaRecorderReasonCodeNoError | 0: No error.
AgoraMediaRecorderReasonCodeWriteFailed | 1: The SDK fails to write the recorded data to a file.
AgoraMediaRecorderReasonCodeNoStream | 2: The SDK does not detect any audio and video streams, or audio and video streams are interrupted for more than five seconds during recording.
AgoraMediaRecorderReasonCodeOverMaxDuration | 3: The recording duration exceeds the upper limit.
AgoraMediaRecorderReasonCodeConfigChange | 4: The recording configuration changes.

## ◆ AgoraMediaRecorderStreamType

enum AgoraMediaRecorderStreamType

The recording content.

Enumerator
AgoraMediaRecorderStreamTypeAudio | 1: Only audio.
AgoraMediaRecorderStreamTypeVideo | 2: Only video.
AgoraMediaRecorderStreamTypeBoth | 3: (Default) Audio and video.

## ◆ AgoraMediaRecorderContainerFormat

enum AgoraMediaRecorderContainerFormat

Format of the recording file.

Enumerator
AgoraMediaRecorderContainerFormatMP4 | 1: (Default) MP4.

## ◆ AgoraRecorderStreamType

enum AgoraRecorderStreamType

Type of video streams to be recorded.

Enumerator
AgoraRecorderStreamTypeRtc | 0: (Default) The video stream within the source channel.
AgoraRecorderStreamTypePreview | 1: The video stream from local video capturing that you preview before joining a channel.

## ◆ AgoraScreenCaptureSourceType

enum AgoraScreenCaptureSourceType

The type of the shared target. Set in `AgoraScreenCaptureSourceInfo`.

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

The highest frame rate supported by the screen sharing device.

Enumerator
AgoraScreenCaptureFrameRateUnKonw |
AgoraScreenCaptureFrameRate15FPS | 0: The device supports the frame rate of up to 15 fps.
AgoraScreenCaptureFrameRate30FPS | 1: The device supports the frame rate of up to 30 fps.
AgoraScreenCaptureFrameRate60FPS | 2: The device supports the frame rate of up to 60 fps.

## ◆ AgoraAudioTrackType

enum AgoraAudioTrackType

The type of the audio track.

Enumerator
AgoraAudioTrackTypeMixable | 0: Mixable audio tracks. This type of audio track supports mixing with other audio streams (such as audio streams captured by microphone) and playing locally or publishing to channels after mixing. The latency of mixable audio tracks is higher than that of direct audio tracks.
AgoraAudioTrackTypeDirect | 1: Direct audio tracks. This type of audio track will replace the audio streams captured by the microphone and does not support mixing with other audio streams. The latency of direct audio tracks is lower than that of mixable audio tracks. Note If `AgoraAudioTrackTypeDirect` is specified for this parameter, you must set `publishMicrophoneTrack` to `NO` in `AgoraRtcChannelMediaOptions` when calling `joinChannelByToken:channelId:uid:mediaOptions:joinSuccess:` to join the channel; otherwise, joining the channel fails and returns the error code -2.

## ◆ AUDIO_AINS_MODE

enum AUDIO_AINS_MODE

AI noise suppression modes.

Enumerator
AINS_MODE_BALANCED | 0: (Default) Balance mode. This mode allows for a balanced performance on noice suppression and time delay.
AINS_MODE_AGGRESSIVE | 1: Aggressive mode. In scenarios where high performance on noise suppression is required, such as live streaming outdoor events, this mode reduces nosie more dramatically, but may sometimes affect the original character of the audio.
AINS_MODE_ULTRALOWLATENCY | 2: Aggressive mode with low latency. The noise suppression delay of this mode is about only half of that of the balance and aggressive modes. It is suitable for scenarios that have high requirements on noise suppression with low latency, such as sing together online in real time.

## ◆ AgoraVideoModulePosition

enum AgoraVideoModulePosition

The frame position of the video observer.

Enumerator
AgoraVideoModulePositionPostCapture | 1: The location of the locally collected video data after preprocessing corresponds to the `onCaptureVideoFrame:sourceType:` callback. The observed video here has the effect of video pre-processing, which can be verified by enabling image enhancement, virtual background, or watermark.
AgoraVideoModulePositionPreRenderer | 2: The pre-renderer position , which corresponds to the video data in the `onRenderVideoFrame:uid:channelId:` callback.
AgoraVideoModulePositionPreEncoder | 4: The pre-encoder position , which corresponds to the video data in the `onPreEncodeVideoFrame:sourceType:` callback. The observed video here has the effects of video pre-processing and encoding pre-processing. To verify the pre-processing effects of the video, you can enable image enhancement, virtual background, or watermark. To verify the pre-encoding processing effect, you can set a lower frame rate (for example, 5 fps).
AgoraVideoModulePositionPostCaptureOrigin | 8: The position after local video capture and before pre-processing. The observed video here does not have pre-processing effects, which can be verified by enabling image enhancement, virtual background, or watermarks.

## ◆ AgoraMediaTraceEvent

enum AgoraMediaTraceEvent

The rendering state of the media frame.

Enumerator
AgoraMediaTraceEventVideoRendered | 0: The video frame has been rendered.
AgoraMediaTraceEventVideoDecoded | 1: The video 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

The type of the advanced feature.

Enumerator
AgoraVideoPreprocessVirtualBackground | 1: Virtual background.
AgoraVideoPreprocessBeauty | 2: Image enhancement.

## ◆ AgoraVideoModule

enum AgoraVideoModule

Enumerator
AgoraVideoModuleCapturer |
AgoraVideoModuleSoftwareEncoder |
AgoraVideoModuleHardwareEncoder |
AgoraVideoModuleSoftwareDecoder |
AgoraVideoModuleHardwareDecoder |
AgoraVideoModuleRenderer |

## ◆ AgoraHDRCapability

enum AgoraHDRCapability

Enumerator
AgoraHDRCapabilityUnknown |
AgoraHDRCapabilityUnsupported |
AgoraHDRCapabilitySupported |

## ◆ AgoraAlphaStitchMode

enum AgoraAlphaStitchMode

The relative position of `alphaBuffer` and video frames.

Enumerator
AgoraNoAlphaStitch | 0: (Default) Only video frame, that is, `alphaBuffer` is not stitched with the video frame.
AgoraAlphaStitchUp | 1: `alphaBuffer` is above the video frame.
AgoraAlphaStitchBelow | 2: `alphaBuffer` is below the video frame.
AgoraAlphaStitchLeft | 3: `alphaBuffer` is to the left of the video frame.
AgoraAlphaStitchRight | 4: `alphaBuffer` is to the right of the video frame.

## ◆ WatermarkType

enum WatermarkType

Type of watermark source.

Since
  4.6.0

Enumerator
WatermarkTypeImage | (0): The watermark source is an image.
WatermarkTypeBuffer | (1): The watermark source is a buffer.

## ◆ WatermarkBufferFormat

enum WatermarkBufferFormat

The data format of the watermark buffer.

Since
  4.6.0

Enumerator
WatermarkBufferFormatI420 | (1): The watermark buffer uses the I420 format.
WatermarkBufferFormatBGRA | (2): The watermark buffer uses the BGRA format.
WatermarkBufferFormatNV21 | (3): The watermark buffer uses the NV21 format.
WatermarkBufferFormatRGBA | (4): The watermark buffer uses the RGBA format.

## ◆ AgoraRdtStreamType

enum AgoraRdtStreamType

Reliable Data Transmission Tunnel message stream type.

@technical preview

Enumerator
AgoraRdtStreamCmd | Command stream type. Characterized by: reliability, high priority, and not affected by congestion control. Transmission limits: a maximum of 256 bytes per packet, and 100 packets per second.
AgoraRdtStreamData | Data stream type. Characterized by: reliability, low priority, and affected by congestion control. Transmission limits: a maximum of 128 KBytes per packet, with a rate of 4 Mbps.
AgoraRdtStreamCount | Reliable Data Transmission stream type count

## ◆ AgoraRdtState

enum AgoraRdtState

Reliable Data Transmission tunnel state.

@technical preview

Enumerator
AgoraRdtStateClose | The RDT tunnel is in the initial or is closed.
AgoraRdtStateOpened | The RDT tunnel is open, and data can only be sent in this state.
AgoraRdtStatePending | The RDT tunnel is in a suspended state because SDK has disconnected. It will automatically resume to the RDT_STATE_OPENED state after rejoining the channel.
AgoraRdtStateBroken | The RDT channel is broken, and the data being sent and received will be cleared. It will automatically resume to the RDT_STATE_OPENED state later. Reason for occurrence: The remote user actively called the API to leave the channel and then rejoined the channel, without being detected by this end.

## ◆ AgoraMultipathMode

enum AgoraMultipathMode

The transmission mode of data over multiple network paths.

Since
  4.6.0

Enumerator
AgoraMultipathModeDuplicate | 0: Duplicate mode, where data is sent over multiple paths simultaneously. @technical preview
AgoraMultipathModeDynamic | (1): Dynamic transmission mode. The SDK dynamically selects the optimal path for data transmission to improve transmission performance.

## ◆ AgoraMultipathType

enum AgoraMultipathType

Network path types used in multipath transmission.

Since
  4.6.0

Enumerator
AgoraMultipathTypeLAN | (0): LAN type, indicates data is transmitted over a local area network.
AgoraMultipathTypeWIFI | (1): WIFI type, indicates data is transmitted over a Wi-Fi network.
AgoraMultipathTypeMobile | (2): Mobile type, indicates data is transmitted over a mobile network.
AgoraMultipathTypeUnknown | (99): Unknown type, indicates an unrecognized network path type.

## ◆ AgoraRenewTokenErrorCode

enum AgoraRenewTokenErrorCode

Represents the error codes after calling `renewToken:`.

Since
  4.6.0

Enumerator
AgoraRenewTokenSuccess | (0): Token updated successfully.
AgoraRenewTokenFailure | (1): Token update failed. It is recommended to generate a new Token and retry `renewToken:`.
AgoraRenewTokenExpiredToken | 2: The token renewal failed because the provided token has expired. It is recommended that the user generate a new token with a longer expiration time and retry renewToken.
AgoraRenewTokenInvalidToken | (3): Token update failed because the provided Token is invalid. Common reasons include: the project has enabled App Certificate in the Agora Console but did not use a Token when joining the channel; the uid specified in `joinChannel` is inconsistent with the uid used when generating the Token; the channel name specified in `joinChannel` is inconsistent with the one used when generating the Token. It is recommended to check the Token generation process, generate a new Token, and retry `renewToken:`.
AgoraRenewTokenInvalidChannelName | (4): Token update failed because the channel name in the Token does not match the current channel. It is recommended to check the channel name, generate a new Token, and retry `renewToken:`.
AgoraRenewTokenInconsistentAppId | (5): Token update failed because the App ID in the Token does not match the current App ID. It is recommended to check the App ID, generate a new Token, and retry `renewToken:`.
AgoraRenewTokenCanceledByNewRequest | (6): The Token update request was canceled because a new request was initiated.