Release notes

Known issues

v4.6.2

Released on January 19, 2026.

Improvements

This release includes the following enhancements:

• Seamless switching for sound effect files

  Adds support for seamless switching of sound effect files. For the same sound effect file, if you call preloadEffect followed by playEffect, the SDK does not close the file after playback completes or when stopEffect is called. When you call playEffect again, the SDK reuses the loaded file to enable loop playback and seamless switching. This feature also works in multi-channel scenarios.

• Improved accuracy of network quality evaluation

  Improves the accuracy of network quality evaluation in the onNetworkQuality callback, making the reported data better reflect the user's perceived experience.

• Support for 24kHz sampling rate for audio playback

  Adds support for audio data with a sample rate of 24000 Hz in onPlaybackAudioFrame. When calling setPlaybackAudioFrameParameters to set the playback audio format, you can set sampleRate to 24000.

• Additional improvements

  • Adds error codes ERR_PCMSEND_FORMAT (200) and ERR_PCMSEND_BUFFEROVERFLOW (201) to report PCM data transmission errors.

Compatibility changes

This release introduces the following compatibility changes:

• Decoder plugins built into the SDK

  The relevant decoder plugins are now built into the SDK to ensure overall decoding compatibility.

v4.6.0

Released on August 26, 2025.

Compatibility changes

This version includes SDK behavior changes, API deprecations, and deletions. To ensure your app functions correctly, update your code after upgrading to this version.

For details on deprecated and deleted APIs in each version, see the API Sunset Notice.

• Deprecation of direct CDN streaming APIs

  Deprecates the APIs related to direct CDN streaming, which will be removed in a future release. Agora recommends using Media Push instead.

  • setDirectCdnStreamingAudioConfiguration
  • setDirectCdnStreamingVideoConfiguration
  • startDirectCdnStreaming
  • stopDirectCdnStreaming
  • updateDirectCdnStreamingMediaOptions
  • DirectCdnStreamingMediaOptions
  • DirectCdnStreamingStats
  • DIRECT_CDN_STREAMING_STATE
  • DIRECT_CDN_STREAMING_REASON

• Deprecation of virtual metronome APIs

  Deprecates the APIs for the virtual metronome feature, which will be removed in a future release.

  • startRhythmPlayer
  • configRhythmPlayer
  • onRhythmPlayerStateChanged

• Deletion of redundant APIs

  Removed the following redundant APIs and parameters:

  • setLocalPublishFallbackOption
  • onLocalPublishFallbackToAudioOnly
  • onDownlinkNetworkInfoUpdated
  • onWlAccStats
  • WlAccStats
  • onWlAccMessage
  • WLACC_MESSAGE_REASON
  • WLACC_SUGGEST_ACTION
  • enableWirelessAccelerate

• Changes to int UID and string UID mapping

  • Before v4.6.0: If registerLocalUserAccount was used to register a string UID (for example, "aa") and obtain an int UID (for example, 123), joining a channel later with the int UID automatically mapped it to the original string UID ("aa").
  • From v4.6.0: The SDK no longer automatically maps an int UID to the original string UID. If registerLocalUserAccount was called to get an int UID but the channel needs to be joined with the original string UID, call joinChannelWithUserAccount directly with the string UID. After upgrading, review and update app logic to ensure users join the channel with the expected identity.

New features

• Multipath network transmission

  Introduced multipath transmission for devices with multiple network interfaces (for example, 5G, Wi-Fi, and LAN). This feature effectively reduces or eliminates experience degradation caused by poor network conditions, making it suitable for real-time audio and video communication scenarios that demand high transmission stability, such as in-vehicle systems, IoT, trains, and highways. Enable it by setting enableMultipath in ChannelMediaOptions to true.

  • Dynamic mode: Dynamically selects the optimal path based on network conditions. Optionally set preferMultipathType to prioritize a path type. If not set, all path types have the same default weight.
  • Duplicate mode: Sends data simultaneously over all available paths for maximum stability. This mode incurs additional costs and eliminates the impact of poor network conditions.

  Configure uplink and downlink modes separately with uplinkMultipathMode and downlinkMultipathMode. Monitor performance with the onMultipathStats callback, which reports real-time transmission statistics for each path, including data consumption. Contact support@agora.io to enable duplicate mode.

• Asynchronous engine destruction

  Added the release method with a callback parameter, supporting synchronous or asynchronous engine destruction. In asynchronous mode, the SDK triggers the RtcEngineReleaseCallback callback.

• Token renewal result callback

  Added the onRenewTokenResult callback and RENEW_TOKEN_ERROR_CODE to report the result of renewToken. This allows developers to handle Token renewal failures promptly within the callback.

• Other new features

  • Added setPlaybackAudioFrameBeforeMixingParameters2 to configure the format of raw audio frames returned in onPlaybackAudioFrameBeforeMixing, including sample rate, number of channels, and the number of samples per callback.
  • Added preloadEffectEx to preload audio effects into a specific channel. Supports both local and online audio files, enabling faster playback later and is suitable for multi-channel scenarios.
  • Added playEffectEx for advanced audio effect playback in a specific channel with parameters such as loop count, pitch, spatial position, volume, whether to publish to the channel, and the starting playback position.

Improvements

• Optimized permission requests on Windows 11 24H2 and later versions to avoid unnecessarily acquiring location information.
• Added support for G.711 and G.722 audio codecs when interoperating with the Web SDK for improved cross-platform audio compatibility and clarity.
• Improved video clarity in screen sharing scenarios involving documents.

Issues fixed

This version fixes the following issues:

• Online audio effect playback restarted from the beginning when seek was called.
• Occasional echoes in media volume mode when publishing a microphone stream while simultaneously playing effects with playEffect3 and music with startAudioMixing2.
• SDK crashed on Windows when handling file paths containing Chinese characters due to an encoding conversion error.
• Media relay occasionally reported RELAY_STATE_FAILURE and RELAY_ERROR_SERVER_ERROR_RESPONSE after join, relay, unpublish, leave, rejoin, and relay again sequences.
• Receivers occasionally heard echoes when the sender shared their screen and audio from certain laptop models with power-saving mode enabled.
• In online education scenarios, the teacher's local view of multiple students' video and audio was occasionally out of sync.

v4.5.2

v4.5.2 was released on April 22, 2025.

Issues fixed

This release fixes the following issues:

