This page provides the release notes for the Agora Video SDK.
v3.3.0 was released on January 22, 2021.
1. Integration change
This release adds the following frameworks:
libagora-core.dll
: The Agora basic calculation framework. av1.dll
: The AV1 framework for screen sharing.To integrate the SDK into your project, see Integrate the SDK.
2. Behavior change
This release deprecates setDefaultMuteAllRemoteAudioStreams
and setDefaultMuteAllRemoteVideoStreams
and changes the behavior of mute
-related methods as follows:
mute
-related methods must be called after joining or switching to a channel; otherwise, the method call does not take effect.muteAll
are no longer the master switch, and each mute
-related method independently controls the user's subscribing state. When you call methods with the prefixes muteAll
and muteRemote
together, the method that is called later takes effect.muteAll
set whether to subscribe to the audio or video streams of all remote users, including all subsequent users, which means methods with the prefix muteAll
contain the function of methods with the prefix setDefaultMute
. Agora recommends not calling methods with the prefixes muteAll
and setDefaultMute
together; otherwise, the setting may not take effect.See details in Set the Subscribing State.
1. Channel media options
To help developers control media subscription more flexibly, this release adds the joinChannel
[2/2] and switchChannel
[2/2] methods to set whether users subscribe to all remote audio or video streams in a channel when joining and switching channels.
2. Cloud proxy
To improve the usability of the Agora Cloud Proxy, this release adds the setCloudProxy
method to set the cloud proxy and allows you to select a cloud proxy that uses the UDP protocol. For details, see Cloud Proxy.
3. Deep-learning noise reduction
To eliminate non-stationary noise based on traditional noise reduction, this release adds enableDeepLearningDenoise
to enable deep-learning noise reduction.
libagora_ai_denoise_extension.dll
dynamic library into your project files.4. Singing beautifier
To beautify the voice and add reverberation effects in a singing scenario, this release adds the setVoiceBeautifierParameters
method and adds the SINGING_BEAUTIFIER
enumeration value to VOICE_BEAUTIFIER_PRESET
.
You can call setVoiceBeautifierPreset(SINGING_BEAUTIFIER)
to beautify the male voice and add the reverberation effect for a voice in a small room. For more settings, you can call setVoiceBeautifierParameters
(SINGING_BEAUTIFIER
, param1
, param2
) to beautify male or female voices and add reverberation effects for a voice in a small room, large room, or hall.
5. Log files
To ensure the integrity of log content, this release adds the logConfig
member variable to RtcEngineContext
. You can use logConfig
to set the log files output by the Agora SDK when you initialize RtcEngine
. See How can I set the log file? for details.
As of v3.3.0, Agora does not recommend using the setLogFile
, setLogFileSize
, or setLogFilter
methods to set the log files.
6. Quality of captured video
To control the quality of video captured by the local camera, this release adds support for customizing the capture resolution and listening for abnormalities.
setCameraCapturerConfiguration
method to set the capture preference to MANUAL(3)
and set the width and height of the captured video image.captureBrightnessLevel
in the onLocalVideoStats
callback.onLocalVideoStateChanged(LOCAL_VIDEO_STREAM_STATE_FAILED, LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE)
callback.onLocalVideoStateChanged(LOCAL_VIDEO_STREAM_STATE_CAPTURING, LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE)
callback.7. Data streams
To support scenarios such as lyrics synchronization and courseware synchronization, this release deprecates the previous createDataStream
method and replaces it with a new method of the same name. You can use this new method to create a data stream and set whether to synchronize the data stream with the audio stream sent to the Agora channel and whether the received data is ordered.
1. Screen Sharing
As of v3.3.0, the SDK automatically enables DXGI (DirectX Graphics Infrastructure) to capture the screen as appropriate, which significantly increases the video frame rate and resolution supported by screen sharing.
2. Remote audio statistics
To monitor quality of experience (QoE) of the local user when receiving a remote audio stream, this release adds qoeQuality
and qualityChangedReason
to onRemoteAudioStats
, which report QoE of the local user and the reason for poor QoE, respectively.
This release fixed the following issues:
Added
setVoiceBeautifierParameters
SINGING_BEAUTIFIER
in the VOICE_BEAUTIFIER_PRESET
enumenableDeepLearningDenoise
joinChannel
[2/2]switchChannel
[2/2]createDataStream
logConfig
in the RtcEngineContext
structqoeQuality
and qualityChangedReason
in the RemoteAudioStats
structsetCloudProxy
captureBrightnessLevel
in the LocalVideoStats
structcaptureWidth
and captureHeight
in the CameraCapturerConfiguration
structCAPTURER_OUTPUT_PREFERENCE_MANUAL(3)
in the CAPTURER_OUTPUT_PREFERENCE
enumERR_MODULE_NOT_FOUND(157)
Deprecated
setDefaultMuteAllRemoteVideoStreams
setDefaultMuteAllRemoteAudioStreams
setLogFile
setLogFileSize
setLogFilter
createDataStream
v3.2.1 was released on December 17, 2020. This release fixed the following issues:
enableEncryption
, the SDK did not trigger the onFirstLocalVideoFramePublished
callback.v3.2.0 was released on November 30, 2020.
1. Integration change
Since v3.2.0, the following files have been added to the SDK package:
libagora-fdkaac.dll
: The Fraunhofer FDK AAC dynamic library.libagora-mpg123.dll
: The mpg123 dynamic library.libagora-soundtouch.dll
: The SoundTouch dynamic library.libagora-ffmpeg.dll
: The FFmpeg dynamic library.If you upgrade the SDK to v3.2.0 or later, ensure that you have copied the above files to the folder where the libagora-rtc-sdk.dll
file is located.
2. Cloud proxy
This release optimizes the Agora cloud proxy architecture. If you are already using cloud proxy, to avoid compatibility issues between the new SDK and the old cloud proxy, please contact support@agora.io before upgrading the SDK. See Cloud Proxy.
3. Security and compliance
Agora has passed ISO 27001, ISO 27017, and ISO 27018 international certifications, providing safe and reliable real-time interactive cloud services for users worldwide. See ISO Certificates.
This release supports transport layer encryption by adding TLS (Transport Layer Security) and UDP (User Datagram Protocol) encryption methods.
Interactive Live Streaming Standard
This release adds setClientRole
for setting the latency level of an audience member. You can use this method to switch between Interactive Live Streaming Premium and Interactive Live Streaming Standard as follows:
For details, see the product overview of Interactive Live Streaming Standard.
1. Meeting scenario
To improve the user experience in the meeting scenario, this release adds the following:
AUDIO_SCENARIO_MEETING(8)
in setAudioProfile
.LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_CLOSED(12)
error code, notifying you 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.CONTENT_HINT_DETAILS
type in a poor network environment.2. Voice beautifier and audio effects
To improve the usability of the APIs related to voice beautifier and audio effects, this release deprecates setLocalVoiceChanger
and setLocalVoiceReverbPreset
, and adds the following methods instead:
setVoiceBeautifierPreset
: Compared with setLocalVoiceChanger
, this method deletes audio effects such as a little boy’s voice and a more spatially resonant voice.setAudioEffectPreset
: Compared with setLocalVoiceReverbPreset
, this method adds audio effects such as the 3D voice, the pitch correction, a little boy’s voice and a more spatially resonant voice.setAudioEffectParameters
: This method sets detailed parameters for a specified audio effect. In this release, the supported audio effects are the 3D voice and pitch correction.3. Interactive streaming delay
This release reduces the latency on the audience's client during an interactive live streaming by about 500 ms.
Added
setAudioEffectPreset
setVoiceBeautifierPreset
setAudioEffectParameters
AUDIO_SCENARIO_MEETING(8)
in AUDIO_SCENARIO_TYPE
enum
LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_CLOSED(12)
in LOCAL_VIDEO_STREAM_ERROR
enum
setClientRole
Deprecated
setLocalVoiceChanger
setLocalVoiceReverbPreset
v3.1.2 was released on September 15, 2020.
This release fixed the issue that the trigger timing of the onFirstLocalVideoFrame
and onFirstRemoteVideoFrame
callbacks is not accurate.
v3.1.1 was released on August 28, 2020.
This release changes the AREA_CODE
for regional connection. The latest area codes are as follows:
AREA_CODE_CN
: Mainland China.AREA_CODE_NA
: North America.AREA_CODE_EU
: Europe.AREA_CODE_AS
: Asia, excluding Mainland China.AREA_CODE_JP
: Japan.AREA_CODE_IN
: India.AREA_CODE_GLOB
: (Default) Global.If you have specified a region for connection when calling initialize
, ensure that you use the latest area code when migrating from an earlier SDK version.
v3.1.0 was released on Aug 11, 2020.
1. Publishing and subscription states
This release adds the following callbacks to report the current publishing and subscribing states:
onAudioPublishStateChanged
: Reports the change of the audio publishing state.onVideoPublishStateChanged
: Reports the change of the video publishing state.onAudioSubscribeStateChanged
: Reports the change of the audio subscribing state.onVideoSubscribeStateChanged
: Reports the change of the video subscribing state.2. First local frame published callback
This release adds the onFirstLocalAudioFramePublished
and onFirstLocalVideoFramePublished
callbacks to report that the first audio or video frame is published. The onFirstLocalAudioFrame
callback is deprecated from v3.1.0.
3. Custom data report
This release adds the sendCustomReportMessage
method for reporting customized messages. To try out this function, contact support@agora.io and discuss the format of customized messages with us.
1. Regional connection
This release adds the following regions for regional connection. After you specify the region for connection, your app that integrates the Agora SDK connects to the Agora servers within that region.
AREA_CODE_JAPAN
: Japan.AREA_CODE_INDIA
: India.2. Advanced screen sharing
This release adds the following features for screen sharing:
windowFocus
member to the ScreenCaptureParameters
struct.excludeWindowList
member to the ScreenCaptureParameters
struct.LOCAL_VIDEO_STREAM_STATE_CAPTURING(1)
and the error code LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_MINIMIZED(11)
to the onLocalVideoStateChanged
callback.IVideoSource
class, which defines the custom video source.3. CDN live streaming
To improve the user experience in CDN live streaming, this release adds the onRtmpStreamingEvent
callback to report events during CDN live streaming, such as failure to add a background image or watermark image.
4. Encryption
This release adds the enableEncryption
method for enabling built-in encryption, and deprecates the following methods:
setEncryptionSecret
setEncryptionMode
5. More in-call statistics
This release adds the following attributes to provide more in-call statistics:
txPacketLossRate
in LocalAudioStats
, which represents the audio packet loss rate (%) from the local client to the Agora edge server before applying anti-packet loss strategies.LocalVideoStats
:txPacketLossRate
: The video packet loss rate (%) from the local client to the Agora edge server before applying anti-packet loss strategies.captureFrameRate
: The capture frame rate (fps) of the local video.publishDuration
in RemoteAudioStats
and RemoteVideoStats
, which represents the total publish duration (ms) of the remote media stream.6. Audio profile
To improve audio performance, this release adjusts the maximum audio bitrate of each audio profile as follows:
Profile | v3.1.0 | Earlier than v3.1.0 |
---|---|---|
AUDIO_PROFILE_DEFAULT |
||
AUDIO_PROFILE_SPEECH_STANDARD |
18 Kbps | 18 Kbps |
AUDIO_PROFILE_MUSIC_STANDARD |
64 Kbps | 48 Kbps |
AUDIO_PROFILE_MUSIC_STANDARD_STEREO |
80 Kbps | 56 Kbps |
AUDIO_PROFILE_MUSIC_HIGH_QUALITY |
96 Kbps | 128 Kbps |
AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO |
128 Kbps | 192 Kbps |
7. Log files
This release increases the default number of log files that the Agora SDK outputs from 2 to 5, and increases the default size of each log file from 512 KB to 1024 KB. By default, the SDK outputs five log files, agorasdk.log
, agorasdk_1.log
, agorasdk_2.log
, agorasdk_3.log
, agorasdk_4.log
. The SDK writes the latest logs in agorasdk.log
. When agorasdk.log
is full, the SDK deletes the log file with the earliest modification time among the other four, renames agorasdk.log
to the name of the deleted log file, and creates a new agorasdk.log
to record the latest logs.
8. Video experience under poor network conditions
This release fixed the occasional howling issue on some Huawei laptops.
Added
onAudioPublishStateChanged
onVideoPublishStateChanged
onAudioSubscribeStateChanged
onVideoSubscribeStateChanged
onFirstLocalAudioFramePublished
onFirstLocalVideoFramePublished
enableEncryption
txPacketLossRate
in the LocalAudioStats
structtxPacketLossRate
and captureFrameRate
in the LocalVideoStats
structpublishDuration
in the RemoteAudioStats
and RemoteVideoStats
structswindowFocus
and excludeWindowList
in the ScreenCaptureParameters
structLOCAL_VIDEO_STREAM_STATE_CAPTURING(1)
in the LOCAL_VIDEO_STREAM_STATE
enumLOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_MINIMIZED(11)
in the LOCAL_VIDEO_STREAM_ERROR
enumsetVideoSource
IVideoSource
classIVideoFrameConsumer
classonRtmpStreamingEvent
ERR_NO_SERVER_RESOURCES(103)
WARN_APM_RESIDUAL_ECHO(1053)
Deprecated
setEncryptionSecret
setEncryptionMode
onFirstLocalAudioFrame
Deleted
WARN_ADM_IMPROPER_SETTINGS(1053)
v3.0.1.1 was released on Jun 18, 2020. This release fixed the following issues:
registerVideoRenderFactory
(deprecated) method.v3.0.1 was released on May 27, 2020.
Frame position for the video observer
As of this release, to get the video frame from the onPreEncodeVideoFrame
callback, you must set POSITION_PRE_ENCODER(1<<2)
in getObserverFramePosition
as the frame position to observe, as well as implementing the onPreEncodeVideoFrame
callback.
1. Audio mixing pitch
To set the pitch of the local music file during audio mixing, this release adds setAudioMixingPitch
. You can set the pitch
parameter to increase or decrease the pitch of the music file. This method sets the pitch of the local music file only. It does not affect the pitch of a human voice.
2. Voice enhancement
To improve the audio quality, this release adds the following enumerate elements in setLocalVoiceChanger
and setLocalVoiceReverbPreset
:
VOICE_CHANGER_PRESET
adds several elements that have the prefixes VOICE_BEAUTY
and GENERAL_BEAUTY_VOICE
. The VOICE_BEAUTY
elements enhance the local voice, and the GENERAL_BEAUTY_VOICE
enumerations add gender-based enhancement effects.AUDIO_REVERB_PRESET
adds the enumeration AUDIO_VIRTUAL_STEREO
and several enumerations that have the prefix AUDIO_REVERB_FX
. The AUDIO_VIRTUAL_STEREO
enumeration implements reverberation in the virtual stereo, and the AUDIO_REVERB_FX
enumerations implement additional enhanced reverberation effects.See the advanced guide Set the Voice Changer and Reverberation Effects for more information.
3. Fill mode
To improve the user experience of watching videos, this release adds a video display mode RENDER_MODE_FILL(4)
. This mode zooms and stretches the video to fill the display window. You can select this mode when calling the following methods:
setupLocalVideo
setupRemoteVideo
setLocalRenderMode
setRemoteRenderMode
4. Data post-processing in multiple channels
This release adds support for post-processing remote audio and video data in a multi-channel scenario by adding the following C++ methods:
IAudioFrameObserver
class: isMultipleChannelFrameWanted
and onPlaybackAudioFrameBeforeMixingEx
.IVideoFrameObserver
class: isMultipleChannelFrameWanted
and onRenderVideoFrameEx
.After successfully registering the audio or video observer, if you set the return value of isMultipleChannelFrameWanted
as true
, you can get the corresponding audio or video data from onPlaybackAudioFrameBeforeMixingEx
or onRenderVideoFrameEx
. In a multi-channel scenario, Agora recommends setting the return value as true.
Frame position
After successfully registering the video observer, you can observe and get the video frame at each node of video processing. To conserve power consumption, this release enables customizing the frame position for the video observer. Set the return value of the getObservedFramePosition
callback to set the position to observe:
onClientRoleChanged
callback, authentication with an App ID and token, and a garbled log directory.This release adds the following APIs:
setAudioMixingPitch
VOICE_CHANGER_PRESET
, such as VOICE_BEAUTY_VIGOROUS
AUDIO_REVERB_PRESET
, such as AUDIO_REVERB_FX_KTV
RENDER_MODE_FILL(4)
in the RENDER_MODE_TYPE
enumisMultipleChannelFrameWanted
and onPlaybackAudioFrameBeforeMixingEx
in the IAudioFrameObserver
classisMultipleChannelFrameWanted
and onRenderVideoFrameEx
in the IVideoFrameObserver
classgetObservedFramePosition
totalActiveTime
member in the RemoteAudioStats
structtotalActiveTime
member in the RemoteVideoStats
structWARN_ADM_WINDOWS_NO_DATA_READY_EVENT(1040)
and WARN_ADM_INCONSISTENT_AUDIO_DEVICE(1042)
in the warning codesv3.0.0.2 was released on Apr 22, 2020.
Specifying the area of connection
This release adds areaCode
member in the RtcEngineContext
struct for specifying the area of connection when creating an IRtcEngine
instance. This advanced feature applies to scenarios that have regional restrictions. You can choose from areas including Mainland China, North America, Europe, Asia (excluding Mainland China), and global (default).
After specifying the area of connection:
This release fixed the occasional black screen issue when a co-host shares the screen.
Added
areaCode
member in the RtcEngineContext
struct
v3.0.0 was released on Mar 5, 2020.
In this release, Agora improves the user experience under poor network conditions for both the COMMUNICATION
and LIVE_BROADCASTING
profiles through the following measures:
COMMUNICATION
profile.COMMUNICATION
and LIVE_BROADCASTING
profiles, which enhances the SDK's anti-packet-loss capacity by maximizing the net bitrate when the uplink and downlink bandwidth are insufficient.To deal with any incompatibility issues caused by the architecture change, Agora uses the fallback mechanism to ensure that users of different versions of the SDKs can communicate with each other: if a user joins the channel from a client using a previous version, all clients using v3.0.0 automatically fall back to the older version. This has the effect that none of the users in the channel can enjoy the improved experience. Therefore we strongly recommend upgrading all your clients to v3.0.0.
We also upgrade the On-premise Recording SDK to v3.0.0. Ensure that you upgrade your On-premise Recording SDK to v3.0.0 so that all users can enjoy the improvements brought by the new architecture and network strategy.
1. Dual-stream mode not enabled in the COMMUNICATION
profile
As of v3.0.0, the native SDK does not enable the dual-stream mode by default in the COMMUNICATION
profile. Call the enableDualStreamMode(true)
method after joining the channel to enable it. In video scenarios with multiple users, we recommend enabling the dual-stream mode.
1. Multiple channel management
To enable a user to join an unlimited number of channels at a time, this release adds the IChannel
and IChannelEventHandler
classes. By creating multiple IChannel
objects, a user can join the corresponding channels at the same time.
After joining multiple channels, users can receive the audio and video streams of all the channels, but publish one stream to only one channel at a time. This feature applies to scenarios where users need to receive streams from multiple channels, or frequently switch between channels to publish streams. See Join Multiple Channels for details.
2. Raw video data
Adds the following C++ callbacks to the IVideoFrameObserver
class to provide raw video data at different video transmission stages, and to accommodate more scenarios.
onPreEncodeVideo
: Gets the video data after pre-processing and prior to encoding. This method applies to the scenarios where you need to pre-process the video data.getSmoothRenderingEnabled
: Sets whether to smooth the acquired video frames. The smoothed video frames are more evenly spaced, providing a better rendering experience.3. Adjusting the playback volume of the specified remote user
Adds adjustUserPlaybackSignalVolume
for adjusting the playback volume of a specified remote user. You can call this method as many times as necessary in a call or interactive live streaming to adjust the playback volume of different remote users, or to repeatedly adjust the playback volume of the same remote user.
4. Image enhancement
Adds setBeautyEffectOptions
for enabling image enhancement in scenarios such as video social networking, an online class, or interactive live streaming. You can call this method to set parameters including contrast, brightness, smoothness, red saturation, and so on. See Image Enhancement for details.
1. Audio profiles
To meet the need for higher audio quality, this release adjusts the corresponding audio profile of AUDIO_PROFILE_DEFAULT (0)
in the LIVE_BROADCASTING
profile.
SDK | AUDIO_PROFILE_DEFAULT (0) |
---|---|
v3.0.0 | A sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 52 Kbps. |
Earlier than v3.0.0 | 3A sample rate of 32 kHz, music encoding, mono, and a bitrate of up to 64 Kbps. |
2. Mirror mode
This release enables you to set a mirror effect for the stream to be encoded or for the streams to be rendered.
mirrorMode
member to the VideoEncoderConfiguration
struct for setting a mirror effect for the stream to be encoded and transmitted.setLocalRenderMode
and setRemoteRenderMode
methods, both of which take an extra mirrorMode
parameter. During a call, you can use setLocalRenderMode
to update the mirror effect of the local view or setRemoteRenderMode
to update the mirror effect of the remote view on the local device.mirrorMode
member to the VideoCanvas
struct. You can use setupLocalVideo
to set a mirror effect for the local view, or use setupRemoteVideo
to set a mirror effect for the remote view on the local device.3. Quality statistics
Adds the following members in the RtcStats
class for providing more in-call statistics, making it easier to monitor the call quality and memory usage in real time:
gatewayRtt
memoryAppUsageRatio
memoryTotalUsageRatio
memoryAppUsageInKbytes
4. Screen sharing
This release enables window sharing of UWP (Universal Windows Platform) applications when you call startScreenCaptureByWindowId
.
5. Others
This release enables interoperability between the RTC Native SDK and the RTC Web SDK by default, and deprecates the enableWebSdkInteroperability
method.
Added
setBeautyEffectOptions
onPreEncodeVideoFrame
getSmoothRenderingEnabled
setLocalRenderMode
setRemoteRenderMode
mirrorMode
member in the VideoEncoderConfiguration
structmirrorMode
and channelId
members in the VideoCanvas
structchannelId
member in the AudioVolumeInfo
structcreateChannel
IChannel
classIChannelEventHandler
classgatewayRtt
, memoryAppUsageRatio
, memoryTotalUsageRatio
and memoryAppUsageInKbytes
members in the RtcStats
classDeprecated
RtcEngineParameters
classenableWebSdkInteroperability
setLocalRenderMode¹
setRemoteRenderMode¹
setLocalVideoMirrorMode
onFirstRemoteVideoFrame
, replaced by onRemoteVideoStateChanged
onUserMuteAudio
, onFirstRemoteAudioDecoded
, and onFirstRemoteAudioFrame
, replaced by onRemoteAudioStateChanged
onStreamPublished
and onStreamUnpublished
, replaced by onRtmpStreamingStateChanged
v2.9.3 was released on Feb 10, 2020.
This release fixed the following issues:
setRemoteSubscribeFallbackOption
method, which should work in the LIVE_BROADCASTING
profile only, also works in the COMMUNICATION
profile.v2.9.1 is released on Sep 19, 2019.
1. Detecting local voice activity
This release adds the report_vad(bool)
parameter to the enableAudioVolumeIndication
method to enable local voice activity detection. Once it is enabled, you can check the AudioVolumeInfo
struct of the onAudioVolumeIndication
callback for the voice activity status of the local user.
2. Supporting RGBA raw video data
This release supports RGBA raw video data. Use the getVideoFormatPreference
method to set the format of the raw video data format.
You can also rotate or mirror the RGBA raw data using the getRotationApplied
or getMirrorApplied
methods respectively.
1. Improving the watermark function in Live Interactive Streaming
This release adds a new addVideoWatermark
method with the following settings:
visibleInPreview
member sets whether the watermark is visible in the local preview.positionInLandscapeMode
/positionInPortraitMode
member sets the watermark position when the encoding video is in landscape/portrait mode.This release optimizes the watermark function, reducing the CPU usage by 5% to 20%.
The original addVideoWatermark
method is deprecated.
2. Supporting more audio sample rates for recording
To enable more audio sample rate options for recording, this release adds a new startAudioRecording
method with a sampleRate
parameter. In the new method, you can set the sample rate as 16, 32, 44.1 or 48 kHz. The original method supports only a fixed sample rate of 32 kHz and is deprecated.
Miscellaneous
A typo in the IAgoraRtcEngine.h file.
To improve the user experience, we made the following changes in v2.9.1:
Added
startAudioRecording
addVideoWatermark
getVideoFormatPreference
getRotationApplied
getMirrorApplied
report_vad
parameter in the enableAudioVolumeIndication
methodvad
member in the AudioVolumeInfo
classDeprecated
startAudioRecording
addVideoWatermark
v2.9.0 is released on Aug 16, 2019.
1. RTMP streaming
In this release, we deleted the following methods:
configPublisher
setVideoCompositingLayout
clearVideoCompositingLayout
If your app implements RTMP streaming with the methods above, ensure that you upgrade the SDK to the latest version and use the following methods for the same function:
For how to implement the new methods, see Push Streams to the CDN.
2. Reporting the state of the remote video
This release extends the onRemoteVideoStateChanged
callback with more states of the remote video: STOPPED(0), STARTING(1), DECODING(2), FROZEN(3), and FAILED(4). It adds a reason parameter to the callback to indicate why the remote video state changes. The original onRemoteVideoStateChanged
callback is deleted. If you upgrade your Native SDK to the latest version, ensure that you re-implement the onRemoteVideoStateChanged
callback.
The new callback reports most of the remote video states, and therefore deprecates the following callbacks. You can still use them, but we do not recommend doing so.
onRemoteVideoStateChanged
callback is triggered only when the remote video state has changed.3. Disabling/enabling the local audio
To improve the audio quality in the COMMUNICATION
profile, this release sets the system volume to the media volume after you call the enableLocalAudio
(true) method. Calling enableLocalAudio
(false) switches the system volume back to the in-call volume.
1. Faster switching to another channel
This release adds the switchChannel
method to enable the audience in an interactive live streaming channel to quickly switch to another channel. With this method, you can achieve a much faster switch than with the leaveChannel
and joinChannel
methods. After the audience successfully switches to another channel by calling the switchChannel
method, the SDK triggers the onLeaveChannel
and onJoinChannelSuccess
callbacks to indicate that the audience has left the original channel and joined a new one.
2. Channel media stream relay
This release adds the following methods to relay the media streams of a host from a source channel to a destination channel. This feature applies to scenarios such as online singing contests, where hosts of different LIVE_BROADCASTING
channels interact with each other.
During the media stream relay, the SDK reports the states and events of the relay with the onChannelMediaRelayStateChanged
and onChannelMediaRelayEvent
callbacks.
For more information on the implementation, API call sequence, sample code, and considerations, see Co-host across Channels.
3. Reporting the local and remote audio state
This release adds the onLocalAudioStateChanged
and onRemoteAudioStateChanged
callbacks to report the local and remote audio states. With these callbacks, the SDK reports the following states for the local and remote audio:
error
parameter for troubleshooting.reason
parameter for why the remote audio state changes.4. Reporting the local audio statistics
This release adds the onLocalAudioStats
callback to report the statistics of the local audio during a call, including the number of channels, the sending sample rate, and the average sending bitrate of the local audio.
1. Reporting more statistics of the in-call quality
This release adds the following statistics in the RtcStats
, LocalVideoStats
, and RemoteVideoStats
classes:
RtcStats
: The total number of the sent audio bytes, sent video bytes, received audio bytes, and received video bytes during a session.LocalVideoStats
: The encoding bitrate, the width and height of the encoding frame, the number of frames, and the codec type of the local video.RemoteVideoStats
: The packet loss rate of the remote video.2. Improving the video quality of the interactive live streaming
This release minimizes the video freeze rate under poor network conditions, improves the video sharpness, and optimizes the video smoothness when the packet loss rate is high.
3. Improving the screen sharing quality
This release improves the sharpness of text during screen sharing in the COMMUNICATION
profile, particularly when the network condition is poor. Note that this improvement takes effect only when you set ContentHint as Details(2).
4. Supporting hot-swappable devices
To improve the experience in using video devices on Windows, this release adds support for hot-swappable devices with the context
member in the RtcEngineContext
class. Setting this member also achieves the following functions:
5. Other Improvements
COMMUNICATION
profile.Audio
muteRemoteAudioStream
method.Video
onRemoteVideoStateChanged
callback behaves unexpectedly.Miscellaneous
To improve the user experience, we made the following changes in v2.9.0:
Added
onLocalAudioStateChanged
onRemoteAudioStateChanged
onRemoteVideoStateChanged
onLocalAudioStats
switchChannel
startChannelMediaRelay
updateChannelMediaRelay
stopChannelMediaRelay
onChannelMediaRelayStateChanged
onChannelMediaRelayEvent
RtcEngineContext
: contextRtcStats
: txAudioBytes
, txVideoBytes
, rxAudioBytes
, and rxVideoBytes
LocalVideoStats
: encodedBitrate
, encodedFrameWidth
, encodedFrameHeight
, encodedFrameCount
, and codedType
RemoteVideoStats
: packetLossRate
Deprecated
onMicrophoneEnabled
. Use LOCAL_AUDIO_STREAM_STATE_CHANGED(0) or LOCAL_AUDIO_STREAM_STATE_RECORDING(1) in the onLocalAudioStateChanged
callback instead.
onRemoteAudioTransportStats
. Use the onRemoteAudioStats
callback instead.
onRemoteVideoTransportStats
. Use the onRemoteVideoStats
callback instead.
onUserEnableVideo
. Use the onRemoteVideoStateChanged
callback with the following parameters instead:
onUserEnableLocalVideo
. Use the onRemoteVideoStateChanged
callback with the following parameters instead:
onFirstRemoteVideoDecoded
. Use REMOTE_VIDEO_STATE_STARTING(1) or REMOTE_VIDEO_STATE_DECODING(2) in the onRemoteVideoStateChanged
callback instead.
Deleted
configPublisher
setVideoCompositingLayout
clearVideoCompositingLayout
onRemoteVideoStateChanged
v2.8.0 is released on Jul. 8, 2019.
1. Supporting string user IDs
Many apps use string user IDs. This release adds the following methods to enable apps to join an Agora channel directly with string user IDs as user accounts:
For other methods, Agora uses the integer uid parameter. The Agora Engine maintains a mapping table that contains the user ID and string user account, and you can get the corresponding user account or ID by calling the getUserInfoByUid or getUserInfoByUserAccount method.
To ensure smooth call, use the same parameter type to identify all users within a channel, that is, all users should use either the integer user ID or the string user account to join a channel.
Do not mix parameter types within the same channel. The following Agora SDKs support string user accounts:
If you use SDKs that do not support string user accounts, only integer user IDs can be used in the channel.
If you change your user IDs into string user accounts, ensure that all app clients are upgraded to the latest version.
If you use string user accounts, ensure that the token generation script on your server is updated to the latest version. If you join the channel with a user account, ensure that you use the same user account or its corresponding integer user ID to generate a token. Call the getUserInfoByUserAccount
method to get the user ID that corresponds to the user account.
2. Adding remote audio and video statistics
To monitor the audio and video transmission quality during a call or interactive live streaming, this release adds the totalFrozenTime
and frozenRate
members in the RemoteAudioStats and RemoteVideoStats classes, to report the audio and video freeze time and freeze rate of the remote user.
This release also adds the numChannels
, receivedSampleRate
, and receivedBitrate
members in the RemoteAudioStats class.
This release adds a CONNECTION_CHANGED_KEEP_ALIVE_TIMEOUT(14)
member to the reason
parameter of the onConnectionStateChanged callback. This member indicates a connection state change caused by the timeout of the connection keep-alive between the SDK and Agora's edge server.
To improve your experience, we made the following changes to the APIs:
Added
numChannels
, receivedSampleRate
, receivedBitrate
, totalFrozenTime
, and frozenRate
members in the RemoteAudioStats classtotalFrozenTime
and frozenRate
members in the RemoteVideoStats classDeprecated
lowLatency
member in the LiveTranscoding classV2.4.1 is released on Jun 12th, 2019.
Ensure that you read the following SDK behavior changes if you migrate from an earlier SDK version.
1. Publishing streams to the RTMP
To improve the usability of the RTMP streaming service, v2.4.1 defines the following parameter limits:
Class / Interface | Parameter Limit |
---|---|
LiveTranscoding | |
RtcImage | url: The maximum length of this parameter is **1024 bytes. |
addPublishStreamUrl | url : The maximum length of this parameter is **1024 bytes. |
removePublishStreamUrl | url : The maximum length of this parameter is **1024 bytes. |
This release also adds the audioCodecProfile parameter in the LiveTranscoding
class to set the audio codec profile type. The default type is LC-AAC, which means the low-complexity audio codec profile.
v2.4.1 also adds five error codes to the error
parameter in the onStreamPublished method for quick troubleshooting.
2. Renaming the receivedFrameRate parameter in the RemoteVideoStats class
v2.4.1 renames the receivedFrameRate
parameter to rendererOutputFrameRate in the RemoteVideoStats class to more accurately describe the statistics of the remote video stream.
1. Adding media metadata
In interactive live streaming scenarios, the host can send shopping links, digital coupons, and online quizzes to the audience for more diversified interactive live streaming interactions. v2.4.1 adds the registerMediaMetadataObserver interface and the IMediaMetadataObserver class, allowing the host to add metadata to the output video and to send media attached information.
2. Optimized screen sharing
To avoid image cropping and distortion in screen sharing, v2.4.1 optimizes the encoding algorithms. In this release Agora applies the following encoding algorithms:
Suppose the value of dimensions is 1920 x 1080 pixels, that is, 2073600 pixels:
dimensions
is lower than that of the encoding dimensions, for example, 1000 x 1000 pixels, the SDK uses 1000 x 1000 pixels for encoding.dimensions
is higher than that of the encoding dimensions, for example, 2000 x 2000 pixels, the SDK uses the maximum value under 1920 x 1080 pixels with the aspect ratio of the screen dimension (1:1) for encoding, that is, 1440 x 1440 pixels.Agora uses the dimensions value in theScreenCaptureParameters class to calculate the charges. If you do not set the value of **dimensions, the SDK uses the default value of 1920 x 1080 to calculate the charges.
You can also choose whether or not to capture the mouse cursor when sharing the screen. v2.4.1 adds the captureMouseCursor parameter in the ScreenCaptureParameters
class and captures the mouse by default.
3. State of the local video
v2.4.1 adds the onLocalVideoStateChanged callback to indicate the local video state. In this callback, the SDK returns the STOPPED
,CAPTURING
, ENCODING
, or FAILED
state. When the state is FAILED
, you can use the error code for troubleshooting. This callback indicates whether or not the interruption is caused by capturing or encoding. This release deprecates the onCameraReady
and onVideoStopped
callbacks.
4. State of the RTMP streaming
v2.4.1 adds the onRtmpStreamingStateChanged callback to indicate the state of the RTMP streaming and help you troubleshoot issues when exceptions occur. In this callback, the SDK returns the IDLE, CONNECTING
, RUNNING
, RECOVERING
, or FAILURE
state. When the state is FAILURE
, you can use the error code for troubleshooting. You can still use the onStreamPublished
and onStreamUnpublished
callbacks, but we do not recommend using them.
5. More reasons for a network connection state change
In the onConnectionStateChanged callback, v2.4.1 adds error codes to the reason
parameter to help you troubleshoot issues when exceptions occur. The SDK returns the onConnectionStateChanged
callback whenever the connection state changes. This release also deprecates WARN_LOOK_UP_CHANNEL_REJECTED(105)
, ERR_TOKEN_EXPIRED(109)
, and ERR_INVALID_TOKEN(110)
.
6. State of the local network type
v2.4.1 adds the onNetworkTypeChanged callback to indicate the local network type. In this callback, the SDK returns the UNKNOWN
, DISCONNECTED
, LAN
, WIFI
, 2G
, 3G
, or 4G
type. When the network connection is interrupted, this callback indicates whether or not the interruption is caused by a network type change or poor network conditions.
7. Getting the audio mixing volume
v2.4.1 adds the getAudioMixingPlayoutVolume and getAudioMixingPublishVolume methods, which respectively gets the audio mixing volume for local playback and remote playback, to help you troubleshoot audio volume related issues.
8. Reporting when the first remote audio frame is received and decoded
To get the more accurate time of the first audio frame from a specified remote user, v2.4.1 adds the onFirstRemoteAudioDecoded callback to report to the app that the SDK decodes first remote audio. This callback is triggered in either of the following scenarios:
The difference between the onFirstRemoteAudioDecoded
and onFirstRemoteAudioFrame
callbacks is that the onFirstRemoteAudioFrame
callback occurs when the SDK receives the first audio packet. It occurs before the onFirstRemoteAudioDecoded
callback.
9. Miscellaneous
v2.4.1 supports 64-bit operation systems.
1. Reporting more statistics
v2.4.1 adds the txPacketLossRate and rxPacketLossRate parameters in the RtcStats class. These parameters return the packet loss rate from the local client to the server and vice versa.
To provide more accurate statistics of the local and remote video, v2.4.1 makes the following changes to the following classes:
2. Miscellaneous
enableAudioQualityIndication
method.Audio
Video
Miscellaneous
onNetworkQuality
callback after leaving the channel.To improve your experience, we made the following changes to the APIs:
Unified the C++ interface for all platforms
v2.4.1 unifies the behavior of the C++ interfaces across different platforms so that you can apply the same code logic on different platforms. v2.4.1 implements the methods of the RtcEngineParameters
class in the IRtcEngine
class. Refer to Agora C++ API Reference for All Platforms home page for the applicable platforms and considerations of each interface.
Added
LiveTranscoding
classScreenCaptureParameters
classRtcStats
classLocalVideoStats
classreceivedRemoteRate
) parameters in the RemoteVideoStats
classDeprecated
enableAudioQualityIndication
onCameraReady
. Use LOCAL_VIDEO_STREAM_STATE_CAPTURING(1) in the onLocalVideoStateChanged callback instead.onVideoStopped
. Use LOCAL_VIDEO_STREAM_STATE_STOPPED(0) in the onLocalVideoStateChanged callback instead.WARN_LOOKUP_CHANNEL_REJECTED(105)
warning code. Use CONNECTION_CHANGED_REJECTED_BY_SERVER(10) in the onConnectionStateChanged callback instead.ERR_TOKEN_EXPIRED(109)
error code. Use CONNECTION_CHANGED_TOKEN_EXPIRED(9) in the onConnectionStateChanged callback instead.ERR_INVALID_TOKEN(110)
error code. Use CONNECTION_CHANGED_INVALID_TOKEN(8) in the onConnectionStateChanged callback instead.ERR_START_CAMERA(1003)
error code. Use LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE(4) in the onLocalVideoStateChanged callback instead.ERR_VDM_WIM_DEVICE_IN_USE(1502)
error code. Use LOCAL_VIDEO_STREAM_ERROR_DEVICE_BUSY(3) in the in the onLocalVideoStateChanged callback instead.v2.4.0
v2.4.0 is released on April 1, 2019.
v2.4.0 upgrades screen sharing and provides the following advanced functions:
startScreenCaptureByScreenRect
).startScreenCaptureByWindowId
) .setScreenCaptureContentHint
).updateScreenCaptureParameters
).v2.4.0 deprecates the startScreenCapture
method. We recommend using the new methods for screen sharing. With the new methods, developers need to design the code logic to obtain the screenRect
and windowId
. For more information, see Share the Screen.
Adding voice changer and reverberation effects in an audio chat room brings much more fun. v2.4.0 adds the setLocalVoiceChanger
and setLocalVoiceReverbPreset
methods, allowing you to change your voice or reverberation by choosing from the preset options.
v2.4.0 adds the enableSoundPositionIndication
and setRemoteVoicePosition
. Call the enableSoundPositionIndication
method before joining a channel to enable stereo panning for the remote users, and then you can call the setRemoteVoicePosition
method to track the position of a remote user.
Conducting a last-mile probe test before joining the channel helps the local user to evaluate or predict the uplink network conditions. v2.4.0 adds the startLastmileProbeTest
, stopLastmileProbeTest
, and onLastmileProbeResult
APIs, allowing you to get the uplink and downlink last-mile network statistics, including the bandwidth, packet loss, jitter, and round-trip time (RTT).
v2.4.0 adds the startAudioDeviceLoopbackTest
and stopAudioDeviceLoopbackTest
methods for testing whether the local audio devices are working properly. The test involves only the local audio devices and does not report the network condition.
v2.4.0 adds the setRemoteUserPriority
method for setting the priority of a remote user. You can use this method with the setRemoteSubscribeFallbackOption
method. If the fallback function is enabled for a remote stream, the SDK ensures the high-priority user gets the best possible stream quality.
v2.4.0 adds the onAudioMixingStateChanged
callback to report any change of the audio-mixing file playback state (playback succeeds or fails) and the corresponding reason. This release also adds the warning code 701, which is triggered if the local audio-mixing file does not exist, or if the SDK does not support the file format or cannot access the music file URL when playing the audio-mixing file.
The SDK has two log files, each with a default size of 512 KB. In case some customers require more than the default size, v2.4.0 adds the setLogFileSize
method for setting the log file size (KB).
v2.4.0 adds the backgroundImage
parameter in the LiveTranscoding
Class in Windows to set the background image in the combined video of the interactive live streaming.
Adds the cloud proxy service. See Use Cloud Proxy for details.
LocalVideoStats
class: targetBitrate
for setting the target bitrate of the current encoder, targetFrameRate
for setting the target frame rate, and qualityAdaptIndication
for reporting the quality of the local video since last count.v2.4.0 provides the following options for setting video encoder preferences:
VideoEncoderConfiguration
class: minFrameRate and degradationPrefer. You can use these parameters together to set the minimum video encoder frame rate and the video encoding degradation preference under limited bandwidth.setCameraCapturerConfiguration
method, allowing you to set the camera capture preference. You can choose system performance over video quality or vice versa as needed. For more information, see the API Reference.enableLocalAudio
method disconnects all connected Bluetooth devices.renderMode
setting, the video stretches due to a mismatch with the display.To improve your experience, we made the following changes to the APIs:
setBeautyEffectOptions
startScreenCaptureByScreenRect
startScreenCaptureByWindowId
updateScreenCaptureParameters
setScreenCaptureContentHint
setLocalVoiceChanger
setLocalVoiceReverbPreset
enableSoundPositionIndication
setRemoteVoicePosition
startLastmileProbeTest
stopLastmileProbeTest
setRemoteUserPriority
startEchoTest
startAudioDeviceLoopbackTest
stopAudioDeviceLoopbackTest
setCameraCapturerConfiguration
setLogFileSize
onAudioMixingStateChanged
onLastmileProbeResult
startEchoTest
startScreenCapture
setVideoQualityParameters
v2.3.3
v2.3.3 is released on January 24, 2019.
v2.3.3 optimizes the screen-sharing algorithm for different scenarios. The video smoothness and quality are enhanced when a user presents slides or browses websites. v2.3.3 also improves the initial image quality in the COMMUNICATION
profile.
Occasional inaccurate statistics returned in the onNetworkQuality
callback.
v2.3.2
v2.3.2 is released on January 16, 2019.
Besides the new features and improvements mentioned below, it is worth noting that v2.3.2:
LIVE_BROADCASTING
profile.Before upgrading your SDK, ensure that your version is:
If you using an Agora SDK version v2.0.8 and wish to migrate the v2.3.2, refer to the Migration Guide for major API changes.
v2.3.2 adds the following methods, allowing you to use the external video during a call or in interactive live streaming:
setExternalVideoSource
: Configures the external video source.pushVideoFrame
: Pushes the external video frames.The application can encapsulate the external video frames in the AgoraVideoFrame
format and push them to the SDK for encoding and transmitting.
This feature applies to scenarios where a user captures and renders the external video and then pushes the video frames to the SDK for transmission (the application processes the rendering).
v2.3.2 adds the following methods to improve the user experience in playing the external audio:
setExternalAudioSink
: Sets the external audio sink.pullAudioFrame
: Pulls the external audio frame.The application pulls the decoded audio frames (mixed from the remote users) from the media engine for external playback.
The difference between pullAudioFrame
and onPlaybackAudioFrame
:
pullAudioFrame
: The application pulls the audio frames and:
Specifies the number of audio samples for playback.
Adjusts the frame buffer.
Allows for a delay in processing the audio frame.
This method avoids problems caused by jitter in the external audio, such as an unsynchronized audio playback.
onPlaybackAudioFrame
: The SDK pushes the audio frames to the application once every 10 ms. Any delay in processing the audio frames may result in audio jitter.
v2.3.2 adds the minBitrate parameter (minimum encoding bitrate) in the setVideoEncoderConfiguration method. The SDK automatically adjusts the encoding bitrate to adapt to the network conditions. Using a value greater than the default value forces the video encoder to output high-quality images but may cause more packet loss and hence sacrifice the smoothness of the video transmission. Agora does not recommend changing this value unless you have special requirements for image quality.
v2.3.2 adds the adjustAudioMixingPlayoutVolume
and adjustAudioMixingPublishVolume
methods to complement the adjustAudioMixingVolume
method, allowing you to independently adjust the audio mixing volume for local playback and remote publishing.
This release also changes the behavior of the adjustPlaybackSignalVolume method to control only the voice volume. Therefore, to mute the local audio playback, call both the adjustPlaybackSignalVolume(0)
and adjustAudioMixingVolume(0)
methods.
See Adjust the Volume for the scenarios and corresponding APIs.
Unreliable network conditions affect the overall quality of the interactive live streaming. v2.3.2 adds the setLocalPublishFallbackOption
and setRemoteSubscribeFallbackOption
methods to allow the SDK to:
The SDK triggers the onLocalPublishFallbackToAudioOnly
or onRemoteSubscribeFallbackToAudioOnly
callback when the stream falls back to audio-only or switches back to the video.
v2.3.2 adds the onRemoteAudioTransportStats
and onRemoteVideoTransportStats
callbacks to provide the upstream and downstream statistics of each remote user/host. During a call or interactive live streaming, the SDK triggers these callbacks once every two seconds after the local user receives audio/video packets from a remote user. The callbacks return the user ID, received audio/video bitrate, packet loss rate, and network time delay (ms).
To support video rotation scenarios and improve the quality of the custom video source, v2.3.2 deprecates the setVideoProfile
method and replaces it with the setVideoEncoderConfiguration
method to set the video encoder configurations. The VideoEncoderConfiguration
class provides a set of configurable video parameters, including the dimension, frame rate, bitrate, and orientation. You can still use the setVideoProfile
method, but Agora recommends using the setVideoEncoderConfiguration
method to set the video profile.
v2.3.2 adds the deviceName
parameter in the enableLoopbackRecording
method, allowing you to use a virtual sound card for audio recording:
deviceName
as the name of the virtual card.v2.3.2 deprecates the onAudioQuality
callback and replaces it with the onRemoteAudioStats
callback to improve the accuracy of the call quality statistics. The onRemoteAudioStats
callback returns parameters such as the audio frame loss rate, end-to-end audio delay, and jitter buffer delay at the receiver, which are more closely linked to the real user experience. In addition, v2.3.2 optimizes the algorithm of the onNetworkQuality
callback for the uplink and downlink network qualities.
onRemoteAudioStats
: Reports the statistics of the remote audio stream from each user/host. This callback replaces the onAudioQuality callback.onNetworkQuality
: Reports the last mile network quality of each user in the channel.Agora plans to improve the following callback in subsequent versions:
onLastmileQuality
: Reports the last mile network quality of the local user before the user joins a channel.v2.3.2 adds the following API method and callback to get the current network connection state and reason for a connection state change:
getConnectionState
: Gets the connection state of the SDK.onConnectionStateChanged
: Occurs when the connection state of the SDK to the server changes.v2.3.2 deprecates the onConnectionInterrupted
and onConnectionBanned
callbacks.
In the new API method, the network connection states are "disconnected", "connecting", "connected", "reconnecting", and "failed". The SDK triggers the onConnectionStateChanged
callback when the network connection state changes. The SDK also triggers the onConnectionInterrupted
and onConnectionBanned
callbacks under certain circumstances, but Agora does not recommend using them.
v2.3.2 changes the rating parameter in the rate
method to "1 to 5" to encourage more feedback from end-users on the quality of a call or interactive live streaming. Application developers can use this feedback for future product improvement. Agora strongly recommends integrating this method in your application.
v2.3.2 optimizes the audio device selection to fix the no audio issue when a user switches the audio device during a call or interactive live streaming.
LIVE_BROADCASTING
profile.The following issues are fixed in v2.3.2:
startAudioMixing
method to play music files.setVideoProfile
method to specify the video resolution.To improve the user experience, Agora has made the following changes to the APIs:
setVideoEncoderConfiguration
setExternalVideoSource
pushVideoFrame
setExternalAudioSink
pullAudioFrame
setLocalPublishFallbackOption
setRemoteSubscribeFallbackOption
getConnectionState
adjustAudioMixingPlayoutVolume
adjustAudioMixingPublishVolume
onConnectionStateChanged
onLocalPublishFallbackToAudioOnly
onRemoteSubscribeFallbackToAudioOnly
onRemoteAudioStats
onRemoteAudioTransportStats
onRemoteVideoTransportStats
v2.2.2
v2.2.2 is released on June 21, 2018.
v2.2.1
v2.2.0 is released on May 30, 2018 and improves the internal code implementation.
v2.2.0
v2.2.0 is released on May 4, 2018.
Adds a publish
parameter in the playEffect
method to enable the remote user in the channel to hear the audio effect played locally.
If your SDK is upgraded to v2.2 from a previous version, pay attention to the functional changes of this API.
Agora provides a proxy package for enterprise users with corporate firewalls to deploy before accessing the services of Agora.
Adds the remoteVideoStateChangedOfUid
method to get the state of the remote video stream.
Adds the watermark function for users to add a PNG file to the local or RTMP live streaming as a watermark. Adds the addVideoWatermark
and clearVideoWatermarks
methods to add and delete watermarks in a local live streaming. Adds the watermark
parameter in the LiveTranscoding
interface to add watermarks in RTMP streaming.
Improves the enableAudioVolumeIndication
method. This method once enabled, sends the audio volume indication of the speaker in its callback at set intervals, regardless of whether anyone is speaking in the channel.
To meet the need for real-time network quality detection in the channel, the onNetworkQuality
callback improves its data accuracy.
To test if the network condition can support audio or video calls before joining a channel, the onLastmileQuality
callback changes its detection base from a fixed bitrate to the bitrate set in videoProfile
to improve data accuracy. When the network condition is unknown, the SDK still triggers this callback once every 2 seconds.
Improves the audio quality in scenarios that involve music playback.
LIVE_BROADCASTING
channel.v2.1.3
v2.1.3 is released on April 19, 2018.
In v2.1.3, Agora updates the bitrate values of the setVideoProfile
method in the LIVE_BROADCASTING
profile. The bitrate values in v2.1.3 stay consistent with those in v2.0.
Occasional recording failures on some phones when a user leaves a channel and turns on the built-in recording device.
Improves the performance of screen sharing by shortening the time interval between which users switch from screen sharing to a normal COMMUNICATION
or LIVE_BROADCASTING
profile.
v2.1.2
v2.1.2 is released on April 2, 2018.
If you upgrade the SDK to v2.1.2 from a previous version, the video quality of the interactive live streaming will be better than the video quality of the call in the same resolutions, resulting in the interactive live streaming using more bandwidth.
COMMUNICATION
profile than in the LIVE_BROADCASTING
profile.v2.1.1
v2.1.1 is released on March 16, 2018.
Agora has identified a critical bug in SDK v2.1. Upgrade to v2.1.1 if you are using Agora SDK v2.1.
v2.1.0
v2.1.0 is released on March 7, 2018.
Adds a scenario for the game chat room to reduce the bandwidth and cancel the noise with the setAudioProfile
method.
In the interactive live streaming scenario, the host can enhance the local audio effects from the built-in microphone with the setLocalVoiceEqualization
and setLocalVoiceReverb
methods to implement the expected voice equalization and reverberation effects.
Adds RESTful APIs to check the status of the users in the channel, the channel list of a specific company, and whether the user is an audience or a host. See:
Adds the support of 17-way video in the interactive live streaming scenario
Adds the function of injecting an external video stream to an ongoing interactive streaming. See Inject Online Media Stream.
Adds the enableLoopbackRecording
method to collect all local sounds.
Improvement | Description |
---|---|
Video Freeze Rate | Reduces the video freeze rate in the audience mode and for specific devices. |
Authentication | Supports a new authentication mechanism. Each legacy Dynamic Key (Channel Key) corresponds to a single privilege (for example, joining a channel), but each token in the new authentication mechanism includes all privileges (for example, joining a channel, host-in, and stream-pushing). |
Billing Optimization | Small video resolutions are charged according to the voice-only mode. For example, 16 × 16. |
v2.0
v2.0 is released on November 21, 2017.
Developers,
Due to the upgrade of Agora products, Windows SDK 2.0 no longer supports the Agora Recording Server version 1.8.2 and before, or relevant APIs.
This may affect:
Two solutions are available:
Adds the setRemoteVideoStreamType
and enableDualStreamMode
methods in the COMMUNICATION
profile to support dual streams.
Supports the external audio source in the COMMUNICATION
and LIVE_BROADCASTING
profiles by adding the following API methods:
Name | Description |
---|---|
setExternalAudioSource |
Sets the external audio source parameters, including the sample rate and channel number. |
pushExternalAudioFrame |
Pushes the external audio frame to the Agora SDK. |
Provides a set of RESTful APIs to ban a peer user from the server in the COMMUNICATION
and LIVE_BROADCASTING
profiles. Contact support@agora.io to enable the function, if required.
Supports Windows (x64).
Adds API methods such as setting the volume, mute states, and system volume settings.
Name | Description |
---|---|
setPlaybackDeviceVolume |
Sets the volume of the playback device. |
getPlaybackDeviceVolume |
Gets the volume of the playback device. |
setRecordingDeviceVolume |
Sets the volume of the microphone. |
getRecordingDeviceVolume |
Gets the volume of the microphone. |
setPlaybackDeviceMute |
Mutes the playback device. |
getPlaybackDeviceMute |
Gets the mute status of the playback device. |
setRecordingDeviceMute |
Mutes the microphone. |
getRecordingDeviceMute |
Gets the mute status of the microphone. |
onAudioDeviceVolumeChanged |
Notifies the application when the volume of the playback device, recording device, or application changes. |
v1.14
v1.14 is released on October 20, 2017.
setAudioProfile
method to set the audio parameters and scenarios.setLocalVoicePitch
method to set the local voice pitch.setInEarMonitoringVolume
method to adjust the volume of the in-ear monitor.v1.13.1
v1.13.1 is released on September 28, 2017 and optimizes the echo issue under certain circumstances.
v1.13
v1.13 is released on September 4, 2017.
onClientRoleChanged
callback to report on a user role switch between the host and audience in the interactive live streaming.Occasional crashes.
v1.12
v1.12 is released on July 25, 2017.
injectStream
method to inject an RTMP stream into the current channel in the LIVE_BROADCASTING
profile.aes-128-ecb
encryption mode in the setEncryptionMode
method.quality
parameter in the startAudioRecording
method to set the recording audio quality.ActiveSpeaker
method to report on the active speaker in the current channel.setScreenCaptureWindow
method, and updated the startScreenCapture
method to share the whole screen and specify the window or region in the COMMUNICATION
profile.COMMUNICATION
profile.COMMUNICATION
and LIVE_BROADCASTING
profiles. See Release Notes.Recording: Adds APIs for real-time video mixing and web recording. See Release Notes for the Recording SDK.
Android/iOS/macOS/Windows: In the COMMUNICATION
profile, an improvement for the 320 × 180 resolution profile: