android.permission.BLUETOOTH_CONNECT
permission to the AndroidManifest.xml
file of the Android project to enable the Bluetooth function of the Android system. v4.0.1 was released on September 29, 2022.
1. In-ear monitoring
This release adds the getEarMonitoringAudioParams
callback to set the audio data format of the in-ear monitoring. You can use your own audio effect processing module to preprocess the audio frame data of the in-ear monitoring to implement custom audio effects. After calling registerAudioFrameObserver
to register the audio observer, 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.
2. Audio capture device test
This release adds support for testing local audio capture devices before joining a channel. You can call startRecordingDeviceTest
to start the audio capture device test. After the test is complete, call the stopPlaybackDeviceTest
method to stop the audio capture device test.
3. 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. The available values are UNKNOWN, DISCONNECTED, LAN, WIFI, 2G, 3G, 4G, and 5G. When the local network connection type changes, the SDK triggers the onNetworkTypeChanged
callback to report the current network connection type.
4. 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 scenarios.
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 scenarios where there are a number of publishers, enabling this function helps reducing the bandwidth and device system pressure for the receivers.
To enable this function, contact support@agora.io.
5. Spatial audio effect
This release adds the following features applicable to spatial audio effect scenarios, which can effectively enhance the user's sense-of-presence experience in virtual interactive scenarios.
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 by calling setPlayerAttenuation
and setRemoteAudioAttenuation
respectively, and specify whether to use that setting to force an override of the sound attenuation parameter in setZones
.enable_doppler
parameter in SpatialAudioParams
. The receiver experiences noticeable tonal changes in the event of a high-speed relative displacement between the source source and receiver (such as in a racing game scenario).setHeadphoneEQPreset
method to improve the audio experience for users with headphones.This release fixed the following issues.
setCloudProxy
to set the cloud proxy, calling joinChannelEx
to join multiple channels failed.Added
getEarMonitoringAudioParams
stopRecordingDeviceTest
stopRecordingDeviceTest
getNetworkType
isAudioFilterable
in the ChannelMediaOptions
setZones
setPlayerAttenuation
setRemoteAudioAttenuation
muteRemoteAudioStream
SpatialAudioParams
setHeadphoneEQPreset
HEADPHONE_EQUALIZER_PRESET
Deprecated
startEchoTest
[2/3]v4.0.0 was released on September 15, 2022.
1. Integration change
This release has optimized the implementation of some features, resulting in incompatibility with v3.7.0. The following are the main features with compatibility changes:
After upgrading the SDK, you need to update the code in your app according to your business scenarios. For details, see Migrate from v3.7.0 to v4.0.0.
2. Callback exception handling
To facilitate troubleshooting, as of this release, the SDK no longer catches exceptions that are thrown by your own code implementation when triggering callbacks in the IRtcEngineEventHandler
class. You need to catch and handle the exceptions yourself; otherwise, it can cause a crash.
1. Multiple media tracks
This release supports one RtcEngine
instance to collect multiple audio 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:
uid
).uid
).2. Agora 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 streams being played with remote users.
3. Brand-new AI noise reduction
The SDK supports a new version of AI noise reduction (in comparison to the basic AI noise reduction in v3.7.0). The new AI noise reduction has better vocal fidelity, cleaner noise suppression, and adds a dereverberation option. To enable this feature, contact sales-us@agora.io.
4. Ultra-high audio quality
To make the audio clearer and restore more details, this release adds the ULTRA_HIGH_QUALITY_VOICE
enumeration. In scenarios 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
This feature is in experimental status. To enable this feature, contact sales-us@agora.io. Contact technical support if needed.
You can set the spatial audio for the remote user as following:
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:
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:
This release adds the AUDIO_SCENARIO_CHORUS
enumeration. 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 interactive activities based on the Agora SDK, this release supports the one-stop solution for the extensions from the Agora extensions marketplace:
8. Enhanced channel management
To meet the channel management requirements of various business scenarios, this release adds the following functions to the ChannelMediaOptions
structure:
Set ChannelMediaOptions
when calling joinChannel
or joinChannelEx
to specify the publishing and subscription behavior of a media stream, for example, whether to subscribe to the audio 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 sources.
9. Subscription allowlists and blocklists
This release introduces subscription allowlists and blocklists for remote audio streams. You can add a user ID that you want to subscribe to in your allowlist, or add a user ID for the streams you do not wish to see to your blocklists. You can experience this feature through the following APIs, and in scenarios that involve multiple channels, you can call the following methods in the RtcEngineEx
interface:
setSubscribeAudioBlacklist
:Set the audio subscription blocklist.setSubscribeAudioWhitelist
:Set the audio subscription allowlist.If a user is added in a blocklist and a allowlist at the same time, only the blocklist 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.
1. Fast channel switching
This release can achieve the same switching speed as switchChannel
in v3.7.0 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.
3. Device permission management
This release adds the onPermissionError
method, which is automatically reported when the audio capture device or camera does not obtain the appropriate permission. You can enable the corresponding device permission according to the prompt of the callback.