• When playing a multi-track media file, you could hear noise after calling the setAudioPitch method to adjust the pitch.
• After the host called createCustomAudioTrack with trackType set to AUDIO_TRACK_DIRECT, pushed custom audio frames using pushAudioFrame, and played audio effects with playEffect, audience members heard noise.
• Apps integrated with the SDK occasionally experienced UI lag due to main thread blocking during audio and video interactions.
• The local preview of a shared screen flickered after calling startScreenCapture [2/2], enabling enableHighLight in ScreenCaptureParameters, placing the shared window on the top layer, and maximizing it.
• When using startScreenCaptureByDisplayId with excludeWindowList in ScreenCaptureParameters, some windows failed to be excluded as expected.
• The app crashed after sharing video from an external screen and then disconnecting the screen.
• Calling openWithMediaSource and setting isLiveSource to true failed to play the video stream.
• When sending multi-channel encoded audio, the receiver occasionally heard noise.
• When the app integrated a media player and called open twice to load different media resources in succession, the onPlayerInfoUpdated [1/2] callback incorrectly returned info for the first resource.
• After calling enableAudioVolumeIndication, the rtcEngine:reportAudioVolumeIndicationOfSpeakers:totalVolume: callback returned a local user volume of 0 for both local and remote users.
• In scenarios involving audio/video communication and screen sharing on a 21
  ultra-wide display, setting a high resolution such as 3840×2160 resulted in the shared screen image being cropped in both the local preview and on the receiver's display.
• When the app called enableVideoImageSource to enable the video image source feature, the sender appeared to stream successfully, but the onVideoPublishStateChanged callback did not return as expected.
• In multi-channel scenarios, if the app called setupRemoteVideoEx to initialize the remote user’s view before successfully calling joinChannelEx, the first frame of the remote video was significantly delayed.

v4.5.1

v4.5.1 was released on March 6, 2025.

New Features

AI Conversation Scenario

This version introduces the AUDIO_SCENARIO_AI_CLIENT audio scenario, specifically designed for interacting with the conversational AI agent created by Conversational AI Engine. This scenario optimizes the audio transmission algorithm based on the characteristics of AI-generated voices, ensuring stable voice data transmission even in weak network conditions with up to 80% packet loss. The optimization enhances conversation continuity and reliability, adapting to various challenging network environments.

Issues Fixed

This release resolves the following issues:

• When using the pause method to pause playback, then calling seek to move to a specific position, and finally calling play, the Media Player resumed from the paused position instead of the specified position.
• When using the Media Player, the file path of the media resource returned by getPlaySrc did not update after calling switchSrc to switch to a new media resource.
• In interactive live streaming scenarios, after joining a channel as an audience member using a string user ID, audio occasionally became unsynchronized with video.
• AI noise suppression and AI echo cancellation plugins sometimes failed when used together.

v4.5.0

This version was released on November 27, 2024.

Compatibility changes

This version includes optimizations to some features, including changes to SDK behavior, API renaming and deletion. To ensure normal operation of the project, update the code in the app after upgrading to this release.

Attention:

1. Member parameter type changes

   To enhance the adaptability of various frameworks to the SDK, this version has made the following modifications to some API members or parameters:

   API	Members/Parameters	Change
   startScreenCaptureByDisplayId	displayId	Changed from uint32_t to int64_t
   startScreenCaptureByWindowId	windowId	Changed from view_t to int64_t
   ScreenCaptureConfiguration	displayId windowId	displayId: Changed from uint32_t to int64_t windowId: Changed from view_t to int64_t
   ScreenCaptureSourceInfo	sourceDisplayId sourceId	sourceDisplayId： Changed from view_t to int64_t sourceId：Default value changed from nullptr to 0

New features

1. Local audio mixing

   This version introduces the local audio mixing feature. You can call the startLocalAudioMixer method to mix the audio streams from the local microphone, media player, sound card, and remote audio streams into a single audio stream, which can then be published to the channel. When you no longer need audio mixing, you can call the stopLocalAudioMixer method to stop local audio mixing. During the mixing process, you can call the updateLocalAudioMixerConfiguration method to update the configuration of the audio streams being mixed.

   Example use cases for this feature include:

   • By utilizing the local video mixing feature, the associated audio streams of the mixed video streams can be simultaneously captured and published.
   • In live streaming use-cases, users can receive audio streams within the channel, mix multiple audio streams locally, and then forward the mixed audio stream to other channels.
   • In educational use-cases, teachers can mix the audio from interactions with students locally and then forward the mixed audio stream to other channels.

2. Others

   • onLocalVideoStateChanged callback adds the LOCAL_VIDEO_STREAM_REASON_DEVICE_DISCONNECTED enumeration, indicating that the currently used video capture device has been disconnected (for example, unplugged).
   • MEDIA_DEVICE_STATE_TYPE adds the MEDIA_DEVICE_STATE_PLUGGED_IN enumeration, indicating that the device has been plugged in.

Improvements

1. Custom audio capture improvements

   This version adds the enableAudioProcessing member parameter to AudioTrackConfig, which is used to control whether to enable 3A audio processing for custom audio capture tracks of the AUDIO_TRACK_DIRECT type. The default value of this parameter is false, meaning that audio processing is not enabled. Users can enable it as needed, enhancing the flexibility of custom audio processing.

2. Other improvements

   • This version optimizes the logic for calling queryDeviceScore to obtain device score levels, improving the accuracy of the score results.
   • Supports using virtual cameras in YV12 format as video capture devices.
   • When calling switchSrc to switch between live streams or on-demand streams of different resolutions, smooth and seamless switching can be achieved. An automatic retry mechanism has been added in case of switching failures. The SDK will automatically retry 3 times after a failure. If it still fails, the onPlayerEvent callback will report the PLAYER_EVENT_SWITCH_ERROR event, indicating that an error has occurred during media resource switching.
   • When calling setPlaybackSpeed to set the playback speed of an audio file, the minimum supported speed is 0.3x.

Bug fixes

This version fixes the following issues:

• Occasional errors of not finding system files during audio and video interaction on Windows 7 systems.
• When calling followSystemRecordingDevice or followSystemPlaybackDevice to set the audio capture or playback device used by the SDK to not follow the system default audio playback device, the local audio state callback onLocalAudioStateChanged is not triggered when the audio device is removed.
• Calling startAudioMixing [1/2] and then immediately calling pauseAudioMixing to pause the music file playback does not take effect.

v4.4.0

v4.4.0 was released on August 5, 2024.

Compatibility changes

This version includes optimizations to some features, including changes to SDK behavior and API renaming and deletion. To ensure normal operation of the project, update the code in the app after upgrading to this release.

1. To distinguish context information in different extension callbacks, this version removes the original extension callbacks and adds corresponding callbacks that contain context information (see table below). You can identify the extension name, the user ID, and the service provider name through ExtensionContext in each callback.

   Original callback	New callback
   onExtensionEvent	onExtensionEventWithContext
   onExtensionStarted	onExtensionStartedWithContext
   onExtensionStopped	onExtensionStoppedWithContext
   onExtensionError	onExtensionErrorWithContext

New features

1. Voice AI tuner

   This version introduces the voice AI tuner feature, which can enhance the sound quality and tone, similar to a physical sound card. You can enable the voice AI tuner feature by calling the enableVoiceAITuner method and passing in the sound effect types supported in the VOICE_AI_TUNER_TYPE enum to achieve effects like deep voice, cute voice, husky singing voice, and so on.

Improvements

1. Adaptive hardware decoding support

   This release introduces adaptive hardware decoding support, enhancing rendering smoothness on low-end devices and effectively reducing system load.

2. Rendering performance enhancement

   DirectX 11 renderer is now enabled by default on Windows devices, providing high-performance and high-quality graphics rendering capabilities.

3. Other improvements

   This version also includes the following improvements:

   • Optimizes the transmission strategy: Calling enableInstantMediaRendering no longer impacts the security of the transmission link.
   • Adds the channelId parameter to Metadata, which is used to get the channel name from which the metadata is sent.
   • Deprecates redundant enumeration values CLIENT_ROLE_CHANGE_FAILED_REQUEST_TIME_OUT and CLIENT_ROLE_CHANGE_FAILED_CONNECTION_FAILED in CLIENT_ROLE_CHANGE_FAILED_REASON.

v4.3.2

v4.3.2 was released on June 4, 2024.

Improvements

This release enhances the usability of the setRemoteSubscribeFallbackOption method by removing the timing requirements for invocation. It can now be called both before and after joining the channel to dynamically switch audio and video stream fallback options in weak network conditions.

Issues fixed

This version fixed the following issue:

• The app occasionally crashed when remote users left the channel.

v4.3.1

v4.3.1 was released on April 29, 2024.

New features

1. Data stream encryption

   This version adds datastreamEncryptionEnabled to EncryptionConfig for enabling data stream encryption. You can set this when you activate encryption with enableEncryption. If there are issues causing failures in data stream encryption or decryption, these can be identified by the newly added ENCRYPTION_ERROR_DATASTREAM_DECRYPTION_FAILURE and ENCRYPTION_ERROR_DATASTREAM_ENCRYPTION_FAILURE enumerations.

2. Other features

   • A new method enableEncryptionEx is added for enabling media stream or data stream encryption in multi-channel use-cases.
   • A new method setAudioMixingPlaybackSpeed is introduced for setting the playback speed of audio files.
   • A new method getCallIdEx is introduced for retrieving call IDs in multi-channel use-cases.

3. Beta features

   • Speech driven avatar is released in beta. See beta documentation for details.

Improvements

1. CPU consumption reduction of in-ear monitoring

   This release adds an enumerator EAR_MONITORING_FILTER_REUSE_POST_PROCESSING_FILTER in EAR_MONITORING_FILTER_TYPE. For complex audio processing use-cases, you can specify this option to reuse the audio filter after sender-side processing in in-ear monitoring, thereby reducing CPU consumption. Note that this option may increase the latency of in-ear monitoring, which is suitable for latency-tolerant use-cases requiring low CPU consumption.

2. Other improvements

   This version also includes the following improvements:

   • In AUDIO_EFFECT_PRESET, a new enumeration ROOM_ACOUSTICS_CHORUS (chorus effect) is added, enhancing the spatial presence of vocals in chorus use-cases.
   • In RemoteAudioStats, a new e2eDelay field is added to report the delay from when the audio is captured on the sending end to when the audio is played on the receiving end.

Issues fixed

This version fixed the following issues:

• When a user plugged and unplugged a Bluetooth or wired headset once, the audio state change callback onAudioDeviceStateChanged was triggered multiple times.
• During interactions, when a local user set the system default playback device to speakers using setDevice, there was no sound from the remote end.

API changes

Added

• registerFaceInfoObserver
• IFaceInfoObserver
• onFaceInfo
• MEDIA_SOURCE_TYPE adds SPEECH_DRIVEN_VIDEO_SOURCE
• VIDEO_SOURCE_TYPE adds VIDEO_SOURCE_SPEECH_DRIVEN
• EncryptionConfig adds datastreamEncryptionEnabled
• ENCRYPTION_ERROR_TYPE adds the following enumerations:
  • ENCRYPTION_ERROR_DATASTREAM_DECRYPTION_FAILURE
  • ENCRYPTION_ERROR_DATASTREAM_ENCRYPTION_FAILURE
• RemoteAudioStats adds e2eDelay
• ERROR_CODE_TYPE adds ERR_DATASTREAM_DECRYPTION_FAILED
• AUDIO_EFFECT_PRESET adds ROOM_ACOUSTICS_CHORUS, enhancing the spatial presence of vocals in chorus use-cases.
• getCallIdEx
• enableEncryptionEx
• setAudioMixingPlaybackSpeed
• EAR_MONITORING_FILTER_TYPE adds a new enumeration EAR_MONITORING_FILTER_BUILT_IN_AUDIO_FILTERS

v4.3.0

v4.3.0 was released on February 22, 2024.

Compatibility changes

This release has optimized the implementation of some functions, involving renaming or deletion of some APIs. To ensure the normal operation of the project, you need to update the code in the app after upgrading to this release.

1. Renaming parameters in callbacks

   In order to make the parameters in some callbacks and the naming of enumerations in enumeration classes easier to understand, the following modifications have been made in this release. Please modify the parameter settings in the callbacks after upgrading to this release.

   Callback	Original parameter name	New parameter name
   onLocalAudioStateChanged	error	reason
   onLocalVideoStateChanged	error	reason
   onDirectCdnStreamingStateChanged	error	reason
   onPlayerSourceStateChanged	ec	reason
   onRtmpStreamingStateChanged	errCode	reason

   Original enumeration class	New enumeration class
   LOCAL_AUDIO_STREAM_ERROR	LOCAL_AUDIO_STREAM_REASON
   LOCAL_VIDEO_STREAM_ERROR	LOCAL_VIDEO_STREAM_REASON
   DIRECT_CDN_STREAMING_ERROR	DIRECT_CDN_STREAMING_REASON
   MEDIA_PLAYER_ERROR	MEDIA_PLAYER_REASON
   RTMP_STREAM_PUBLISH_ERROR	RTMP_STREAM_PUBLISH_REASON

   Note: For specific renaming of enumerations, please refer to API changes.

2. Channel media relay

   To improve interface usability, this release removes some methods and callbacks for channel media relay. Use the alternative options listed in the table below:

   Deleted methods and callbacks	Alternative methods and callbacks
   startChannelMediaRelay updateChannelMediaRelay	startOrUpdateChannelMediaRelay
   startChannelMediaRelayEx updateChannelMediaRelayEx	startOrUpdateChannelMediaRelayEx
   onChannelMediaRelayEvent	onChannelMediaRelayStateChanged

3. Audio loopback capturing

   • Before v4.3.0, if you call the disableAudio method to disable the audio module, audio loopback capturing will not be disabled.

   • As of v4.3.0, if you call the disableAudio method to disable the audio module, audio loopback capturing will be disabled as well. If you need to enable audio loopback capturing, you need to enable the audio module by calling the enableAudio method and then call enableLoopbackRecording.

4. Log encryption behavior changes

   For security and performance reasons, as of this release, the SDK encrypts logs and no longer supports printing plaintext logs via the console.

   Refer to the following solutions for different needs:

   • If you need to know the API call status, please check the API logs and print the SDK callback logs yourself.
   • For any other special requirements, please contact technical support and provide the corresponding encrypted logs.

New features

1. Query Device Score

   This release adds the queryDeviceScore method to query the device's score level to ensure that the user-set parameters do not exceed the device's capabilities. For example, in HD or UHD video use-cases, you can first call this method to query the device's score. If the returned score is low (for example, below 60), you need to lower the video resolution to avoid affecting the video experience. The minimum device score required for different business use-cases is varied. For specific score recommendations, please contact technical support.

2. Select different audio tracks for local playback and streaming

   This release introduces the selectMultiAudioTrack method that allows you to select different audio tracks for local playback and streaming to remote users. For example, in use-cases like online karaoke, the host can choose to play the original sound locally and publish the accompaniment in the channel. Before using this function, you need to open the media file through the openWithMediaSource method and enable this function by setting the enableMultiAudioTrack parameter in MediaSource.

3. Others

   This release has passed the test verification of the following APIs and can be applied to the entire series of RTC 4.x SDK.

   • onRemoteSubscribeFallbackToAudioOnly: Occurs when the subscribed video stream falls back to audio-only stream due to weak network conditions or switches back to the video stream after the network conditions improve.
   • setPlaybackDeviceVolume: Sets the volume of the audio playback device.
   • getRecordingDeviceVolume: Sets the volume of the audio capturing device.
   • setPlayerOption: Sets media player options for providing technical previews or special customization features.
   • enableCustomAudioLocalPlayback: Sets whether to enable the local playback of external audio source.

Improvements

1. SDK task processing scheduling optimization

   This release optimizes the scheduling mechanism for internal tasks within the SDK, with improvements in the following aspects:

   • The speed of video rendering and audio playback for both remote and local first frames improves by 10% to 20%.
   • The API call duration and response time are reduced by 5% to 50%.
   • The SDK's parallel processing capability significantly improves, delivering higher video quality (720P, 24 fps) even on lower-end devices. Additionally, image processing remains more stable in use-cases involving high resolutions and frame rates.
   • The stability of the SDK is further enhanced, leading to a noticeable decrease in the crash rate across various specific use-cases.

2. In-ear monitoring volume boost

   This release provides users with more flexible in-ear monitoring audio adjustment options, supporting the ability to set the in-ear monitoring volume to four times the original volume by calling setInEarMonitoringVolume.

3. Spatial audio effects usability improvement

   • This release optimizes the design of the setZones method, supporting the ability to set the zones parameter to NULL, indicating the clearing of all echo cancellation zones.
   • As of this release, it is no longer necessary to unsubscribe from the audio streams of all remote users within the channel before calling the methods in ILocalSpatialAudioEngine class.

4. Other Improvements

   This release also includes the following improvements:

   • This release optimizes the SDK's domain name resolution strategy, improving the stability of calling to resolve domain names in complex network environments.
   • When passing in an image with transparent background as the virtual background image, the transparent background can be filled with customized color.
   • This release adds the earMonitorDelay and aecEstimatedDelay members in LocalAudioStats to report ear monitor delay and acoustic echo cancellation (AEC) delay, respectively.
   • The onPlayerCacheStats callback is added to report the statistics of the media file being cached. This callback is triggered once per second after file caching is started.
   • The onPlayerPlaybackStats callback is added to report the statistics of the media file being played. This callback is triggered once per second after the media file starts playing. You can obtain information like the audio and video bitrate of the media file through PlayerPlaybackStats.

Issues fixed

This release fixed the following issue:

• The SDK failed to detect any changes in the audio routing after plugging in and out 3.5mm earphones.

API changes

Added

• enableCustomAudioLocalPlayback
• queryDeviceScore
• The CUSTOM_VIDEO_SOURCE enumeration in MEDIA_SOURCE_TYPE
• The ROUTE_BLUETOOTH_DEVICE_A2DP enumeration in AudioRoute
• selectMultiAudioTrack
• onPlayerCacheStats
• onPlayerPlaybackStats
• PlayerPlaybackStats

Modified

• All ERROR fields in the following enumerations are changed to REASON:
  • LOCAL_AUDIO_STREAM_ERROR_OK
  • LOCAL_AUDIO_STREAM_ERROR_FAILURE
  • LOCAL_AUDIO_STREAM_ERROR_DEVICE_NO_PERMISSION
  • LOCAL_AUDIO_STREAM_ERROR_DEVICE_BUSY
  • LOCAL_AUDIO_STREAM_ERROR_RECORD_FAILURE
  • LOCAL_AUDIO_STREAM_ERROR_ENCODE_FAILURE
  • LOCAL_AUDIO_STREAM_ERROR_RECORD_INVALID_ID
  • LOCAL_AUDIO_STREAM_ERROR_PLAYOUT_INVALID_ID
  • LOCAL_VIDEO_STREAM_ERROR_OK
  • LOCAL_VIDEO_STREAM_ERROR_FAILURE
  • LOCAL_VIDEO_STREAM_ERROR_DEVICE_NO_PERMISSION
  • LOCAL_VIDEO_STREAM_ERROR_DEVICE_BUSY
  • LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE
  • LOCAL_VIDEO_STREAM_ERROR_CODEC_NOT_SUPPORT
  • LOCAL_VIDEO_STREAM_ERROR_DEVICE_NOT_FOUND
  • LOCAL_VIDEO_STREAM_ERROR_DEVICE_DISCONNECTED
  • LOCAL_VIDEO_STREAM_ERROR_DEVICE_INVALID_ID
  • LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_MINIMIZED
  • LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_CLOSED
  • LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_OCCLUDED
  • LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_NO_PERMISSION
  • LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_PAUSED
  • LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_RESUMED
  • LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_HIDDEN
  • LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_HIDDEN
  • LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_MINIMIZED
  • LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_FAILURE
  • LOCAL_VIDEO_STREAM_ERROR_DEVICE_SYSTEM_PRESSURE
  • DIRECT_CDN_STREAMING_ERROR_OK
  • DIRECT_CDN_STREAMING_ERROR_FAILED
  • DIRECT_CDN_STREAMING_ERROR_AUDIO_PUBLICATION
  • DIRECT_CDN_STREAMING_ERROR_VIDEO_PUBLICATION
  • DIRECT_CDN_STREAMING_ERROR_NET_CONNECT
  • DIRECT_CDN_STREAMING_ERROR_BAD_NAME
  • PLAYER_ERROR_NONE
  • PLAYER_ERROR_INVALID_ARGUMENTS
  • PLAYER_ERROR_INTERNAL
  • PLAYER_ERROR_NO_RESOURCE
  • PLAYER_ERROR_INVALID_MEDIA_SOURCE
  • PLAYER_ERROR_UNKNOWN_STREAM_TYPE
  • PLAYER_ERROR_OBJ_NOT_INITIALIZED
  • PLAYER_ERROR_CODEC_NOT_SUPPORTED
  • PLAYER_ERROR_VIDEO_RENDER_FAILED
  • PLAYER_ERROR_INVALID_STATE
  • PLAYER_ERROR_URL_NOT_FOUND
  • PLAYER_ERROR_INVALID_CONNECTION_STATE
  • PLAYER_ERROR_SRC_BUFFER_UNDERFLOW
  • PLAYER_ERROR_INTERRUPTED
  • PLAYER_ERROR_NOT_SUPPORTED
  • PLAYER_ERROR_TOKEN_EXPIRED
  • PLAYER_ERROR_UNKNOWN
  • RTMP_STREAM_PUBLISH_ERROR_OK
  • RTMP_STREAM_PUBLISH_ERROR_INVALID_ARGUMENT
  • RTMP_STREAM_PUBLISH_ERROR_ENCRYPTED_STREAM_NOT_ALLOWED
  • RTMP_STREAM_PUBLISH_ERROR_CONNECTION_TIMEOUT
  • RTMP_STREAM_PUBLISH_ERROR_INTERNAL_SERVER_ERROR
  • RTMP_STREAM_PUBLISH_ERROR_RTMP_SERVER_ERROR
  • RTMP_STREAM_PUBLISH_ERROR_TOO_OFTEN
  • RTMP_STREAM_PUBLISH_ERROR_REACH_LIMIT
  • RTMP_STREAM_PUBLISH_ERROR_NOT_AUTHORIZED
  • RTMP_STREAM_PUBLISH_ERROR_STREAM_NOT_FOUND
  • RTMP_STREAM_PUBLISH_ERROR_FORMAT_NOT_SUPPORTED
  • RTMP_STREAM_PUBLISH_ERROR_NOT_BROADCASTER
  • RTMP_STREAM_PUBLISH_ERROR_TRANSCODING_NO_MIX_STREAM
  • RTMP_STREAM_PUBLISH_ERROR_NET_DOWN
  • RTMP_STREAM_PUBLISH_ERROR_INVALID_PRIVILEGE
  • RTMP_STREAM_UNPUBLISH_ERROR_OK

Deleted

• startChannelMediaRelay
• updateChannelMediaRelay
• startChannelMediaRelayEx
• updateChannelMediaRelayEx
• onChannelMediaRelayEvent
• CHANNEL_MEDIA_RELAY_EVENT

v4.2.6

v4.2.6 was released on November 17, 2023.

Issues fixed

This release fixed the following issue:

• In specific use-cases, such as when the network packet loss rate was high or when the broadcaster left the channel without destroying the engine and then re-joined the channel, the video on the receiving end stuttered or froze.

v4.2.3

v4.2.3 was released on October 11, 2023.

New features

1. ID3D11Texture2D Rendering

   As of this release, the SDK supports video formats of type ID3D11Texture2D, improving the rendering effect of video frames in game use-cases. You can set format to VIDEO_TEXTURE_ID3D11TEXTURE2D when pushing external raw video frames to the SDK by calling pushVideoFrame. By setting the d3d11_texture_2d and texture_slice_index properties, you can determine the ID3D11Texture2D texture object to use.

2. Local video status error code update

   In order to help users understand the exact reasons for local video errors in screen sharing use-cases, the following sets of enumerations have been added to the onLocalVideoStateChanged callback:

   • LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_PAUSED(23): Screen capture has been paused. Common use-cases for reporting this error code: The current screen may have been switched to a secure desktop, such as a UAC dialog box or Winlogon desktop.
   • LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_RESUMED(24): Screen capture has resumed from the paused state.
   • LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_HIDDEN(25): The window being captured on the current screen is in a hidden state and is not visible on the current screen.
   • LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_HIDDEN(26): The window for screen capture has been restored from the hidden state.
   • LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_MINIMIZED(27): The window for screen capture has been restored from the minimized state.

Improvements

Other Improvements

This release includes the following additional improvements:

• Optimizes the logic of handling invalid parameters. When you call the setPlaybackSpeed method to set the playback speed of audio files, if you pass an invalid parameter, the SDK returns the error code -2, which means that you need to reset the parameter.
• Optimizes the logic of Token parsing, in order to prevent an app from crash when an invalid token is passed in.

Issues fixed

This release fixed the following issues:

• Occasional crashes and dropped frames occurred in screen sharing use-cases.
• Occasional failure of joining a channel when the local system time was not set correctly.
• When calling the playEffect method to play two audio files using the same soundId, the first audio file was sometimes played repeatedly.

API changes

Added

• serverConfig in ContentInspectConfig
• isFeatureAvailableOnDevice
• FeatureType

v4.2.2

v4.2.2 was released on july 27, 2023.

New features

1. Wildcard token

   This release introduces wildcard tokens. Agora supports setting the channel name used for generating a token as a wildcard character. The token generated can be used to join any channel if you use the same user id. In use-cases involving multiple channels, such as switching between different channels, using a wildcard token can avoid repeated application of tokens every time users joining a new channel, which reduces the pressure on your token server. See Deploy a token server.

   All 4.x SDKs support using wildcard tokens.

2. Preloading channels

   This release adds preloadChannel[1/2] and preloadChannel[2/2] methods, which allows a user whose role is set as audience to preload channels before joining one. Calling the method can help shortening the time of joining a channel, thus reducing the time it takes for audience members to hear and see the host.

   When preloading more than one channels, Agora recommends that you use a wildcard token for preloading to avoid repeated application of tokens every time you joining a new channel, thus saving the time for switching between channels. See Deploy a token server.

Improvements

Channel media relay

The number of target channels for media relay has been increased to 6. When calling startOrUpdateChannelMediaRelay and startOrUpdateChannelMediaRelayEx, you can specify up to 6 target channels.

Issues fixed

This release fixed the following issues:

• Slow channel reconnection after the connection was interrupted due to network reasons.
• In multi-device audio recording use-cases, after repeatedly plugging and unplugging or enabling/disabling the audio recording device, no sound could be heard occasionally when calling the startRecordingDeviceTest to start an audio capturing device test.

API changes

Added

• preloadChannel[1/2]
• preloadChannel[2/2]
• updatePreloadChannelToken

v4.2.1

This version was released on June 21, 2023.

Improvements

This version improves the network transmission strategy, enhancing the smoothness of audio interactions.

Fixed Issues

This version fixed the following issues:

• Inability to join channels caused by SDK's incompatibility with some older versions of AccessToken.
• After the sending end called setAINSMode to activate AI noise reduction, occasional echo was observed by the receiving end.
• Brief noise occurred while playing media files using the media player.

v4.2.0

v4.2.0 was released on May 24, 2023.

Compatibility changes

If you use the features mentioned in this section, ensure that you modify the implementation of the relevant features after upgrading the SDK.

1. Channel media options

• publishCustomAudioTrackEnableAec in ChannelMediaOptions is deleted. Use publishCustomAudioTrack instead.
• publishCustomAudioSourceId in ChannelMediaOptions is renamed to publishCustomAudioTrackId.

2. Miscellaneous

• onApiCallExecuted is deleted. Agora recommends getting the results of the API implementation through relevant channels and media callbacks.
• The IAudioFrameObserver class is renamed to IAudioPcmFrameSink, thus the prototype of the following methods are updated accordingly:
  • onFrame
  • registerAudioFrameObserver [1/2] and registerAudioFrameObserver[2/2] in IMediaPlayer
• enableDualStreamMode[1/2] and enableDualStreamMode[2/2] are depredated. Use setDualStreamMode[1/2] and setDualStreamMode[2/2] instead.
• startChannelMediaRelay, updateChannelMediaRelay, startChannelMediaRelayEx and updateChannelMediaRelayEx are deprecated. Use startOrUpdateChannelMediaRelay and startOrUpdateChannelMediaRelayEx instead.

New features

1. AI Noise Suppression

This release introduces public APIs for the AI Noise Suppression function. Once enabled, the SDK automatically detects and reduces background noises. Whether in bustling public venues or real-time competitive arenas that demand lightning-fast responsiveness, this function guarantees optimal audio clarity, providing users with an elevated audio experience. You can enable this function through the newly-introduced setAINSMode method and set the noise reduction mode as balance, aggressive, or low latency according to your use-case.

2. Cross-device synchronization

In real-time collaborative singing use-cases, network issues can cause inconsistencies in the downlinks of different client devices. To address this, this release introduces getNtpWallTimeInMs for obtaining the current Network Time Protocol (NTP) time. By using this method to synchronize lyrics and music across multiple client devices, users can achieve synchronized singing and lyrics progression, resulting in a better collaborative experience.

Improvements

1. Voice changer

This release introduces the setLocalVoiceFormant method that allows you to adjust the formant ratio to change the timbre of the voice. This method can be used together with the setLocalVoicePitch method to adjust the pitch and timbre of voice at the same time, enabling a wider range of voice transformation effects.

2. Channel media relay

This release introduces startOrUpdateChannelMediaRelay and startOrUpdateChannelMediaRelayEx, allowing for a simpler and smoother way to start and update media relay across channels. With these methods, developers can easily start the media relay across channels and update the target channels for media relay with a single method. Additionally, the internal interaction frequency has been optimized, effectively reducing latency in function calls.

3. Custom audio tracks

To better meet the needs of custom audio capture use-cases, this release adds createCustomAudioTrack and destroyCustomAudioTrack for creating and destroying custom audio tracks. Two types of audio tracks are also provided for users to choose from, further improving the flexibility of capturing external audio source:

• Mixable audio track: Supports mixing multiple external audio sources and publishing them to the same channel, suitable for multi-channel audio capture use-cases.
• Direct audio track: Only supports publishing one external audio source to a single channel, suitable for low-latency audio capture use-cases.

Issues fixed

This release fixed the issue that when the host frequently switched the user role between broadcaster and audience in a short period of time, the audience members could not hear the audio of the host.

API changes

Added

• startOrUpdateChannelMediaRelay
• startOrUpdateChannelMediaRelayEx
• getNtpWallTimeInMs
• setAINSMode
• createAudioCustomTrack
• destroyAudioCustomTrack
• AudioTrackConfig
• AUDIO_TRACK_TYPE
• The domainLimit and autoRegisterAgoraExtensions members in RtcEngineContext

Deprecated

• startChannelMediaRelay
• startChannelMediaRelayEx
• updateChannelMediaRelay
• updateChannelMediaRelayEx
• onChannelMediaRelayEvent
• CHANNEL_MEDIA_RELAY_EVENT

Deleted

• onApiCallExecuted
• publishCustomAudioTrackEnableAec in ChannelMediaOptions

v4.1.1

v4.1.1 was released on February 8, 2023.

New features

Instant frame rendering

This release adds the enableInstantMediaRendering method to enable instant rendering mode for audio frames, which can speed up the first audio frame rendering after the user joins the channel.

Issues fixed

This release fixed the issue that playing audio files with a sample rate of 48 kHz failed.

API changes

Added

enableInstantMediaRendering

v4.1.0

v4.1.0 was released on December 15, 2022.

New features

1. Headphone equalization effect

This release adds the setHeadphoneEQParameters method, which is used to adjust the low- and high-frequency parameters of the headphone EQ. This mainly useful in spatial audio use-cases. If you cannot achieve the expected headphone EQ effect after calling setHeadphoneEQPreset, you can call setHeadphoneEQParameters to adjust the EQ.

2. MPUDP (MultiPath UDP) (Beta)

As of this release, the SDK supports MPUDP protocol, which enables you to connect and use multiple paths to maximize the use of channel resources based on the UDP protocol. You can use different physical NICs on both mobile and desktop and aggregate them to effectively combat network jitter and improve transmission quality.

To enable this feature, contact support@agora.io.

3. Register extensions

This release adds the registerExtension method for registering extensions. When using a third-party extension, you need to call the extension-related APIs in the following order:

loadExtensionProvider -> registerExtension -> setExtensionProviderProperty -> enableExtension

4. Device management

This release adds a series of callbacks to help you better understand the status of your audio devices:

• onAudioDeviceStateChanged: Occurs when the status of the audio device changes.
• onAudioDeviceVolumeChanged: Occurs when the volume of an audio device or app changes.

5. Multi-channel management

This release adds a series of multi-channel related methods that you can call to manage audio streams in multi-channel use-cases.

• The muteLocalAudioStreamEx method is used to cancel or resume publishing a local audio streams.
• The muteAllRemoteAudioStreamsEx is used to cancel or resume the subscription of all remote users to audio streams.
• The startRtmpStreamWithoutTranscodingEx, startRtmpStreamWithTranscodingEx, updateRtmpTranscodingEx, and stopRtmpStreamEx methods are used to implement Media Push in multi-channel use-cases.
• The startChannelMediaRelayEx, updateChannelMediaRelayEx, pauseAllChannelMediaRelayEx, resumeAllChannelMediaRelayEx, and stopChannelMediaRelayEx methods are used to relay media streams across channels in multi-channel use-cases.
• Adds the leaveChannelEx [2/2] method. Compared with the leaveChannelEx [1/2] method, a new options parameter is added, which is used to choose whether to stop recording with the microphone when leaving a channel in a multi-channel use-case.

6. Client role switching

In order to enable users to know whether the switched user role is low-latency or ultra-low-latency, this release adds the newRoleOptions parameter to the onClientRoleChanged callback. The value of this parameter is as follows:

• AUDIENCE_LATENCY_LEVEL_LOW_LATENCY (1): Low latency.
• AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY (2): Ultra-low latency.

Improvements

1. Relaying media streams across channels

This release optimizes the updateChannelMediaRelay method as follows:

• Before v4.1.0: If the target channel update fails due to internal reasons in the server, the SDK returns the error code RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_REFUSED(8), and you need to call the updateChannelMediaRelay method again.
• v4.1.0 and later: If the target channel update fails due to internal server reasons, the SDK retries the update until the target channel update is successful.

2. Reconstructed AIAEC algorithm

This release reconstructs the AEC algorithm based on the AI method. Compared with the traditional AEC algorithm, the new algorithm can preserve the complete, clear, and smooth near-end vocals under poor echo-to-signal conditions, significantly improving the system's echo cancellation and dual-talk performance. This gives users a more comfortable call and live-broadcast experience. AIAEC is suitable for conference calls, chats, karaoke, and other use-cases.

Other improvements

This release includes the following additional improvements:

• Reduces the latency when pushing external audio sources.
• Improves the performance of echo cancellation when using the AUDIO_SCENARIO_MEETING scenario.
• Enhances the ability to identify different network protocol stacks and improves the SDK's access capabilities in multiple-operator network scenarios.

Issues fixed

This release fixed the following issues:

• The uplink network quality reported by the onNetworkQuality callback was inaccurate for the user who was sharing a screen.
• The call getExtensionProperty failed and returned an empty string.

API changes

Added

• setHeadphoneEQParameters

• leaveChannelEx [2/2]

• muteLocalAudioStreamEx

• muteAllRemoteAudioStreamsEx

• startRtmpStreamWithoutTranscodingEx

• startRtmpStreamWithTranscodingEx

• updateRtmpTranscodingEx

• stopRtmpStreamEx

• startChannelMediaRelayEx

• updateChannelMediaRelayEx

• pauseAllChannelMediaRelayEx

• resumeAllChannelMediaRelayEx

• stopChannelMediaRelayEx

• newRoleOptions in onClientRoleChanged

• adjustUserPlaybackSignalVolumeEx

• onAudioDeviceStateChanged

• onAudioDeviceVolumeChanged

Deprecated

• onApiCallExecuted. Use the callbacks triggered by specific methods instead.

Deleted

• Removes RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_REFUSED(8) in onChannelMediaRelayEvent callback

v4.0.1

v4.0.1 was released on September 29, 2022.

New features

1. In-ear monitoring

This release adds support for in-ear monitoring. You can call enableInEarMonitoring to enable the in-ear monitoring function.

After successfully enabling the in-ear monitoring function, you can call registerAudioFrameObserver to register the audio observer, and the SDK triggers the onEarMonitoringAudioFrame callback to report the audio frame data. You can use your own audio effect processing module to pre-process the audio frame data of the in-ear monitoring to implement custom audio effects. Agora recommends that you choose one of the following two methods to set the audio data format of the in-ear monitoring:

• Call the setEarMonitoringAudioFrameParameters method to set the audio data format of in-ear monitoring. The SDK calculates the sampling interval based on the parameters in this method, and triggers the onEarMonitoringAudioFrame callback based on the sampling interval.
• Set the audio data format in the return value of the getEarMonitoringAudioParams callback. The SDK calculates the sampling interval based on the return value of the callback, and triggers the onEarMonitoringAudioFrame callback based on the sampling interval.

To adjust the in-ear monitoring volume, you can call setInEarMonitoringVolume.

2. Local network connection types

To make it easier for users to know the connection type of the local network at any stage, this release adds the getNetworkType method. You can use this method to get the type of network connection in use, including UNKNOWN, DISCONNECTED, LAN, WIFI, 2G, 3G, 4G, 5G. When the local network connection type changes, the SDK triggers the onNetworkTypeChanged callback to report the current network connection type.

3. Audio stream filter

This release introduces filtering audio streams based on volume. Once this function is enabled, the Agora server ranks all audio streams by volume and transports 3 audio streams with the highest volumes to the receivers by default. The number of audio streams to be transported can be adjusted; you can contact support@agora.io to adjust this number according to your use-case.

Meanwhile, Agora supports publishers to choose whether or not the audio streams being published are to be filtered based on volume. Streams that are not filtered will bypass this filter mechanism and transported directly to the receivers. In use-cases where there are a number of publishers, enabling this function helps reducing the bandwidth and device system pressure for the receivers.

4. Loopback device

The SDK uses the playback device as the loopback device by default. Since v4.0.1, you can specify a loopback device separately and publish the captured audio to the remote end.

• setLoopbackDevice：Specifies the loopback device. If you do not want the current playback device to be the loopback device, you can call this method to specify another device as the loopback device.
• getLoopbackDevice：Gets the current loopback device.
• followSystemLoopbackDevice：Whether the loopback device follows the default playback device of the system.

5. Spatial audio effect

This release adds the following features applicable to spatial audio effect use-cases, which can effectively enhance the user's sense of presence experience in virtual interactive scenarios.

• Sound insulation area: You can set a sound insulation area and sound attenuation parameter by calling setZones. When the sound source (which can be a user or the media player) and the listener belong to the inside and outside of the sound insulation area, the listener experiences an attenuation effect similar to that of the sound in the real environment when it encounters a building partition. You can also set the sound attenuation parameter for the media player and the user, respectively, by calling setPlayerAttenuation and setRemoteAudioAttenuation, and specify whether to use that setting to force an override of the sound attenuation parameter in setZones.
• Doppler sound: You can enable Doppler sound by setting the enable_doppler parameter in SpatialAudioParams, and the receiver experiences noticeable tonal changes in the event of a high-speed relative displacement between the source and receiver (such as in a racing game use-case).
• Headphone equalizer: You can use a preset headphone equalization effect by calling the setHeadphoneEQPreset method to improve the hearing of the headphones.

API changes

Added

• enableInEarMonitoring
• setEarMonitoringAudioFrameParameters
• onEarMonitoringAudioFrame
• setInEarMonitoringVolume
• getEarMonitoringAudioParams
• getNetworkType
• setRecordingDeviceVolume
• isAudioFilterable in the ChannelMediaOptions
• setLoopbackDevice
• getLoopbackDevice
• followSystemLoopbackDevice
• setZones
• setPlayerAttenuation
• setRemoteAudioAttenuation
• muteRemoteAudioStream
• SpatialAudioParams
• setHeadphoneEQPreset
• HEADPHONE_EQUALIZER_PRESET

Deprecated

• startEchoTest [2/3]

v4.0.0

v4.0.0 was released on September 15, 2022.

Compatibility changes

Integration change

This release has optimized the implementation of some features, resulting in incompatibility with v3.7.x. The following are the main features with compatibility changes:

• Multiple channel
• Media stream publishing control
• Warning codes

After upgrading the SDK, you need to update the code in your app according to your business use-cases. For details, see Migrate from v3.7.x to v4.0.0.

New features

1. Multiple media tracks

This release supports one IRtcEngine instance to collect multiple audio and video sources at the same time and publish them to the remote users by setting RtcEngineEx and ChannelMediaOptions.

• After calling joinChannel to join the first channel, call joinChannelEx multiple times to join multiple channels, and publish the specified stream to different channels through different user ID (localUid) and ChannelMediaOptions settings.

You can also experience the following features with the multi-channel capability:

• Publish multiple sets of audio and video streams to the remote users through different user IDs (uid).
• Mix multiple audio streams and publish to the remote users through a user ID (uid).

2. Build-in media player

To make it easier for users to integrate the Agora SDK and reduce the SDK's package size, this release introduces the Agora media player. After calling the createMediaPlayer method to create a media player object, you can then call the methods in the IMediaPlayer class to experience a series of functions, such as playing local and online media files, preloading a media file, changing the CDN route for playing according to your network conditions, or sharing the audio and video streams being played with remote users.

3.Brand-new AI Noise Suppression

The SDK supports a new version of AI noise reduction (in comparison to the basic AI noise reduction in v3.7.x). The new AI noise reduction has better vocal fidelity, cleaner noise suppression, and adds a dereverberation option.

4. Ultra-high audio quality

To make the audio clearer and restore more details, this release adds the ULTRA_HIGH_QUALITY_VOICE enumeration. In use-cases that mainly feature the human voice, such as chat or singing, you can call setVoiceBeautifierPreset and use this enumeration to experience ultra-high audio quality.

5. Spatial audio

You can set the spatial audio for the remote user as following:

• Local Cartesian Coordinate System Calculation: This solution uses the ILocalSpatialAudioEngine class to implement spatial audio by calculating the spatial coordinates of the remote user. You need to call updateSelfPosition and updateRemotePosition to update the spatial coordinates of the local and remote users, respectively, so that the local user can hear the spatial audio effect of the remote user.

You can also set the spatial audio for the media player as following:

• Local Cartesian Coordinate System Calculation: This solution uses the ILocalSpatialAudioEngine class to implement spatial audio. You need to call updateSelfPosition and updatePlayerPositionInfo to update the spatial coordinates of the local user and media player, respectively, so that the local user can hear the spatial audio effect of media player.

6. Real-time chorus

This release gives real-time chorus the following abilities:

• Two or more choruses are supported.
• Each singer is independent of each other. If one singer fails or quits the chorus, the other singers can continue to sing.
• Very low latency experience. Each singer can hear each other in real time, and the audience can also hear each singer in real time.

This release adds the AUDIO_SCENARIO_CHORUS enumeration in AUDIO_SCENARIO_TYPE. With this enumeration, users can experience ultra-low latency in real-time chorus when the network conditions are good.

7. Extensions from the Agora extensions marketplace

In order to enhance the real-time audio and video interactive activities based on the Agora SDK, this release supports the one-stop solution for the extensions from the Agora extensions marketplace:

• Easy to integrate: The integration of modular functions can be achieved simply by calling an API, and the integration efficiency is improved by nearly 95%.
• Extensibility design: The modular and extensible SDK design style endows the Agora SDK with good extensibility, which enables developers to quickly build real-time interactive apps based on the Agora extensions marketplace ecosystem.
• Build an ecosystem: A community of real-time audio and video apps has developed that can accommodate a wide range of developers, offering a variety of extension combinations. After integrating the extensions, developers can build richer real-time interactive functions. For details, see Use an Extension.
• Become a vendor: Vendors can integrate their products with Agora SDK in the form of extensions, display and publish them in the Agora extensions marketplace, and build a real-time interactive ecosystem for developers together with Agora. For details on how to develop and publish extensions, see Become a Vendor.

8. Enhanced channel management

To meet the channel management requirements of various business use-cases, this release adds the following functions to the ChannelMediaOptions structure:

• Sets or switches the publishing of multiple audio sources.
• Sets or switches channel profile and user role.
• Controls audio publishing delay.

Set ChannelMediaOptions when calling joinChannel or joinChannelEx to specify the publishing and subscription behavior of a media stream, for example, whether to publish video streams captured by cameras or screen sharing, and whether to subscribe to the audio and video streams of remote users. After joining the channel, call updateChannelMediaOptions to update the settings in ChannelMediaOptions at any time, for example, to switch the published audio and video sources.

9. Subscription allowlists and blocklists

This release introduces subscription allowlists and blocklists for remote audio and video streams. You can add a user ID that you want to subscribe to in your whitelist, or add a user ID for the streams you do not wish to see to your blacklists. You can experience this feature through the following APIs, and in use-cases that involve multiple channels, you can call the following methods in the IRtcEngineEx interface:

• SetSubscribeAudioBlacklist：Set the audio subscription blocklist.
• SetSubscribeAudioWhitelist：Set the audio subscription allowlist.
• SetSubscribeVideoBlacklist：Set the video subscription blocklist.
• SetSubscribeVideoWhitelist：Set the video subscription allowlist.

If a user is added in a blacklist and a whitelist at the same time, only the blacklist takes effect.

10. Set audio scenarios

To make it easier to change audio scenarios, this release adds the SetAudioScenario method. For example, if you want to change the audio scenario from AUDIO_SCENARIO_DEFAULT to AUDIO_SCENARIO_GAME_STREAMING when you are in a channel, you can call this method.

Improvements

1. Fast channel switching

This release can achieve the same switching speed as SwitchChannel in v3.7.x through the LeaveChannel and JoinChannel methods so that you don't need to take the time to call the SwitchChannel method.

2. Voice pitch of the local user This release adds voicePitch in AudioVolumeInfo of onAudioVolumeIndication. You can use voicePitch to get the local user's voice pitch and perform business functions such as rating for singing.