Release Notes

This page provides the release notes for the Agora Video SDK for macOS.

Known issues and limitations

Compatibility with macOS Monterey 12

As of v3.4.4, the SDK supports macOS Monterey 12. For the SDK versions between v3.2.0 and v3.4.3 inclusive, crashes occur on macOS Monterey 12. To fix this issue, upgrade the SDK to v3.4.4 or later.

USB device driver issue

A USB device driver issue occurs when you do not hear any audio or the audio is corrupted with a USB headset. USB is not user-friendly on macOS, and we recommend using higher quality headsets.

Rosetta translation issue

If your app is integrated with the SDK earlier than v3.3.0, the app can only run under Rosetta translation on Mac devices with the M1 chip, which causes a memory leak when a user frequently joins and leaves a channel.

To avoid this issue, upgrade the SDK to v3.3.0 or later and adapt the app to x86-64 and arm64 architectures.

v3.7.0

v3.7.0 was released on April 11, 2022.

Compatibility changes

1. Optimized integration with Swift API

Swift developers automatically convert the Objective-C API provided by the Agora SDK to the Swift API by using Xcode for integration development. To avoid API semantic confusion due to automatic conversion, this release uses the NS_SWIFT_NAME macro to explicitly define the name of the Swift API for each Objective-C API in the header files.

When you use the Swift API, note that the following Swift API names defined by Agora do not match the Swift API names automatically converted by Xcode:

Agora Objective-C API	Swift API defined by Agora	Swift API automatically converted by Xcode
- (int)updateScreenCaptureParameters:(AgoraScreenCaptureParameters* _Nonnull)captureParams; in the AgoraRtcEngineKit class	updateScreenCaptureParameters()	update()
- (int)setScreenCaptureContentHint:(AgoraVideoContentHint)contentHint; in the AgoraRtcEngineKit class	setScreenCaptureContentHint()	setScreenCapture()
- (BOOL)onRecordAudioFrame:(AgoraAudioFrame* _Nonnull)frame; in the AgoraAudioDataFrameProtocolprotocol	func onRecordAudioFrame(_ frame: AgoraAudioFrame) -> Bool {}	func onRecord(_ frame: AgoraAudioFrame) -> Bool {}
+ (instancetype _Nonnull)screenCaptureWithId:(NSUInteger)displayId rect:(CGRect)rect dimensions:(CGSize)dimensions frameRate:(NSInteger)frameRate bitrate:(NSInteger)bitrate captureMouseCursor:(BOOL)captureMouseCursor; in the AgoraRtcScreenCapture interface	screenCapture(withId: rect: dimensions: frameRate: bitrate: captureMouseCursor:)	init(id: rect: dimensions: frameRate: bitrate: captureMouseCursor:)

2. Log path

As of v3.7.0, on macOS, the default SDK log path when disabling the sandbox has changed from ～/Library/Logs/agorasdk.log to /Users/<username>/Library/Caches/<App Bundle Identifier>/Logs/agorasdk.log. If you upgrade the SDK, the old logs are stored at the old path, but the new logs are stored at the new path.

New features

1. Virtual sound cards

When calling enableLoopbackRecording for the loopback audio capture, developers typically use common virtual sound cards on macOS, including Soundflower and BlackHole. But these virtual sound cards sometimes experience compatibility issues with the M1 chip or the latest systems, and deferred maintenance.

To improve the loopback audio capture experience, Agora has developed its own virtual sound card: AgoraALD (Agora Audio Loopback Device). You can replace your current virtual sound card with AgoraALD using the following steps:

• Install AgoraALD. See AgoraALD Virtual Sound Card.
• Change the value of deviceName in the enableLoopbackRecording method to "AgoraALD".

2. Spatial audio effect

This release adds the feature of spatial audio effect, which can add a sense of space to remote users' audio and simulate the audio transmission process in the real world. This enables the local user to hear remote users with the spatial audio effect.

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

3. Screen sharing

This release adds two new features to screen sharing:

• Set the screen sharing scenario, including sharing documents or videos, by the setScreenCaptureScenario (C++) method. The SDK can adjust the video quality and experience of screen sharing according to the scenario you set.
• Set a border and the width and color of the border for the shared window or screen by the enableHighLight, highLightWidth, and highLightColor properties in ScreenCaptureParameters.

4. Local voice pitch

This release adds the enableLocalVoicePitchCallback method and the reportLocalVoicePitchFrequency callback, to allow the SDK to report the voice pitch of the local user at the set time interval to the app.

5. Reporting the first remote video frame rendered

This release adds the firstRemoteVideoFrameOfUid callback to the AgoraRtcChannelDelegate class to report to the local user that the first video frame of the remote user has been rendered in a multichannel scenario. You can also get the remote user ID, the width and height (in pixels) of the video, and the time (in milliseconds) to render the first video frame from this callback.

6. Reporting the user role switch failure

This release adds the didClientRoleChangeFailed callback to report the reason for a user role switch failure and the current user role in the interactive live streaming.

7. Reasons for connection state changes

To help users better understand the cause of connection state changes, this release adds the following enumerators in AgoraConnectionChangedReason:

• AgoraConnectionChangedSameUidLogin(19): Join the same channel from different devices using the same user ID.
• AgoraConnectionChangedTooManyBroadcasters(20): The number of hosts in the channel reaches the upper limit. This enumerator is reported only after the support for 128 hosts is enabled.

Improvements

1. Channel capacity improvement

As of this release, a single channel can support up to 128 concurrent online hosts, who can publish audio and video streams at the same time. The number of audience members in a channel is unlimited. Each host or audience member can subscribe to a maximum of 50 hosts at the same time.

To experience this improvement, contact support@agora.io.

2. Virtual background

Test results and user feedback show that the effect of the virtual background feature significantly improves when a user is against a complex background and and adopts a more casual pose. As a result, virtual background is converted from a beta feature to an official feature as of v3.7.0.

3. A new version of deep-learning noise reduction

Agora has added the option of using a new version of deep-learning noise reduction to further improve audio quality. To experience this feature, contact support@agora.io

4. playEffect improvements

This release improves the internal implementation logic of playEffect to avoid blocking and reduce freezing when playing an audio effect file.

5. Audio experience optimization

This release reduces audio stuttering under network conditions with burst jitter and high packet loss.

6. Transmission upgrade

This release upgrades transmission protocols and algorithms to enhance the SDK‘s ability to counter poor network conditions. At the same time, this release optimizes the scalable video coding capability for multi-user video scenarios to improve user video experience.

API changes

Added

• enableLocalVoicePitchCallback
• reportLocalVoicePitchFrequency
• firstRemoteVideoFrameOfUid in the AgoraRtcChannelDelegate class
• The following properties in ScreenCaptureParameters:
  • enableHighLight
  • highLightWidth
  • highLightColor
• didClientRoleChangeFailed
• AgoraConnectionChangedSameUidLogin(19) and AgoraConnectionChangedTooManyBroadcasters(20) in AgoraConnectionChangedReason

Deprecated

• Warning code AgoraWarningCodeSetClientRoleNotAuthorized(119), use AgoraClientRoleChangeFailedReason instead.

v3.6.2.1

v3.6.2.1 was released on March 4, 2022.

This release fixed a crash of the SDK on systems earlier than macOS 10.11. This crash was due to strong references by some dynamic libraries to the Metal library.

v3.6.2

v3.6.2 was released on February 22, 2022.

Compatibility changes

Dynamic library format change

This release changes .framework files in the SDK to .xcframework files. Compared with the Framework format, the XCFramework format is more flexible and supports the Swift Package Manager for integration.

If you are integrating by using the SDK download link, when you upgrade to v3.6.2, you must modify the project as follows:

1. In the TARGETS > Project Name > General > Frameworks, Libraries, and Embedded Content menu and project folder, remove all .framework files.
2. In this menu and project folder, add the corresponding .xcframework files.

For integration details, see the Quickstart Guide.

New features

1. Removing extension libraries when using CocoaPods

Extension libraries are dynamic libraries that can be optionally integrated into a project. As of v3.6.2, when you integrate the macOS SDK with CocoaPods, Agora supports reducing the size of your app after integrating the SDK by using the subspecs field in the Podfile to specify the desired dynamic libraries and exclude unnecessary extension libraries. For details about the sample code and the subspecs fields, see Reduce App Size.

2. Video enhancement

In addition to the image enhancement feature, Agora adds support for more video enhancement features:

• Video noise reduction: This feature reduces video noise and improves video quality. You can use the setVideoDenoiserOptions method to enable/disable video noise reduction and set the options of the video noise reduction effect.
• Low-light enhancement: This feature adaptively adjusts the brightness value of the video captured in situations with low or uneven lighting, such as backlit, cloudy, or dark scenes. It restores or highlights the image details and improves the overall visual effect of the video. You can use the setLowLightEnhanceOptions method to enable/disable low-light enhancement and set the options of the low-light enhancement effect.
• Color enhancement: This feature intelligently adjusts video characteristics such as saturation and contrast to enhance the video color richness and color reproduction, making the video more vivid. You can use the setColorEnhanceOptions method to enable/disable color enhancement and set the options of the color enhancement effect.

Improvements

1. Cloud proxy

To enrich application scenarios of the Agora Cloud Proxy, this release updates the cloud proxy types (proxyType) as follows:

• Changes the meaning of AgoraNoneProxy(0) from "Do not use the cloud proxy" to "Automatic mode". In this mode, the SDK attempts a direct connection to SD-RTN™ and automatically switches to TLS 443 if the attempt fails. As of v3.6.2, the SDK has this mode enabled by default.
• Adds AgoraTcpProxy(2), which is the TCP (encrypted) mode. In this mode, the SDK always transmits data over TLS 443.

In addition, this release adds the didProxyConnected callback to report the proxy connection state. For example, when a user calls setCloudProxy and joins a channel successfully, the SDK triggers this callback to report the user ID, the proxy type connected, and the time elapsed from the user calling joinChannelByToken until this callback is triggered.

2. Audio device test

To support testing audio devices after joining a channel, this release improves the following methods and callbacks:

• Adds reportAudioDeviceTestVolume, which reports the volume information of the audio device being tested.
• Changes call sequence of startRecordingDeviceTest, startPlaybackDeviceTest, and startAudioDeviceLoopbackTest. Before v3.6.2, you can call these methods only before joining a channel; as of v3.6.2, you can call these methods either before or after joining a channel. After a successful method call, the SDK triggers the following callbacks:
  • reportAudioVolumeIndicationOfSpeakers and reportAudioDeviceTestVolume when you call the methods before joining a channel. Both callbacks report the same volume information. If you upgrade the SDK to v3.6.2 or later, Agora recommendeds using reportAudioDeviceTestVolume.
  • reportAudioDeviceTestVolume when you call the methods after joining a channel.

3. Audio recording

This release extends startAudioRecordingWithConfig with support for setting recording with dual channels and higher audio quality.

• By adding recordingChannel to AgoraAudioRecordingConfiguration, it enables you to set the recorded audio channel to be mono or dual. Because the actual recorded audio channel is related to the captured audio channel and the integration scheme affects the final recorded audio channel, contact technical support for assistance with stereo recording using startAudioRecordingWithConfig.
• By adding AgoraAudioRecordingQualityUltraHigh(3) to AgoraAudioRecordingConfiguration.recordingQuality, it enables you to set the recorded audio quality to ultra-high. Ultra-high quality is the highest quality available in recordingQuality. When you record a 10-minute AAC audio file at a sample rate of 32,000 Hz and ultra-high quality, the file size is approximately 7.5 MB.

4. Screen sharing

This release optimizes the screen capture strategy and increases the upper limit of the screen capture frame rate.

This optimization is only available under the following conditions:

• Fullscreen is shared with startScreenCaptureByDisplayId and windows are not blocked with excludeWindowList.
• The operating system version of the device is higher than 10.11.
• The device model is MacBook Air (2012 and later), MacBook Pro (2012 and later), or MacBook (2015 and later).

For example, under these conditions, when you use a 4K screen for screen sharing, and the capture resolution is 720P, the capture frame rate can now be 30 fps.

5. Music file playback

This release optimizes the experience of calling startAudioMixing to play music files as follows:

• Reduces issues of audio freezes or no audio when playing music files.
• Increases the accuracy of the audio duration reported by getAudioFileInfo.
• Supports more audio file formats. See Which audio file formats does the Agora RTC SDK support.

If you want to experience these improvements, ensure that you have integrated the AgoraFullAudioFormatExtension.xcframework dynamic library. Given the large size of this library, if you have limitations on app size and do not need these improvements, you can remove this dynamic library when integrating the SDK. For more instructions, see Reduce App Size.

6. Audio file formats

This release adds support for playing audio files in the following formats:

• Mono-track online files in MP4 format.
• Multi-track online files in M4A and MP4 formats.

For online MP4 and M4A files, the MOOV atom must be before the MDAT atom.

Fixed issues

This release fixed the following issues:

• Occasionally, remote users could not see the shared screen or saw the shared screen flash black.
• When using the Push method to customize the video source, the resolution of the user's screen occasionally kept changing.
• After you opened a slideshow with the WPS application and called startScreenCaptureByWindowId to enable sharing of the WPS application window, window sharing failed when you switched the slideshow from normal mode to presentation mode or vice verse.
• Audio stuttered under high jitter networks.

API changes

Added

• setVideoDenoiserOptions
• setLowLightEnhanceOptions
• setColorEnhanceOptions
• enableWirelessAccelerate
• wlAccStats
• wlAccMessage
• enableContentInspect
• contentInspectResult
• reportAudioDeviceTestVolume
• recordingChannel in AgoraAudioRecordingConfiguration
• AgoraAudioRecordingQualityUltraHigh(3) in AgoraAudioRecordingConfiguration.recordingQuality
• didProxyConnected
• AgoraTcpProxy(2) in AgoraCloudProxyType

Modified

• Timing restrictions for the startRecordingDeviceTest, startPlaybackDeviceTest, and startAudioDeviceLoopbackTest method calls.
• The behavior of AgoraNoneProxy(0) in AgoraCloudProxyType.

v3.6.1.1

v3.6.1.1 was released on January 16, 2022.

This release fixed the following audio issue:

When an end user muted and unmuted audio from an application using the Agora Web SDK, end users using an application with Native SDK version 3.6.0 might not hear audio from this end user.

v3.6.1

v3.6.1 was released on January 14, 2022.

Improvements

This release provides the following improvements:

• Optimizes the video quality, latency, and performance for screen sharing.
• After a remote user using a Mac device leaves a channel due to the leaveChannel method call, network interruption, or other reasons, the local user sees the remote view stay on the last video frame instead of the remote view directly disappearing as in previous versions.
• Optimizes video rendering methods, which improves compatibility and in video scenarios with a high frame rate or resolution reduces performance overhead.

Fixed issues

This release fixed the following issues:

• The CDN live streaming failed because of the abnormal resolution of the RTMP streaming URL with a port number.
• When you called updateScreenCaptureParameters to update the screen-sharing configuration, windowFocus did not work.

v3.6.0.1

v3.6.0.1 was released on December 13, 2021.

Improvements

To simplify the integration, this release changes sourceId you get using the C++ API getScreenCaptureSources on macOS platforms from an NSNumber pointer to an unsigned int converted by using the value of the pointer address.

Fixed issues

This release fixed the following issues:

• v3.6.0 incorrectly renamed the dynamic library Agorafdkaac.framework to AgoraFDKAAC.framework.

• Crashes occurred when the SDK v3.6.0 was integrated using CocoaPods.

• The following issues occasionally occurred when a user started screen sharing after getting sourceId by calling getScreenCaptureSourcesWithThumbSize (Objective-C) or getScreenCaptureSources (C++):

  • The screen sharing failed.
  • The actually shared screen did not match sourceId.
  • Remote users saw a different mouse position than the actual one during sharing.

• The AgoraThumbImageBuffer object returned by calling getScreenCaptureSourcesWithThumbSize (Objective-C) or the ThumbImageBuffer object returned by calling getScreenCaptureSources (C++) was not in the expected RGBA format.

v3.6.0

v3.6.0 was released on December 7, 2021.

Compatibility changes

Media Push

To reduce the difficulty of integrating Media Push, this release optimizes the API design of Media Push and improves the handling of network issues within Media Push clients and servers. You can experience the optimized Media Push functionality with the following new methods:

• startRtmpStreamWithoutTranscoding: Starts pushing media streams to a CDN without transcoding. This method works the same as the old method addPublishStreamUrl(NO).
• startRtmpStreamWithTranscoding: Starts pushing media streams to a CDN and sets the transcoding configuration. This method works the same as calling the old methods setLiveTranscoding and addPublishStreamUrl(YES) in sequence.
• updateRtmpTranscoding: Updates the transcoding configuration. This method works the same as the non-first call to the old method setLiveTranscoding.
• stopRtmpStream: Stops pushing media streams to a CDN. This method works the same as the old method removePublishStreamUrl.

This release deprecates three old methods for Media Push: addPublishStreamUrl, setLiveTranscoding, and removePublishStreamUrl. Agora recommends that you use the new methods for Media Push and update your code logic by referring to Media Push.

Also, as of this release, whether you use the new or old methods for Media Push, you can experience the following improvements:

• Reporting streaming states, errors, and events:

  • In the AgoraRtmpStreamingState state code, adding AgoraRtmpStreamingStateDisconnecting(5): The SDK is disconnecting from the Agora streaming server and CDN. When you call remove or stop to stop the streaming normally, the SDK reports the streaming state as Disconnecting, Idle in sequence.

  • Adding the following to the AgoraRtmpStreamingErrorCode error code:

    • AgoraRtmpStreamPublishErrorNotBroadcaster(11): The user role is not host, so the user cannot use the Media Push function. Check your application code logic.
    • AgoraRtmpStreamPublishErrorTranscodingNoMixStream(13): The update or setLiveTranscoding method is called to update the transcoding configuration in a scenario where there is streaming without transcoding. Check your application code logic.
    • AgoraRtmpStreamPublishErrorNetDown(14): Errors occurred in the host's network.
    • AgoraRtmpStreamPublishErrorInvalidAppId(15): Your App ID does not have permission to use the Media Push function. Refer to Prerequisites to enable the Media Push permission.

  • Adding the following to the AgoraRtmpStreamingEvent event code:

    • AgoraRtmpStreamingEventAdvancedFeatureNotSupport(3): The feature is not supported.
    • AgoraRtmpStreamingEventRequestTooOften(4): Reserved.
    To ensure the quality of the Media Push, make sure to handle the business logic according to the state code, error code, and event code.

• Adding multiple watermarks and background images during streaming with transcoding: This is achieved by adding watermarkArray and backgroundImageArray to the AgoraLiveTranscoding class.

• Setting the layer number and transparency of each watermark and background image during streaming with transcoding: This is achieved by adding zOrder and alpha to the AgoraImage class.

• Using the HE-AAC v2 audio codec during streaming with transcoding: This is achieved by adding AgoraAudioCodecProfileHEAACv2 to AgoraAudioCodecProfileType.

New features

Following the system default audio device

To help developers more flexibly manage audio device switching, this release adds the following methods：

• getDefaultAudioDevice: Gets the default audio device of the system.
• followSystemPlaybackDevice: Sets the audio playback device used by the SDK to follow the system default audio playback device.
• followSystemRecordingDevice: Sets the audio recording device used by the SDK to follow the system default audio recording device.

On macOS, after initialized, the SDK uses the system default audio device to play and capture audio by default, and always follows the system default audio device. If you do not need the SDK to follow the system default audio device, call followSystemPlaybackDevice(NO) and followSystemRecordingDevice(NO).

Improvements

1. Image enhancement

This release updates the Agora image enhancement algorithm to improve the image enhancement effects that you can enable by calling setBeautyEffectOptions. To balance these image enhancement effects, this release changes the default value of lighteningLevel from 0.7 to 0.6 and adds sharpnessLevel to the BeautyOptions structure to support setting the sharpness level.

As of this release, ensure that you have integrated the AgoraVideoProcessExtension.framework dynamic library before calling setBeautyEffectOptions; otherwise, you cannot experience the optimized image enhancement effects and sharpness adjustment brought out by the updated Agora image enhancement algorithm, but only the image enhancement effects brought out by the older Agora image enhancement algorithm.

2. Rendering of the first remote video frame

This release speeds up rendering of the first remote video frame under poor network conditions to enhance user video experience.

Fixed issues

This release fixed the following issues:

• excludeWindowList did not work.
• Occasionally, remote users saw a short black screen of the shared window during the local user's window sharing.
• Occasionally, Web clients could not hear Native clients.
• Occasionally, the video received by remote users froze after you enabled media stream encryption.
• Remote users saw the screen shared by the local user flicker.

API changes

Added

• startRtmpStreamWithoutTranscoding

• startRtmpStreamWithTranscoding

• updateRtmpTranscoding

• stopRtmpStream

• AgoraRtmpStreamingStateDisconnecting(5) in AgoraRtmpStreamingState

• The following enumerators in AgoraRtmpStreamingErrorCode:

  • AgoraRtmpStreamPublishErrorNotBroadcaster(11)
  • AgoraRtmpStreamPublishErrorTranscodingNoMixStream(13)
  • AgoraRtmpStreamPublishErrorNetDown(14)
  • AgoraRtmpStreamPublishErrorInvalidAppId(15)

• The following enumerators in AgoraRtmpStreamingEvent:

  • RTMP_STREAMING_EVENT_ADVANCED_FEATURE_NOT_SUPPORT(3)
  • RTMP_STREAMING_EVENT_REQUEST_TOO_OFTEN(4)

• watermarkArray and backgroundImageArray in the AgoraLiveTranscoding class

• zOrder and alpha in AgoraImage

• AgoraAudioCodecProfileHEAACv2 in the AgoraAudioCodecProfileType class

• setAVSyncSource

• getDefaultAudioDevice

• followSystemPlaybackDevice

• followSystemRecordingDevice

• sharpnessLevel in the AgoraBeautyOptions class

Modified

Changed the default value of lighteningLevel from 0.7 to 0.6

v3.5.2

v3.5.2 was released on November 25, 2021.

Compatibility changes

Error codes returned when the request to join a channel is rejected

To more accurately report the reason for the failure to join a channel, as of this release, the SDK returns the error code -17(AgoraErrorCodeJoinChannelRejected) in the return value of the joining channel method in the following situations:

• When a user who has already joined an AgoraRtcEngineKit channel calls the joining channel method of the AgoraRtcEngineKit class with a valid channel name.
• When a user who has already joined an AgoraRtcChannel channel calls the joining channel method of this AgoraRtcChannel object.

In the SDK earlier than v3.5.2, when the above errors occur, the SDK might report the error code 17 through the didOccurError callback, or return the error code -5(AgoraErrorCodeRefused) in the return value of the joining channel method.

New features

1. Audio and video recording on the client

To enable users to record local audio and video on their client, this release adds the AgoraMediaRecorder class, which supports recording the following content:

• The audio captured by the local microphone and encoded in AAC format by the SDK.
• The video captured by the local camera and encoded by the SDK.

The generated recording files are saved in the local path specified by the user.

After successfully initializing the AgoraRtcEngineKit object, you can call the following methods and callbacks in the AgoraMediaRecorder class to implement the local audio and video recording function:

• sharedMediaRecorderWithRtcEngine: Creates the AgoraMediaRecorder instance.
• startRecording: Sets the recording content, duration, format of generated files, and callback interval, and enables the local audio and video recording.
• stopRecording: Stops recording the local audio and video.
• destroy: Destroys the AgoraMediaRecorder instance.
• stateDidChanged: Occurs when the recording state changes.
• informationDidUpdated: Occurs when the recording information is updated.

2. Video snapshot

This release adds the takeSnapshot method for taking a snapshot of a video stream from the specified user, generating a JPG image, and saving it to the specified path. After a successful method call, the SDK triggers the snapshotTaken callback to report whether the snapshot is successfully taken as well as the details of the snapshot taken.

3. Testing audio and video call loop

To check whether the local audio device, video device, and network conditions can guarantee the proper sending and receiving of audio and video streams, this release adds the startEchoTestWithConfig method. You can call this method before joining a channel to test whether the loop of a user's audio and video devices and network conditions are working properly.

Compared to startEchoTestWithInterval, startEchoTestWithConfig can test video devices and secure the test, but cannot support setting the time interval for reporting test results.

Improvements

1. Screen sharing

This release adds the getScreenCaptureSourcesWithThumbSize method for you to get a list of all the shareable screens and windows. Users can visually select a particular screen or window to share by using thumbnails in the AgoraScreenCaptureSourceInfo list. In AgoraScreenCaptureSourceInfo, you can also get detailed information about the shared target, including the type of the shared target (window or screen), the window ID or screen ID of the shared target, and the thumbnail and icon of the shared target.

2. Local video errors

To facilitate troubleshooting, this release adds the new error code AgoraLocalVideoStreamErrorCaptureDeviceInvalidId(10) into AgoraLocalVideoStreamError, which indicates that the SDK cannot find the video device in the video device list. Check whether the ID of the video device is valid.

3. Performance improvements

This release slightly reduces CPU usage in video scenarios by optimizing the FEC (Forward Error Correction) codec.

4. Experience improvements

This release improves video sharpness and smoothness under poor network conditions by optimizing the congestion control algorithm.

Fixed issues

This release fixed the following issues:

• The video bitrate failed to climb when a user joined a channel in poor network conditions with high packet loss.
• The video sharpness and smoothness degraded significantly due to a cliff-like drop in video bitrate under certain poor network conditions.
• Remote users heard slightly unsynchronized voice and music when a user called startAudioMixing on some Android devices.
• Echoes could occur when a user joined a channel for the first time.
• After a local user called enableDualStreamMode(NO), a dual stream (high-quality and low-quality video stream) was nevertheless sent when the user switched from custom video capture using setVideoSource with the custom video source in the Screen type to SDK capture.

API changes

This release adds the following APIs:

• startEchoTestWithConfig
• getScreenCaptureSourcesWithThumbSize
• sharedMediaRecorderWithRtcEngine
• stateDidChanged
• informationDidUpdated
• startRecording
• stopRecording
• destroy
• takeSnapshot
• snapshotTaken
• AgoraLocalVideoStreamErrorCaptureDeviceInvalidId(10) in AgoraLocalVideoStreamError

v3.5.1

v3.5.1 was released on October 14, 2021.

New features

1. Background blurring

To enrich the virtual background effects, this release adds support for setting background blur when a user enables the virtual background function by calling enableVirtualBackground. You need to set the type of the custom background image as AgoraVirtualBackgroundBlur and set blur_degree according to the degree of blurring that the user desires.

2. Pausing and resuming the media stream relay across channels

In order to enable the host to quickly pause or resume a cross-channel media stream relay, this release adds the following methods and event code:

• pauseAllChannelMediaRelay: Pauses the media stream relay to all destination channels.
• resumeAllChannelMediaRelay: Resumes the media stream relay to all destination channels.
• AgoraChannelMediaRelayEventPauseSendPacketToDestChannelSuccess(12): The SDK successfully pauses relaying the media stream to destination channels.
• AgoraChannelMediaRelayEventPauseSendPacketToDestChannelFailed(13): The SDK fails to pause relaying the media stream to destination channels.
• AgoraChannelMediaRelayEventResumeSendPacketToDestChannelSuccess(14): The SDK successfully resumes relaying the media stream to destination channels.
• AgoraChannelMediaRelayEventResumeSendPacketToDestChannelFailed(15): The SDK fails to resume relaying the media stream to destination channels.

After a successful method call of pauseAllChannelMediaRelay or resumeAllChannelMediaRelay, the SDK triggers the didReceiveChannelMediaRelayEvent callback to report whether the media stream relay is successfully paused or resumed.

3. Pushing the external audio frame to a specified position

To meet the different processing requirements of external audio frames in different scenarios, this release deprecates pushExternalAudioFrameRawData [1/2] and pushExternalAudioFrameSampleBuffer [1/2], and adds pushExternalAudioFrameRawData [2/2] and pushExternalAudioFrameSampleBuffer [2/2] with sourcePosinstead. You can push the external audio frame to one of three positions: after audio capture, before audio encoding, or before local playback. For example, in the KTV scenario, you can push the singing voice to after audio capture, and push the accompaniment to before audio encoding, so that the singing voice is processed by the SDK audio module, but the accompaniment is not affected by the SDK audio module.

This release also adds setExternalAudioSourceVolume, which enables you to set the volume of external audio frames at a specified position.

4. Advanced settings of the music file

To set the playback speed and channel mode of a music file, this release adds the following methods:

• setAudioMixingPlaybackSpeed: Sets the playback speed of the current music file. Agora recommends a value range of [50,400], where 100 represents the original speed.
• setAudioMixingDualMonoMode: Sets the channel mode of the current music file to original mode, left channel mode, right channel mode, or mixed channel mode.

5. Getting audio file information

To get the information of any audio file, this release deprecates getAudioMixingDuration and adds getAudioFileInfo instead. After joining a channel, you can call getAudioFileInfoand get information such as duration for the specified audio file in didRequestAudioFileInfo.

Improvements

1. Identification and quality testing for 5G mobile networks

This release adds identification and connection quality testing for 5G mobile networks:

• Adds AgoraNetworkTypeMobile5G (6) to AgoraNetworkType. When the local network changes to 5G, the SDK triggers the networkTypeChangedToType callback to report this network connection type.
• Supports calling enableLastmileTest or startLastmileProbeTest to test the connection quality of the 5G mobile network.

2. Other improvements

This release also provides the following improvements:

• Adds continuous optimization of the portrait edge effect of the virtual background.
• After enabling deep-learning noise reduction, the audio experience is improved when using some Bluetooth headsets.

Fixed issues

This release has fixed the following issues:

• updateScreenCaptureRegion failed after a user shared a fullscreen window.
• In the AgoraAudioScenarioGameStreaming scenario, occasional echo or noise that was caused by inaccurate music detection occurred.
• The local user occasionally saw the remote user with a short black screen after the remote user called enableLocalVideo(NO), enableLocalVideo(YES) to disable and enable local video capture or called muteLocalVideoStream(YES), muteLocalVideoStream(NO) to stop and resume sending local video in sequence within a few seconds.
• When the local user called muteAllRemoteAudioStreams and received onRemoteAudioStateChanged (AgoraAudioRemoteReasonLocalMuted), onRemoteAudioStateChanged (AgoraAudioRemoteReasonRemoteMuted) was incorrectly received after 15 seconds.
• As of v3.4.5, the return value was inaccurate when you called joinChannelByToken multiple times in a row.
• When the host used a specific low-end device under certain circumstances, the audience watching the host's video occasionally experience lag.
• Under certain circumstances, when the sender used certain Xiaomi or Redmi devices, the receiver occasionally saw a mosaic square on the received video.
• When the sender used certain Android emulators, the local video or the video received by the receiver was abnormal.
• The method call of enableExternalAudioSourceWithSampleRate before joining the channel did not take effect.
• On some device models, when the audio was played through a speaker, echoes occasionally occurred if the speaker volume was set to the maximum value.
• The SDK additionally triggered the localAudioStateChange callback to report AgoraAudioLocalStateRecording(1) when you called enableLocalAudio(NO) after joining a channel.

API changes

Added

• blur_degree and AgoraBlurDegree in AgoraVirtualBackgroundSource
• AgoraVirtualBackgroundBlur in the AgoraVirtualBackgroundSourceType
• pauseAllChannelMediaRelay
• resumeAllChannelMediaRelay
• The following enumerators in AgoraChannelMediaRelayEvent:
  • AgoraChannelMediaRelayEventPauseSendPacketToDestChannelSuccess
  • AgoraChannelMediaRelayEventPauseSendPacketToDestChannelFailed
  • AgoraChannelMediaRelayEventResumeSendPacketToDestChannelSuccess
  • AgoraChannelMediaRelayEventResumeSendPacketToDestChannelFailed
• pushExternalAudioFrameRawData [2/2]
• pushExternalAudioFrameSampleBuffer [2/2]
• setExternalAudioSourceVolume
• setAudioMixingPlaybackSpeed
• setAudioMixingDualMonoMode
• getAudioFileInfo
• didRequestAudioFileInfo
• AgoraNetworkTypeMobile5G in AgoraNetworkType

Deprecated

• pushExternalAudioFrameRawData [1/2]
• pushExternalAudioFrameSampleBuffer [1/2]
• getAudioMixingDuration

v3.5.0.4

v3.5.0.4 was released on September 26, 2021.

This release fixed the following issues:

• When you used raw video data, the SDK incorrectly triggered the onRenderVideoFrame and onRenderVideoFrameEx callbacks when capturing a local video frame to be rendered.
• Occasional crashes occurred when you used raw video data.
• Repeated declaration of the didAudioMuted, didVideoEnabled, didLocalVideoEnabled, and firstRemoteVideoDecodedOfUid functions occurred in the header file.
• Memory leaked when the value of captureMouseCursor was not NO for screen sharing.
• After you successfully registered the raw video data observer and set the return value of getObservedFramePosition as AgoraVideoFramePositionPreEncoder (1 << 2), the SDK incorrectly triggered a onCaptureVideoFrame callback that did not match the set observation position.

v3.5.0.3

v3.5.0.3 was released on September 6, 2021.

This release fixed the naming conflict existed in the AgoraReachability class between the Agora RTC SDK and Agora RTM SDK.

v3.5.0.2

v3.5.0.2 was released on August 11, 2021.

This release fixed black screen issues that occurred when setupLocalVideo or setupRemoteVideo was called under certain circumstances, such as the following:

• setupLocalVideo(nil) or setupRemoteVideo(nil) was called to disable the local or remote video view, and then setupLocalVideo or setupRemoteVideo was called to initialize the local or remote video view.
• setupRemoteVideo was called in the remoteVideoStateChangedOfUid callback to initialize the remote video view.

v3.5.0.1

v3.5.0.1 was released on August 4, 2021.

This release fixed the following issues:

• Due to the strong reference to AgoraRtcEngineDelegate by AgoraRtcEngineKit, the AgoraRtcEngineDelegate object was released only when AgoraRtcEngineKit was destroyed, which caused a memory leak.
• The user could not receive the onRenderVideoFrame callback from the registered raw video data observer when the setupLocalVideo and setupRemoteVideo methods were not called.

v3.5.0

v3.5.0 was released on July 20, 2021.

Improvements

1. Video quality

This release enhances the video contrast of captured and received video by adapting the color range to moderate the video whiteness.

2. Video capture errors

To help troubleshoot video issues, this release adds the AgoraLocalVideoStreamErrorCaptureDeviceDisconnected (9) error code to AgoraLocalVideoStreamError, which reports that the external camera currently in use has been disconnected (such as being unplugged). If you want video capture to be unaffected, switch to the system default video capture device shortly after you receive this error code.

3. Additional improvements

This release also improves the following:

• In scenarios where the AGC is enabled, the convergence time for noise reduction is shortened, which reduces noise fluctuations.
• The smoothness of output frames in the custom video rendering scenario is improved.

Fixed issues

This release fixed the following issues:

• In some audio scenarios, if a user disabled the speakerphone and then joined a channel, the speakerphone was automatically enabled.
• After calling setAudioDataFrame to register the original audio data callback, and calling enableLoopbackRecording to start the sound card capturing, noises occurred when a user played a local audio file.
• After calling muteLocalAudioStream(YES) to stop publishing a local audio stream, the local user could hear remote users when the local user joined a channel for the first time. After leaving the channel and joining another channel, occasionally the local user could not hear remote users.
• When the local network quality was poor, the downlink network quality rating (rxQuality) of remote users reported by the SDK was not accurate.
• The value of memoryTotalUsageRatio reported by the reportRtcStats callback was not accurate.

API changes

Added

• AgoraLocalVideoStreamErrorCaptureDeviceDisconnected (9) in AgoraLocalVideoStreamError

v3.4.6

v3.4.6 was released on July 15, 2021. This release fixed the following issues:

• Unable to listen to camera hot swapping.
• Failed to run app on Xcode 12 via My Mac (Designed for iPad) on M1 Mac.
• After connecting the UltraStudio Recorder 3G recording device to the app, a user could not record audio through the UltraStudio Recorder 3G.
• The missing nonnull and _Nullable modifiers in Objective-C header files caused warnings when the project was run.

v3.4.5

v3.4.5 was released on June 22, 2021.

Compatibility changes

1. Support for GCM2 encryption

To further improve the security during real-time audio and video transmission process, this release adds the following:

• AgoraEncryptionModeAES128GCM2 (7) and AgoraEncryptionModeAES256GCM2 (8) encryption modes in AgoraEncryptionMode. The new GCM encryption modes use a more secure KDF (Key Derivation Function) and support setting the key and salt.
• The encryptionKdfSalt in AgoraEncryptionConfig to add the salt for the AgoraEncryptionModeAES128GCM2 (7) and AgoraEncryptionModeAES256GCM2 (8) encryption modes.

This release also changes the default encryption mode from AgoraEncryptionModeAES128XTS (1) to AgoraEncryptionModeAES128GCM2 (7). If you use the default encryption mode in earlier versions, after upgrading the SDK to v3.4.5, ensure that you call enableEncryption and set AgoraEncryptionMode to AgoraEncryptionModeAES128XTS (1).

See Media Stream Encryption.

2. Media stream publishing behavior changes

To flexibly control the publishing state in multiple channels, this release optimizes the AgoraRtcChannel class as follows:

• Deprecates the publish and unpublish methods, and adds muteLocalAudioStream and muteLocalVideoStream instead. You can set the publishing state of the audio stream and video stream separately.
• Adds the publishLocalAudio and publishLocalVideo members in AgoraRtcChannelMediaOptions. The default value is YES. You can set the publishing state when joining a channel. If a user publishes streams in a channel, regardless of whether the user is a host or an audience member, you need to set publishLocalAudio and publishLocalVideo to NO when the user joins other channels; otherwise, the user fails to join the channel.
• After calling setClientRole(AgoraClientRoleBroadcaster), the local user publishes audio and video streams by default. You no longer need to call publish.

The above improvements bring the following changes in the AgoraRtcEngineKit class:

• muteLocalAudioStream and muteLocalVideoStream of AgoraRtcEngineKit do not take effect for channels created by the AgoraRtcChannel class, so you need to use the muteLocalAudioStream and muteLocalVideoStream of the AgoraRtcChannel class instead.
• When a user joins a channel by using joinChannelByToken with the options parameter, you can set the publishing state.
• If a user joins a channel by calling joinChannelByToken with the options parameter, muteLocalAudioStream or muteLocalVideoStream only takes effect when it is called after joinChannelByToken.

If you upgrade the SDK to v3.4.5 or later, to avoid affecting your service, Agora recommends modifying the implementation of muteLocalAudioStream, muteLocalVideoStream, publish, and unpublish.

See Set the Publishing State and Join Multiple Channels.

3. Raw audio data

The raw audio data function enables you to implement custom audio pre- and post-processing functions, such as audio recording and audio mixing. To reduce the development difficulty and support the accurate observation of audio data at a specific node, this release optimizes the raw audio data APIs as follows:

• To align with the raw video data API names, changes the name of setAudioFrameDelegate to setAudioDataFrame, and the name of AgoraAudioFrameDelegate to AgoraAudioDataFrameProtocol.
• Adds the following callbacks in AgoraAudioDataFrameProtocol for you to get the raw audio data at different audio transmission stages and in your expected format:
  • getObservedAudioFramePosition: Sets the audio observation positions.
  • getRecordAudioParams: Sets the audio recording format for the onRecordFrame callback.
  • getPlaybackAudioParams: Sets the audio playback format for the onPlaybackFrame callback.
  • getMixedAudioParams: Sets the audio mixing format for the onMixedFrame callback.

If you upgrade the SDK to v3.4.5 or later, to avoid affecting your service, ensure that you modify the implementation of setAudioFrameDelegate and AgoraAudioFrameDelegate.

4. startAudioMixing changes

To avoid blocking, this release changes the startAudioMixing from a synchronous call to an asynchronous call.

New features

Virtual background (beta)

This release adds the enableVirtualBackground method, with which you can enable and set a virtual background for users as either a solid color or an image in PNG or JPG format. You can use the virtualBackgroundSourceEnabled callback to learn whether the virtual background is successfully enabled or the reason for an error.

Improvements

1. Media Push

To be more transparent to users about errors and events in Media Push, this release adds the following codes:

• To rtmpStreamingChangedToState: Error code AgoraRtmpStreamingErrorCodeUnpublishOK (100), which reports that the streaming has been stopped normally. After you call removePublishStreamUrl to stop streaming, the SDK returns this error code and state code AgoraRtmpStreamingStateIdle (0).
• To rtmpStreamingEventWithUrl: Event code AgoraRtmpStreamingEventUrlAlreadyInUse (2), which reports that the streaming URL is already being used for Media Push. If you want to start new streaming, use a new streaming URL.

2. Custom video source

You can use the setVideoSource method to customize a video source, that is, use the MediaIO method for custom video capture. To enhance the flexibility of video capture, as of this release, Agora supports switching from custom video capture by MediaIO to SDK capture directly in the channel. See How can I switch from custom video capture to SDK capture.

3. Media device state

To unify the definition of media device states across platforms, this release modifies the value of the state parameter in the stateChanged callback:

• Changes the definition of 0 from "Added" to "The device is ready for use".
• Changes the value reporting the device is not connected from 1 to 8.

4. Music file state

When you call startAudioMixing after pauseAudioMixing, this release adds the localAudioMixingStateDidChanged(AgoraAudioMixingStateStopped, AgoraAudioMixingReasonStoppedByUser)state, which indicates the music file is stopped, before reporting localAudioMixingStateDidChanged(AgoraAudioMixingStatePlaying, AgoraAudioMixingReasonStartedByUser).

Fixed issues

This release fixed the following issues:

• Under poor network conditions, when you called startAudioMixing to play an online music file, occasionally the SDK response time was too long and caused a freeze.
• Under poor network conditions, users were occasionally unable to switch roles.
• When the user in a channel connected or disconnected a media device, the SDK did not trigger the callback to report the media device's state changes.

API changes

Added

• enableVirtualBackground
• virtualBackgroundSourceEnabled
• AgoraRtmpStreamingErrorCodeUnpublishOK (100) in AgoraRtmpStreamingErrorCode
• AgoraRtmpStreamingEventUrlAlreadyInUse (2) in AgoraRtmpStreamingEvent
• AgoraEncryptionModeAES128GCM2 (7) and AgoraEncryptionModeAES256GCM2 (8) in AgoraEncryptionMode
• encryptionKdfSalt in AgoraEncryptionConfig
• muteLocalAudioStream and muteLocalVideoStream in AgoraRtcChannel
• publishLocalAudio and publishLocalVideo in AgoraRtcChannelMediaOptions
• The following callbacks in AgoraAudioDataFrameProtocol:
  • getObservedAudioFramePosition
  • getRecordAudioParams
  • getMixedAudioParams
  • getPlaybackAudioParams

Modified

• The values of the state parameter in the stateChanged callback
• startAudioMixing
• setAudioFrameDelegate to setAudioDataFrame
• AgoraAudioFrameDelegate to AgoraAudioDataFrameProtocol

Deprecated

• publish and unpublish in AgoraRtcChannel

v3.4.4

v3.4.4 was released on June 18, 2021. This release supports macOS Monterey 12.

v3.4.3

v3.4.3 was released on June 16, 2021.

Improvements

Window sharing

This release supports sharing the slideshow window in the reading view through the window ID.

Fixed issues

This release fixed the following issues:

• The missing nonnull and _Nullable modifiers in Objective-C header files caused warnings when you run the project.
• On some low-end devices of the MacBook Air series, when the start time of audio recording on the client exceeded 5 seconds, the audio device module (ADM) restarted indefinitely.
• The startAudioMixing method could not play the MP3 local music files with the .m4a filename extension.
• After a user of the SDK v3.0.0+ left a communication channel that had any user of the SDK versions earlier than 3.0.0 and switched the channel profile to live streaming, the user of the SDK v3.0.0+ set user role to host before joining the next channel, but the client role setting did not take effect.
• Under certain circumstances, an audio delay occasionally occurred 10 minutes after a user joined the channel.

v3.4.2

v3.4.2 was released on May 12, 2021. This release fixed the following issues:

• Interoperability issues between v3.4.0 or v3.4.1 and versions earlier than v3.0.0:
  • With the Communication channel profile, users of the v3.4.0 or v3.4.1 Native SDK experienced video freezes if they subscribed to videos from users of the Native SDK with versions earlier than v3.0.0.
  • With the LiveBroadcasting channel profile, users of the v3.4.0 or v3.4.1 Native SDK experienced video freezes if they subscribed to videos from users of the Windows or macOS SDK with versions earlier than v3.0.0.
• Occasional crashes.

v3.4.1

v3.4.1 was released on April 22, 2021. This release fixed the following issues：

• Crashes occurred in a certain voice conversion scenario.
• Non-public API usage error, which occurred only in v3.4.0, when you uploaded your app to the Apple App Store.
• Under extremely poor network conditions, the host's video sent from the Web clients was corrupted on the Native clients.

v3.4.0

v3.4.0 was released on April 16, 2021.

Compatibility changes

Integration changes

To reduce the app size after integrating the SDK, this release packages some features as extension libraries (with the Extension suffix). For details, see Extension libraries. If you do not need to use the related features, you can remove the corresponding extension libraries and recompile the project.

Behavior changes

1. Music file playback state

To monitor the reason why the playback state of a music file changes, this release modifies the localAudioMixingStateDidChanged callback as follows:

• Replaces the errorCode parameter with the reason parameter.
• Deprecates AgoraAudioMixingErrorCode and replaces it with AgoraAudioMixingReasonCode instead. Using AgoraAudioMixingReasonCode, you can get the reason for the change of the playback state, such as start, pause, stop or fail.
• Modifies some logic of reporting AgoraAudioMixingStateCode. For example, as of this release, when looping music, the SDK triggers the AgoraAudioMixingStatePlaying state when each loop is completed or starts.

If you upgrade the SDK to v3.4.0 or later, to avoid affecting your service, Agora recommends that you modify the implementation of localAudioMixingStateDidChanged.

2. Volume control of microphone

As of this release, the adjustRecordingSignalVolume method only adjusts the volume of the signal captured by the microphone. If you need to adjust the volume of the signal captured by the sound card, use the adjustLoopbackRecordingSignalVolume method instead.

New features

1. Volume control of sound cards

This release adds the adjustLoopbackRecordingSignalVolume method. You can call this method after calling enableLoopbackRecording to adjust the volume of the signal captured by the sound card.

2. Playback progress of audio effect files

To control the playback progress of audio effect files, this release adds the following methods:

• playEffect3: Sets the playback position when starting playback of an audio effect file by using the startPos parameter.
• setEffectPosition: Sets the playback position after starting playback of an audio effect file.
• getEffectDuration: Gets the duration of a local audio effect file.
• getEffectCurrentPosition: Gets current playback progress of an audio effect file.

Also, this release deprecates the playEffect2 method. You can use playEffect3 instead.

Improvements

1. Video encoding

The Agora SDK allows you to use degradationPreference to set the degradation preference of local video encoding under limited bandwidth, for example, reducing the video frame rate while maintaining video quality, or reducing the video quality while maintaining the video frame rate. As of this release, degradationPreference can be set as AgoraDegradationBalanced, which reduces the video frame rate and video quality simultaneously to strike a balance between smoothness and video quality. AgoraDegradationBalanced is suitable for scenarios where both smoothness and video quality are a priority, such as one-to-one calls, one-to-one online teaching, and multi-user online meetings.

2. Raw video data (C++)

The getRotationApplied and getMirrorApplied callbacks can rotate and mirror the raw video data. To improve the user experience, this release expands the video-data formats supported by these callback functions from RGBA to RGBA and YUV 420.

3. Playback progress of music files

To control the playback progress of music files, this release deprecates the startAudioMixing method and adds a new method with the same name in its place. The new startAudioMixing method allows you to set the playback position when starting playback of a music file by using the startPos parameter.

4. Audio recording

To set the recording configuration during audio recording, this release adds the startAudioRecordingWithConfig method and deprecates startAudioRecording2. The config parameter of the startAudioRecordingWithConfig method allows you to set the audio recording quality, content, sample rate, and storage path of the recording file.

This release also adds a new error code: AgoraErrorCodeAlreadyInRecording(160). If you call the startAudioRecordingWithConfig method again before the current recording ends, the SDK reports this error code.

5. Media device errors

To help users better understand the cause of local video errors, this release adds a new error code to AgoraLocalVideoStreamError: AgoraLocalVideoStreamErrorCaptureNoDeviceFound(8), which indicates that the SDK cannot find the local video-capture device.

Fixed issues

This release fixed the following issues:

• The video was upside down after you used getMirrorApplied to set the mirror mode under certain circumstances.
• You could not get the video data in the RGBA format from onPreEncodeVideoFrame.
• You could not use getMirrorApplied and getRotationApplied to process the local video data before encoding.
• The reportAudioVolumeIndicationOfSpeakers callback returned incorrect volume information after you called enableSoundPositionIndication(YES).
• The user interface of the application got stuck when you called destroy or the get method such as getCallId or getSdkVersion after calling setupLocalVideo or setupRemoteVideo.

API changes

Added

• adjustLoopbackRecordingSignalVolume
• playEffect3
• getEffectDuration
• setEffectPosition
• getEffectCurrentPosition
• startAudioMixing2
• startAudioRecordingWithConfig3
• AgoraLocalVideoStreamErrorCaptureNoDeviceFound(8) in AgoraLocalVideoStreamError
• Error Code: AgoraErrorCodeAlreadyInRecording(160)

Modified

• localAudioMixingStateDidChanged

Deprecated

• startAudioRecording2
• playEffect2
• startAudioMixing1
• AgoraAudioMixingErrorCode

v3.3.2

v3.3.2 was released on March 29, 2021. This release fixed that remote users saw a distorted image when the local user minimized the shared screen with the genie effect on Mac devices.

v3.3.1

v3.3.1 was released on March 4, 2021.

New features

Voice Conversion

This release adds the setVoiceConversionPreset method to set a voice conversion effect (to disguise a user's voice). You can use this method to make a male-sounding voice sound steady or deep, and a female-sounding voice sound gender-neutral or sweet. See Set the Voice Effect.

Improvements

1. AES-GCM encryption mode

For scenarios requiring high security, to guarantee the confidentiality, integrity, and authenticity of data, and to improve the computational efficiency of data encryption, this release adds the following enumerators in AgoraEncryptionMode:

• AgoraEncryptionModeAES128GCM: 128-bit AES encryption, GCM mode.
• AgoraEncryptionModeAES256GCM: 256-bit AES encryption, GCM mode.

2. Remote audio statistics

To monitor quality of experience (QoE) of the local user when receiving a remote audio stream, this release adds mosValue to remoteAudioStats, which reports the quality of the remote audio stream as determined by the Agora real-time audio MOS (Mean Opinion Score) measurement system.

API changes

This release adds the following APIs:

• setVoiceConversionPreset
• AgoraEncryptionModeAES128GCM and AgoraEncryptionModeAES256GCM in AgoraEncryptionMode
• mosValue in AgoraRtcRemoteAudioStats

v3.3.0

v3.3.0 was released on January 22, 2021.

Compatibility changes

1. Integration change

This release adds the following frameworks:

• AgoraCore.framework: The Agora basic calculation framework.
• av1.framework: The AV1 framework for screen sharing.

To integrate the SDK into your project, see Integrate the SDK.

2. Changes to subscribing behavior

This release deprecates setDefaultMuteAllRemoteAudioStreams and setDefaultMuteAllRemoteVideoStreamsand 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.
• Methods with the prefix 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.
• Methods with the prefix 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.

3. Changes to voice activity behavior

In the remote users' reportAudioVolumeIndicationOfSpeakers callback, this release changes the value of the vad member from always 0 to always 1.

New features

1. Native support for the M1 chip

This release adds native support for the M1 chip, which means the Agora SDK supports both x86-64 and arm64 architectures. As of v3.3.0, apps that integrate the Agora SDK can natively run on Mac devices with the M1 chip, and you no longer need to set the Rosetta translation.

2. Channel media options

To help developers control media subscription more flexibly, this release adds the joinChannelByToken2 and switchChannelByToken2 methods to set whether users subscribe to all remote audio or video streams in a channel when joining and switching channels.

3. 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.

4. Deep-learning noise reduction

To eliminate non-stationary noise based on traditional noise reduction, this release adds enableDeepLearningDenoise to enable deep-learning noise reduction.

Before enabling deep-learning noise reduction, integrate the AgoraAIDenoiseExtension.framework dynamic library into your project files.

5. Singing beautifier

To beautify the voice and add reverberation effects in a singing scenario, this release adds the setVoiceBeautifierParameters method and adds the AgoraSingingBeautifier constant to AgoraVoiceBeautifierPreset.

You can call setVoiceBeautifierPreset(AgoraSingingBeautifier) to beautify the male voice and add the reverberation effect for a voice in a small room. For more settings, you can call setVoiceBeautifierParameters(AgoraSingingBeautifier, param1, param2) to beautify male or female voices and add reverberation effects for a voice in a small room, large room, or hall.

6. Log files

To ensure the integrity of log content, this release adds the logConfig property to AgoraRtcEngineConfig. You can use logConfig to set the log files output by the Agora SDK when you initialize AgoraRtcEngineKit. 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.

7. 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.

• Customize the capture resolution: Call the setCameraCapturerConfiguration method to set the capture preference to AgoraCameraCaptureOutputPreferenceManual(3) and set the width and height of the captured video image.
• Listen for abnormalities:
  • The abnormal brightness level of captured video images: Use captureBrightnessLevel in the localVideoStats callback.
  • The camera fails to output the captured video: Use the localVideoStateChange(AgoraLocalVideoStreamStateFailed, AgoraLocalVideoStreamErrorCaptureFailure) callback.
  • The camera repeatedly outputs the captured video: Use the localVideoStateChange(AgoraLocalVideoStreamStateCapturing, AgoraLocalVideoStreamErrorCaptureFailure) callback.

8. 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.

Improvements

1. Raw audio data

This release adds raw audio data APIs for the macOS platform. Once you obtain raw audio data through the following APIs, you can pre-process or post-process it for desired playback effects:

• setAudioFrameDelegate
• onRecordAudioFrame
• onPlaybackAudioFrame
• onMixedAudioFrame
• onPlaybackAudioFrameBeforeMixing

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 AgoraRtcRemoteAudioStats, which report QoE of the local user and the reason for poor QoE, respectively.

API changes

Added

• setVoiceBeautifierParameters
• AgoraSingingBeautifier in the AgoraVoiceBeautifierPreset constant
• enableDeepLearningDenoise
• joinChannelByToken2
• switchChannelByToken2
• createDataStream
• The logConfig property in the AgoraRtcEngineConfig class
• setAudioFrameDelegate
• onRecordAudioFrame
• onPlaybackAudioFrame
• onMixedAudioFrame
• onPlaybackAudioFrameBeforeMixing
• The qoeQuality and qualityChangedReason properties in the AgoraRtcRemoteAudioStats class
• setCloudProxy
• The captureBrightnessLevel property in the AgoraRtcLocalVideoStats class
• The captureWidth and captureHeight properties in the AgoraCameraCapturerConfiguration class
• AgoraCameraCaptureOutputPreferenceManual(3) in the AgoraCameraCaptureOutputPreference constant
• Error code: AgoraErrorCodeModuleNotFound(157)

Deprecated

• setDefaultMuteAllRemoteVideoStreams
• setDefaultMuteAllRemoteAudioStreams
• setLogFile
• setLogFileSize
• setLogFilter
• createDataStream

v3.2.1

v3.2.1 was released on December 17, 2020. This release fixed the following issues:

• Crashes occurred when using IPv6.
• After you called enableEncryption, the SDK did not trigger the firstLocalVideoFramePublished callback.

v3.2.0

v3.2.0 was released on November 30, 2020.

Compatibility changes

1. Integration change

Since v3.2.0, the following files have been added to the SDK package:

• Agorafdkaac.framework: The Fraunhofer FDK AAC dynamic library.
• AgoraSoundTouch.framework: The SoundTouch dynamic library.
• Agoraffmpeg.framework: The FFmpeg dynamic library.

If you upgrade the SDK to v3.2.0 or later, refer to the following steps to add the above dynamic libraries when integrating the SDK:

1. Copy the above files to the folder where the AgoraRtcKit.framework file is located.
2. Open Xcode, go to TARGETS > Project Name > General > Frameworks, Libraries, and Embedded Content menu, click +, then click Add Other… to add Agorafdkaac.framework, AgoraSoundTouch.framework, and Agoraffmpeg.framework. Ensure the status of these dynamic libraries is Embed & Sign.

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.

New features

1. Image enhancement

To enable image enhancement in scenarios such as video social networking, an online class, or live interactive streaming, this release adds setBeautyEffectOptions. You can call this method to set parameters including contrast, brightness, smoothness, and red saturation.

2. 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:

• Set the latency level as ultra low latency to use Interactive Live Streaming Premium.
• Set the latency level as low latency to use Interactive Live Streaming Standard.

For details, see the product overview of Interactive Live Streaming Standard.

Improvements

1. Meeting scenario

To improve the user experience in the meeting scenario, this release adds the following:

• Audio profile: To improve the audio experience for multi-person meetings, this release adds AgoraAudioScenarioMeeting(8) in setAudioProfile.
• Screen sharing:
  • To allow a user to enable shared slides in presentation mode, this release adds support for enabling the shared window (such as slides, web video, or web document) in full-screen mode during the window sharing.
  • This release adds the AgoraLocalVideoStreamErrorScreenCaptureWindowClosed(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.
  • This release optimizes smoothness and image quality of screen sharing with the AgoraVideoContentHintDetails 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. Media Push with transcoding

This release adds the videoCodecType member to the AgoraLiveTranscoding class for setting the codec type of the transcoded video stream to H.264 or H.265.

4. Interactive streaming delay

This release reduces the latency on the audience's client during an interactive live streaming by about 500 ms.

Issues fixed

This release fixed the following issues:

• Users could not hear the audio when calling with AirPods.
• When other video apps were running, the SDK could not turn on the local camera.
• When calling enumerateDevices, the SDK unnecessarily requested permission to use the microphone.

API changes

Added

• setClientRole
• setBeautyEffectOptions
• setAudioEffectPreset
• setVoiceBeautifierPreset
• setAudioEffectParameters
• AgoraAudioScenarioMeeting(8) in AgoraAudioScenario
• AgoraLocalVideoStreamErrorScreenCaptureWindowClosed(12) in AgoraLocalVideoStreamError enum

Deprecated

• setLocalVoiceChanger
• setLocalVoiceReverbPreset
• getSmoothRenderingEnabled (C++)

v3.1.2

v3.1.2 was released on September 15, 2020.

This release fixed the issue that the firstLocalVideoFrameWithSize and firstRemoteVideoFrameOfUid callbacks are not triggered at the right time.

v3.1.1

v3.1.1 was released on August 27, 2020.

Compatibility changes

This release changes the AgoraAreaCode for regional connection. The latest area codes are as follows:

• AgoraAreaCodeCN: Mainland China.
• AgoraAreaCodeNA: North America.
• AgoraAreaCodeEU: Europe.
• AgoraAreaCodeAS: Asia, excluding Mainland China.
• AgoraAreaCodeJP: Japan.
• AgoraAreaCodeIN: India.
• AgoraAreaCodeGLOB: (Default) Global.

If you have specified a region for connection when calling sharedEngineWithConfig, ensure that you use the latest area code when migrating from an earlier SDK version.

v3.1.0

v3.1.0 was released on August 11, 2020.

New features

1. Publishing and subscription states

This release adds the following callbacks to report the current publishing and subscribing states:

• didAudioPublishStateChange: Reports the change of the audio publishing state.
• didVideoPublishStateChange: Reports the change of the video publishing state.
• didAudioSubscribeStateChange: Reports the change of the audio subscribing state.
• didVideoSubscribeStateChange: Reports the change of the video subscribing state.

2. First local frame published callback

This release adds the firstLocalAudioFramePublished and firstLocalVideoFramePublished callbacks to report that the first audio or video frame is published. The firstLocalAudioFrame 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.

Improvement

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.

• AgoraIpAreaCode_JAPAN: Japan.
• AgoraIpAreaCode_INDIA: India.

2. Advanced screen sharing

This release adds the following features for screen sharing:

• Bringing the window to the front: By adding the windowFocus member to the AgoraScreenCaptureParameters class.
• Excluding specified windows from screen sharing: By adding the excludeWindowList member to the AgoraScreenCaptureParameters class.
• Reporting more specific local video states during a screen share: By adding the state code AgoraLocalVideoStreamStateCapturing(1) and the error code AgoraLocalVideoStreamErrorScreenCaptureWindowMinimized(11) to the localVideoStateChange callback.
• Getting the capture type of the custom video source: By adding the captureType callback to the AgoraVideoSourceProtocol protocol.
• Getting the content hint of the custom video source: By adding the contentHint callback to the AgoraVideoSourceProtocol protocol.

3. Media Push

This release adds the rtmpStreamingEventWithUrl callback to report events during Media Push, 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:

• Adds txPacketLossRate in AgoraRtcLocalAudioStats, which represents the audio packet loss rate (%) from the local client to the Agora edge server before applying anti-packet loss strategies.
• Adds the following attributes in AgoraRtcLocalVideoStats:
  • 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.
• Adds publishDuration in AgoraRtcRemoteAudioStats and AgoraRtcRemoteVideoStats, 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
AgoraAudioProfileDefault	For the interactive streaming profile: 64 Kbps For the communication profile: 18 Kbps	For the interactive streaming profile: 52 Kbps For the communication profile: 18 Kbps
AgoraAudioProfileSpeechStandard	18 Kbps	18 Kbps
AgoraAudioProfileMusicStandard	64 Kbps	48 Kbps
AgoraAudioProfileMusicStandardStereo	80 Kbps	56 Kbps
AgoraAudioProfileMusicHighQuality	96 Kbps	128 Kbps
AgoraAudioProfileMusicHighQualityStereo	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 create a new agorasdk.log to record the latest logs.

8. Audio route

To play audio on more devices, this release adds four enumerators in AgoraAudioOutputRouting, and supports USB, HDMI, DisplayPort peripherals, and Apple AirPlay.

9. Video experience under poor network conditions

• Starting with this release, the SDK automatically reduces video resolution under poor network conditions in order to improve the smoothness of the video.
• This release improves video quality by ensuring that the video does not become blurry due to changing network conditions.

Issues fixed

This release fixed the issue that the app failed to record any audio because the audio device module failed to start.

API changes

Added

• didAudioPublishStateChange
• didVideoPublishStateChange
• didAudioSubscribeStateChange
• didVideoSubscribeStateChange
• firstLocalAudioFramePublished
• firstLocalVideoFramePublished
• enableEncryption
• txPacketLossRate in AgoraRtcLocalAudioStats class
• txPacketLossRate and captureFrameRate in AgoraRtcLocalVideoStats class
• publishDuration in AgoraRtcRemoteAudioStats and AgoraRtcRemoteVideoStats class
• windowFocus and excludeWindowList in AgoraScreenCaptureParameters class
• AgoraLocalVideoStreamStateCapturing(1) in AgoraLocalVideoStreamState class
• AgoraLocalVideoStreamErrorScreenCaptureWindowMinimized(11) in AgoraLocalVideoStreamError class
• captureType and contentHint in AgoraVideoSourceProtocol protocol
• rtmpStreamingEventWithUrl
• Warning code: AgoraWarningCodeAdmCategoryNotPlayAndRecord(1029) and AgoraWarningCodeApmResidualEcho(1053)
• Error code: AgoraErrorCodeNoServerResources(103)

Deprecated

• setEncryptionSecret
• setEncryptionMode
• firstLocalAudioFrame

Deleted

• Warning code: AgoraWarningCodeAdmImproperSettings(1053)

v3.0.1.1

v3.0.1.1 was released on Jun 18, 2020. This release fixed the crashes after calling registerVideoRenderFactory (deprecated).

v3.0.1

v3.0.1 was released on May 27, 2020.

Compatibility changes

1. Dynamic library

This release replaces the static library with a dynamic library for the following reasons:

• Improving overall security.
• Avoiding incompatibility issues with other third-party libraries.
• Making it easier to upload the app to the App Store.

To upgrade the RTC Native SDK, you must re-integrate the dynamic library, AgoraRtcKit.framework. This process should take no more than five minutes. See Migration Guide.

2. Frame position for the video observer (C++)

As of this release, to get the video frame from the onPreEncodeVideoFrame callback, you must set POSITION_PRE_ENCODER(1<<2) in getObservedFramePosition as the frame position to observe, as well as implementing the onPreEncodeVideoFrame callback.

New features

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:

• AgoraAudioVoiceChanger adds several elements that have the prefixes AgoraAudioVoiceBeauty and AgoraAudioGeneralBeautyVoice. The AgoraAudioVoiceBeauty elements enhance the local voice, and the AgoraAudioGeneralBeautyVoice enumerations add gender-based enhancement effects.
• AgoraAudioReverbPreset adds the enumeration AgoraAudioReverbPresetVirtualStereo and several enumerations that have the prefix AgoraAudioReverbPresetFx. The AgoraAudioReverbPresetVirtualStereo enumeration implements reverberation in the virtual stereo, and the AgoraAudioReverbPresetFx enumerations implement additional enhanced reverberation effects.

See Set the Voice Changer and Reverberation Effects for more information.

3. Face detection

This release enables local face detection. After you call enableFaceDetection to enable this function, the SDK triggers the facePositionDidChangeWidth callback in real time to report the detection results, including the distance between the human face and the device screen. This function can remind users to keep a certain distance from the screen.

4. Fill mode

To improve the user experience of watching videos, this release adds a video display mode AgoraVideoRenderModeFill(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

5. Remote video renderer in multiple channels

This release adds setRemoteVideoRenderer and remoteVideoRendererOfUserId in the AgoraRtcChannel class to enable users who join the channel using the AgoraRtcChannel object to customize the remote video renderer.

6. Data post-processing in multiple channels (C++)

This release adds support for post-processing remote audio and video data in a multi-channel scenario by adding the following C++ methods:

• The IAudioFrameObserver class: isMultipleChannelFrameWanted and onPlaybackAudioFrameBeforeMixingEx.
• The 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.

Improvements

Frame position (C++)

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:

• The position after capturing the video frame.
• The position before receiving the remote video frame.
• The position before encoding the frame.

Fixed issues

• This release fixed audio mixing issues.
• This release fixed issues relating to authentication with an App ID and a token.

API changes

This release adds the following APIs:

• setAudioMixingPitch
• Several elements that have the prefixes AgoraAudioVoiceBeauty and AgoraAudioGeneralBeautyVoice in the AgoraAudioVoiceChanger enumeration
• AgoraAudioReverbPresetVirtualStereo and several elements that have the prefixes AgoraAudioReverbPresetFx in the AgoraAudioReverbPreset enumeration
• enableFaceDetection
• facePositionDidChangeWidth
• AgoraVideoRenderModeFill in the AgoraVideoRenderMode enumeration
• setRemoteVideoRenderer and remoteVideoRendererOfUserId in the AgoraRtcChannel class
• totalActiveTime in the AgoraRtcRemoteAudioStats class
• totalActiveTime in the AgoraRtcRemoteVideoStats class

v3.0.0.2

v3.0.0.2 was released on Apr 22, 2020.

New features

Specifying the area of connection

This release adds sharedEngineWithConfig for specifying the area of connection when creating an AgoraRtcEngineKit 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:

• When the app that integrates the Agora SDK is used within the specified area, it connects to the Agora servers within the specified area under normal circumstances.
• When the app that integrates the Agora SDK is used out of the specified area, it connects to the Agora servers either in the specified area or in the area where the SDK is located.

Issues fixed

This release fixed issues relating to no audio, disconnecting from a Bluetooth device after joining a channel, and the occasional failure to join a channel.

API changes

Added

sharedEngineWithConfig

v3.0.0

v3.0.0 was released on Mar 4, 2020.

In this release, Agora improves the user experience under poor network conditions for both the Communication and LiveBroadcasting profiles through the following measures:

• Adopting a new architecture for the Communication profile.
• Upgrading the last-mile network strategy for both the Communication and LiveBroadcasting 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.

Compatibility changes

1. Renaming the static library and adding support for dynamic library

To unify the library names across platforms, this release renames the library from AgoraRtcEngineKit.framework to AgoraRtcKit.framework. If you upgrade your SDK to v3.0.0, you must re-import the AgoraRtcKit class. For details, see Import the class in the Quickstart.

To improve your development experience, this release also adds support for the dynamic library. You can integrate either the static or the dynamic library in your project, and the name of the dynamic library package is Agora_Native_SDK_for_macOS_v3_0_0_FULL_Dynamic.

Integrating the dynamic library has the following advantages:

• The overall security level is improved.
• Incompatibility issues with other third-party libraries are avoided.
• Uploading the app onto App Store is easier.

If you prefer the dynamic library, you need to re-integrate the SDK and re-import the AgoraRtcKit class. This process should take no more than five minutes. See Integrate the SDK and Import the class in the Quickstart.

2. 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 (YES) method after joining the channel to enable it. In video scenarios with multiple users, we recommend enabling the dual-stream mode.

New features

1. Multiple channel management

To enable a user to join an unlimited number of channels at a time, this release adds the AgoraRtcChannel and AgoraRtcChannelDelegate classes. By creating multiple AgoraRtcChannel 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.

Improvements

1. Audio profiles

To meet the need for higher audio quality, this release adjusts the corresponding audio profile of AgoraAudioProfileDefault(0) in the LiveBroadcasting profile.

SDK	AgoraAudioProfileDefault(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	A sample rate of 32 KHz, music encoding, mono, and a bitrate of up to 52 Kbps.

2. Mirror mode

The mirror mode determines how the SDK mirrors the video in different stages of transmission. This release supports setting the video mirror mode when encoding and rendering the video:

• Setting a mirror mode for the stream to be encoded: This release adds the mirrorMode member to the AgoraVideoEncoderConfiguration struct struct for setting a mirror effect for the stream to be encoded and transmitted.
• Setting a mirror mode for the streams to be rendered:
  • We add the mirrorMode member to the AgoraRtcVideoCanvas 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.
  • This release also adds the 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.

3. Quality statistics

Adds the following members in the AgoraChannelStats 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. Others

This release enables interoperability between the Native SDK and the Web SDK by default, and deprecates the enableWebSdkInteroperability method.

Issues fixed

• Audio issues concerning audio mixing, audio encoding, and echo.
• Video issues concerning the watermark, video aspect ratio, video sharpness, full-screen video, and black outline during the screen share.
• Other issues related to app crashes, log file, and unstable service when pushing streams to the CDN.

API changes

Behavior change

• Calling enableLocalAudio (NO) does not change the in-call volume to media volume.
• When connected to a headset or Bluetooth, the macOS device changes its audio route to be uniform as the audio route shown in the device manager.

Added

• setLocalRenderMode
• setRemoteRenderMode
• The mirrorMode parameter in the AgoraVideoEncoderConfiguration struct
• The mirrorMode and channelId parameter in the AgoraRtcVideoCanvas struct
• The channelId parameter in the AgoraRtcAudioVolumeInfo struct
• createRtcChannel
• AgoraRtcChannel class
• AgoraRtcChannelDelegate class
• The gatewayRtt, memoryAppUsageRatio, memoryTotalUsageRatio and memoryAppUsageInKbytes members in the AgoraChannelStats class

Deprecated

• enableWebSdkInteroperability
• setLocalRenderMode¹. Use the new setLocalRenderMode method instead.
• setRemoteRenderMode¹. Use the new setRemoteRenderMode method instead.
• setLocalVideoMirrorMode. Use the mirrorMode parameter in the setupLocalVideo and setLocalRenderMode methods instead.
• firstRemoteAudioFrameDecodedOfUid and firstRemoteAudioFrameOfUid. Use the remoteAudioStateChangedOfUid callback instead.
• streamPublishedWithUrl and streamUnpublishedWithUrl. Use the rtmpStreamingChangedToState callback instead.

v2.9.3

v2.9.3 was released on Feb 10, 2020.

This release fixed the following issues:

• The setRemoteSubscribeFallbackOption method, which should work in the LiveBroadcasting profile only, also works in the Communication profile.
• In some one-to-one communication, the downlink media stream falls back to audio-only under poor network conditions.
• Occasionally, the UI of the system window is abnormal on macOS 10.15.

v2.9.1

v2.9.1 is released on Sep 19, 2019.

New features

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 AgoraRtcAudioVolumeInfo struct of the reportAudioVolumeIndicationOfSpeakers 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 C++ method getVideoFormatPreference to set the format of the raw video data format.

You can also rotate or mirror the RGBA raw data using the C++ methods getRotationApplied or getMirrorApplied respectively.

Improvements

1. Improving the watermark function in interactive live streaming

This release adds a new addVideoWatermark method with the following settings:

• The visibleInPreview member sets whether the watermark is visible in the local preview.
• The 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.

Issues fixed

Video

The return value of the getDeviceInfo method does not match the actual available device.

API changes

To improve the user experience, we made the following changes in v2.9.1:

Added

• startAudioRecording
• addVideoWatermark
• getVideoFormatPreference
• getRotationApplied
• getMirrorApplied
• The report_vad parameter in the enableAudioVolumeIndication method
• The vad member in the AgoraRtcAudioVolumeInfo class

Deprecated

• startAudioRecording
• addVideoWatermark

v2.9.0

v2.9.0 is released on Aug. 16, 2019.

Compatibility changes

1. Media Push

In this release, we deleted the following methods:

• configPublisher
• setVideoCompositingLayout
• clearVideoCompositingLayout

If your app implements Media Push with the methods above, ensure that you upgrade the SDK to the latest version and use the following methods for the same function:

• setLiveTranscoding
• addPublishStreamUrl
• removePublishStreamUrl
• rtmpStreamingChangedToState

For how to implement the new methods, see Media Push.

2. Reporting the state of the remote video

This release extends the remoteVideoStateChangedOfUid 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 remoteVideoStateChangedOfUid callback is deleted. If you upgrade your Native SDK to the latest version, ensure that you re-implement the remoteVideoStateChangedOfUid callback.

The new callback reports most of the remote video states, and therefore deprecates the firstRemoteVideoDecodedOfUid callback. You can still use it, but we do not recommend doing so.

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.

New features

1. Faster switching to another channel

This release adds the switchChannelByToken method to enable the audience in an interactive streaming channel to quickly switch to another channel. With this method, you can achieve a much faster switch than with the leaveChannel and joinChannelByToken methods. After the audience successfully switches to another channel by calling the switchChannelByToken method, the SDK triggers the didLeaveChannelWithStats and didJoinChannel 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 interactive streaming channels interact with each other.

• startChannelMediaRelay
• updateChannelMediaRelay
• stopChannelMediaRelay

During the media stream relay, the SDK reports the states and events of the relay with the channelMediaRelayStateDidChange and didReceiveChannelMediaRelayEvent 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 localAudioStateChange and remoteAudioStateChangedOfUid callbacks to report the local and remote audio states. With these callbacks, the SDK reports the following states for the local and remote audio:

• The local audio: Stopped(0), Recording(1), Encoding(2), or Failed(3). When the state is Failed(3), see the error parameter for troubleshooting.
• The remote audio: Stopped(0), Starting(1), Decoding(2), Frozen(3), or Failed(4). See the reason parameter for why the remote audio state changes.

4. Reporting the local audio statistics

This release adds the localAudioStats 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.

5. Pulling the remote audio data

To improve the experience in audio playback, this release adds the following methods to pull the remote audio data. After getting the audio data, you can process it and play it with the audio effects that you want.

• enableExternalAudioSink
• disableExternalAudioSink
• pullPlaybackAudioFrameRawData
• pullPlaybackAudioFrameSampleBufferByLengthInByte

The difference between the onPlaybackAudioFrame callback and the pullPlaybackAudioFrameRawData / pullPlaybackAudioFrameSampleBufferByLengthInByte method is as follows:

• onPlaybackAudioFrame: The SDK sends the audio data to the app once every 10 ms. Any delay in processing the audio frames may result in an audio delay.
• pullPlaybackAudioFrameRawData / pullPlaybackAudioFrameSampleBufferByLengthInByte: The app pulls the remote audio data. After setting the audio data parameters, the SDK adjusts the frame buffer and avoids problems caused by jitter in external audio playback.

Improvements

1. Reporting more statistics of the in-call quality

This release adds the following statistics in the AgoraChannelStats, AgoraRtcLocalVideoStats, and AgoraRtcRemoteVideoStats classes:

• AgoraChannelStats: The total number of the sent audio bytes, sent video bytes, received audio bytes, and received video bytes during a session.
• AgoraRtcLocalVideoStats: The encoding bitrate, the width and height of the encoding frame, the number of frames, and the codec type of the local video.
• AgoraRtcRemoteVideoStats: The packet loss rate of the remote video.

2. Improving the interactive live video streaming quality

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. Other improvements

• Improves the audio quality when the audio scenario is set to GameStreaming.
• Improves the audio quality after the user disables the microphone in the Communication profile.

Issues fixed

Audio

• When interoperating with a Web app, voice distortion occurs after the native app enables the remote sound position indication.
• Crashes occur when testing the microphone.

Video

• Video freezes.

Miscellaneous

• Occasionally mixed streams in Media Push.

API changes

To improve the user experience, we made the following changes in v2.9.0:

Added

• enableExternalAudioSink
• disableExternalAudioSink
• pullPlaybackAudioFrameRawData
• pullPlaybackAudioFrameSampleBufferByLengthInByte
• localAudioStateChange
• remoteAudioStateChangedOfUid
• remoteVideoStateChangedOfUid
• localAudioStats
• switchChannelByToken
• startChannelMediaRelay
• updateChannelMediaRelay
• stopChannelMediaRelay
• channelMediaRelayStateDidChange
• didReceiveChannelMediaRelayEvent
• AgoraChannelStats: txAudioBytes, txVideoBytes, rxAudioBytes and rxVideoBytes
• AgoraRtcLocalVideoStats: encodedBitrate, encodedFrameWidth, encodedFrameHeight, encodedFrameCount and codedType
• AgoraRtcRemoteVideoStats: packetLossRate

Deprecated

• didMicrophoneEnabled. Use AgoraAudioLocalStateStopped(0) or AgoraAudioLocalStateRecording(1) in the localAudioStateChange callback instead.
• audioTransportStatsOfUid. Use the remoteAudioStats callback instead.
• videoTransportStatsOfUid. Use the remoteVideoStats callback instead.

Deleted

• configPublisher
• setVideoCompositingLayout
• clearVideoCompositingLayout
• remoteVideoStateChangedOfUid

v2.8.0

v2.8.0 is released on Jul. 8, 2019.

New features

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:

• registerLocalUserAccount
• joinChannelByUserAccount

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 communication, 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.

Note:

• Do not mix parameter types within the same channel. The following Agora SDKs support string user accounts:

  • The Native SDK: v2.8.0 and later.
  • The Web SDK: v2.5.0 and later.

  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 AgoraRtcRemoteAudioStats and AgoraRtcRemoteVideoStats 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 AgoraRtcRemoteAudioStats class.

Improvements

This release adds a AgoraConnectionChangedKeepAliveTimeout(14) member to the AgoraConnectionChangedReason parameter of the connectionChangedToState 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.

Issues fixed

Video

• Occasional deadlocks when calling the MediaIO methods.

Miscellaneous

• Occasional crashes.

API changes

To improve your experience, we made the following changes to the APIs:

Added

• registerLocalUserAccount
• joinChannelByUserAccount
• getUserInfoByUid
• getUserInfoByUserAccount
• didRegisteredLocalUser
• didUpdatedUserInfo
• The numChannels, receivedSampleRate, receivedBitrate, totalFrozenTime, and frozenRate members in the AgoraRtcRemoteAudioStats class
• The totalFrozenTime and frozenRate members in the AgoraRtcRemoteVideoStats class

Deprecated

• The lowLatency member in the AgoraLiveTranscoding class

v2.4.1

V2.4.1 is released on Jun 12th, 2019.

Compatibility changes

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 Media Push service, v2.4.1 defines the following parameter limits:

Class / Interface	Parameter Limit
AgoraLiveTranscoding	videoFrameRate: Frame rate (fps) of the CDN live output video stream. The value range is [0, 30], and the default value is 15. Agora adjusts all values over 30 to 30. videoBitrate: Bitrate (Kbps) of the RTMP live output video stream. The default value is 400. Set this parameter according to the Video Bitrate Table. If you set a bitrate beyond the proper range, the SDK automatically adapts it to a value within the range. videoCodecProfile: The video codec profile. Set it as BASELINE, MAIN, or HIGH (default). If you set this parameter to other values, Agora adjusts it to the default value of HIGH. size: Pixel of the video. The minimum value of size is 16 x 16.
AgoraImage	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 streamPublishedWithUrl method for quick troubleshooting.

2. Renaming the receivedFrameRate parameter in the RemoteVideoStats class

v2.4.1 renames the receivedFrameRate parameter to rendererOutputFrameRate in the AgoraRtcRemoteVideoStats class to more accurately describe the statistics of the remote video stream.

New features

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. v2.4.1 adds the setMediaMetadataSource and the setMediaMetadataDelegate interface and the AgoraMediaMetadataDataSource and the AgoraMediaMetadataDelegate protocol, 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:

• If the value of the screen dimensions is lower than that of the encoding dimensions, for example, 1000 x 1000 pixels, the SDK uses 1000 x 1000 pixels for encoding.
• If the value of the screen 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 the AgoraScreenCaptureParameters 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 AgoraScreenCaptureParameters class and captures the mouse by default.

3. State of the local video

v2.4.1 adds the localVideoStateChange 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 rtcEngineCameraDidReady and rtcEngineVideoDidStop callbacks.

4. State of the Media Push

v2.4.1 adds the rtmpStreamingChangedToState callback to indicate the state of the Media Push and help you troubleshoot issues when exceptions occur. In this callback, the SDK returns the Idle, Connecting, Runing, Recovering, or Failure state. When the state is Failure, you can use the error code for troubleshooting. You can still use the streamPublishedWithUrl and streamUnpublishedWithUrl 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 connectionChangedToState callback whenever the connection state changes. This release also deprecates AgoraWarningCodeLookupChannelRejected(105), AgoraErrorCodeTokenExpired(109), and AgoraErrorCodeInvalidToken(110).

*6. State of the local network type *

v2.4.1 adds the networkTypeChangedToType 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 firstRemoteAudioFrameDecodedOfUid callback to report to the app that the SDK decodes first remote audio. This callback is triggered in either of the following scenarios:

• The remote user joins the channel and sends the audio stream.
• The remote user stops sending the audio stream and re-sends it after 15 seconds.

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.

Improvements

1. Reporting more statistics

• v2.4.1 adds the txPacketLossRate and rxPacketLossRate parameters in the AgoraChannelStats 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:

  • AgoraRtcLocalVideoStats: Adds the encoderOutputFrameRate and rendererOutputFrameRate parameters
  • AgoraRtcRemoteVideoStats: Adds the decoderOutputFrameRate parameter, and renames the receivedFrameRate parameter to the rendererOutputFrameRate parameter

2. Miscellaneous

• Improved the sound quality of the GameStreaming audio scenario.
• Reduced the audio and video latency.
• Reduced the SDK package size by 0.5 M.
• Improved the accuracy of the network quality after users change the video bitrate.
• Enabled the audio quality notification callback by default, that is, enabled the remoteAudioStats callback without calling the enableAudioVolumeIndication method.
• Improved the stability of video services.
• Improved the stability of Media Push.

Issues fixed

Video

• The user cannot switch between the screen sharing stream and the camera stream.

Miscellaneous

• Users still receive the onNetworkQuality callback after leaving the channel.
• Occasional crashes.

API changes

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

• getAudioMixingPlayoutVolume
• getAudioMixingPublishVolume
• firstRemoteAudioFrameDecodedOfUid
• localVideoStateChange
• networkTypeChangedToType
• rtmpStreamingChangedToState
• setMediaMetadataSource
• setMediaMetadataDelegate
• AgoraMediaMetadataSource
• AgoraMediaMetadataDelegate
• The audioCodecProfile parameter in the LiveTranscoding class
• The captureMouseCursor parameter in the AgoraScreenCaptureParameters class
• The txPacketLossRate and rxPacketLossRate parameters in the AgoraChannelStats class
• The encoderOutputFrameRate and rendererOutputFrameRate parameters in the AgoraRtcLocalVideoStats class
• The decoderOutputFrameRate and rendererOutputFrameRate (to replace receivedRemoteRate) parameters in the AgoraRtcRemoteVideoStats class

Deprecated

• enableAudioQualityIndication
• rtcEngineCameraDidReady. Use AgoraLocalVideoStreamStateCapturing(1) in the localVideoStateChange callback instead.
• rtcEngineVideoDidStop. Use AgoraLocalVideoStreamStateStopped(0) in the localVideoStateChange callback instead.
• The AgoraWarningCodeLookupChannelRejected(105) warning code. Use AgoraConnectionChangedRejectedByServer(10) in the connectionChangedToState callback instead.
• The AgoraErrorCodeTokenExpired(109) error code. Use AgoraConnectionChangedTokenExpired(9) in the connectionChangedToState callback instead.
• The AgoraErrorCodeInvalidToken(110) error code. Use AgoraConnectionChangedInvalidToken(8) in the connectionChangedToState callback instead.
• The AgoraErrorCodeStartCamera(1003) error code. Use AgoraLocalVideoStreamErrorCaptureFailure(4) in the localVideoStateChange callback instead.

v2.4.0 and Earlier

v2.4.0

v2.4.0 is released on April 1, 2019.

Compatibility changes

If you integrate the SDK by using CocoaPods，ensure that you run pod update in your Terminal before pod install. If you prefer to specify the SDK version to obtain the latest release, ensure that you specify it as 'AgoraRtcEngine_macOS', '2.4.0.1' in the Podfile.

New features

1. Advanced screen sharing

v2.4.0 upgrades screen sharing and provides the following advanced functions:

• Shares the whole or part of a specified screen in a multi-display environment (startScreenCaptureByDisplayId).
• Shares the whole or part of a specified window (startScreenCaptureByWindowId).
• Sets the content hint of the screen sharing to prioritize motion or detail (setScreenCaptureContentHint).
• Sets the dimensions, frame rate and bitrate for screen sharing (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 displayId and windowId. For more information, see Share the Screen.

2. Voice changer and voice reverberation

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. See Adjust the pitch and tone.

3. Tracking the sound position of a remote user

v2.4.0 adds the enableSoundPositionIndication and setRemoteVoicePosition methods. 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.

4. Pre-call last-mile network probe test

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 lastmileProbeResult APIs, allowing you to get the uplink and downlink last-mile network statistics, including the bandwidth, packet loss, jitter, and round-trip time (RTT).

5. Audio device loopback test

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.

6. Setting the priority of a remote user's stream

v2.4.0 adds the setRemoteUserPriority method for setting the priority of a remote user's media stream. 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.

7. State of an audio mixing file

v2.4.0 adds the localAudioMixingStateDidChanged 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.

8. Setting the log file size

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).

9. Cloud proxy

Supports the cloud proxy service. See Use Cloud Proxy for details.

Improvements

1. Accuracy of call quality statistics

• v2.4.0 replaces the startEchoTest method with the startEchoTestWithInterval method. The intervalInSeconds parameter of startEchoTestWithIntervals allows you to set the interval between when you speak and when the recording plays back.
• v2.4.0 adds three parameters to the AgoraRtcLocalVideoStats class: sentTargetBitrate for setting the target bitrate of the current encoder, sentTargetFrameRate for setting the target frame rate, and qualityAdaptIndication for reporting the quality of the local video since last count.

2. Video encoder preferences

v2.4.0 provides the following options for setting video encoder preferences:

• Setting preferences under limited bandwidth. v2.4.0 adds two parameters to the AgoraVideoEncoderConfiguration class: minFrameRate and degradationPreference. You can use these parameters together to set the minimum video encoder frame rate and the video encoding degradation preference under limited bandwidth. For more information, see Set the Video Profile.
• Setting the camera capture preference. v2.4.0 adds the 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.

3. Core quality improvements

• Reduces the audio delay.
• Improves the video quality and stability.
• Shortens the time to render the first remote video frame.
• Improves the video smoothness and reduces the time delay when sharing a screen under poor network conditions.
• Optimizes the usage of CPU and RAM resources.

Issues fixed

Audio

• Calling the enableLocalAudio method disconnects all connected Bluetooth devices.
• The SDK does not support audio mixing URLs with Chinese characters.
• The SDK does not return YES after the pushExternalAudioFrameSampleBuffer method call succeeds.
• Volume levels of the high-pitch sound are lowered.
• Sounds are occasionally played fast.
• The app cannot get the virtual sound card information with the getAudioPlaybackDevices method.

Video

• If you skip the renderMode setting, the video stretches due to a mismatch with the display.
• Video freezes on some lower-end devices.
• It takes too long to render the first received video frame.
• The Electron SDK crashes if the virtual camera does not support 640 x 480.
• The cursor on the local screen is not accurately projected onto the remote screen.

Miscellaneous:

• The SEI information does not synchronize with the media stream when publishing transcoded streams to the RTMP.

API changes

To improve your experience, we made the following changes to the APIs:

Added

• setBeautyEffectOptions
• startScreenCaptureByDisplayId
• startScreenCaptureByWindowId
• updateScreenCaptureParameters
• setScreenCaptureContentHint
• setLocalVoiceChanger
• setLocalVoiceReverbPreset
• enableSoundPositionIndication
• setRemoteVoicePosition
• startLastmileProbeTest
• stopLastmileProbeTest
• setRemoteUserPriority
• startEchoTestWithInterval
• startAudioDeviceLoopbackTest
• stopAudioDeviceLoopbackTest
• setCameraCapturerConfiguration
• setLogFileSize
• localAudioMixingStateDidChanged
• lastmileProbeResult

Deprecated

• startEchoTest
• startScreenCapture
• setVideoQualityParameters

Miscellaneous

v2.4.0 changes the type of the frameRate parameter in the AgoraVideoEncoderConfiguration class from enum to int.

v2.3.3

v2.3.3 is released on January 24, 2019.

Improvements

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.

Issues fixed

Occasional inaccurate statistics returned in the networkQuality callback.

v2.3.2

v2.3.2 is released on January 16, 2019.

Compatibility changes

Besides the new features and improvements mentioned below, it is worth noting that v2.3.2:

• Improves the SDK's ability to counter packet loss under unreliable network conditions.
• Improves the communication smoothness.
• Reduces video freezes in the LiveBroadcasting profile.

Before upgrading your SDK, ensure that the version is:

• Native SDK v1.11 or later.
• Web SDK v2.1 or later.

New features

1. Video quality in the interactive live streaming

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.

2. Independent audio mixing volume adjustments for local playback and remote publishing

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.

3. Fallback options for the interactive streaming under unreliable network conditions

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:

• Automatically disable the video stream when the network conditions cannot support both audio and video, or
• Enable the video when the network conditions improve.

The SDK triggers the didLocalPublishFallbackToAudioOnly or didRemoteSubscribeFallbackToAudioOnly callback when the stream falls back to audio-only or switches back to the video.

4. Upstream and downstream statistics of each remote user/host

v2.3.2 adds the audioTransportStatsOfUid and videoTransportStatsOfUid 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).

5. New video encoder configuration

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 AgoraVideoEncoderConfiguration class provides a set of configurable video parameters, including the dimension, frame rate, bitrate, and orientation. You can still use the setVideoProfile method, but we recommend using the setVideoEncoderConfiguration method to set the video profile.

6. Virtual sound card

v2.3.2 adds the deviceName parameter in the enableLoopbackRecording method, allowing you to use a virtual sound card for audio recording:

• To use the current sound card, set deviceName as NULL.
• To use a virtual card, set deviceName as the name of the virtual card.

Improvements

1. Improves the accuracy of the call quality statistics

v2.3.2 deprecates the audioQualityOfUid callback and replaces it with the remoteAudioStats callback to improve the accuracy of the call quality statistics. The remoteAudioStats 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 networkQuality callback for the uplink and downlink network qualities.

• remoteAudioStats: Reports the statistics of the remote audio stream from each user/host. This callback replaces the onAudioQuality callback.
• networkQuality: Reports the last mile network quality of each user in the channel.

Agora plans to improve the following callback in subsequent versions:

• lastmileQuality: Reports the last mile network quality of the local user before the user joins a channel.

For the list of API methods related to the call quality statistics and on how and when to use them, see Report In-call Statistics.

2. New network connection policy

v2.3.2 adds the following API method and callback to get the current network connection state and the reason for a connection state change:

• getConnectionState: Gets the connection state of the SDK.
• connectionChangedToState: Occurs when the connection state of the SDK to the server changes.

v2.3.2 deprecates the rtcEngineConnectionDidInterrupted and rtcEngineConnectionDidBanned callbacks.

In the new API method, the network connection states are "disconnected", "connecting", "connected", "reconnecting", and "failed". The SDK triggers the connectionChangedToState callback when the network connection state changes. The SDK also triggers the rtcEngineConnectionDidInterrupted and rtcEngineConnectionDidBanned callbacks under certain circumstances, but we do not recommend using them.

3. Improves the call rating system

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. You can use this feedback for future product improvement. We strongly recommend integrating this method in your application.

4. Other improvements

• Minimizes packet loss under unreliable network conditions in the LiveBroadcasting profile.
• Accelerates the video quality recovery under network congestion.
• Optimizes the API calling threads.
• Checks the headset and Bluetooth device connection.
• Reduces the audio delay.
• Optimizes video capture methods on macOS and reduces performance loss.

Issues fixed

The following issues are fixed in v2.3.2:

SDK

• Crashes on macOS.

Audio

• A user joins the interactive live streaming with a Bluetooth headset. The audio is not played through the Bluetooth headset when the user leaves the channel and opens another application.
• Crashes when calling the startAudioMixing method to play music files.
• A previously disabled microphone becomes enabled when the device connects to a headset.
• Cannot adjust the volume of the speaker when users change roles, join and leave channels, or a system phone or Siri interrupts.
• Users do not hear any voice for a while when an application switches back from the background.

Video

• The users on the Web client cannot see the video sent from the Native client due to codec bugs.
• Occasional issues when using an external video source.
• The cursor on the remote side is not in the same position as the local side when sharing the desktop.

API changes

To improve your experience, we made the following changes to the APIs:

Added

• setVideoEncoderConfiguration
• setLocalPublishFallbackOption
• setRemoteSubscribeFallbackOption
• getConnectionState
• adjustAudioMixingPlayoutVolume
• adjustAudioMixingPublishVolume
• connectionChangedToState
• didLocalPublishFallbackToAudioOnly
• didRemoteSubscribeFallbackToAudioOnly
• remoteAudioStats
• audioTransportStatsOfUid
• videoTransportStatsOfUid

Deprecated

• setVideoProfile
• audioQualityOfUid
• rtcEngineConnectionDidInterrupted
• rtcEngineConnectionDidBanned

v2.2.3

v2.2.3 is released on July 5, 2018.

The security keys are improved and updated in v2.1.0. If you are using an Agora SDK version earlier than v2.1.0 and wish to migrate to the latest version, see Token Migration Guide.

Issues Fixed

• Occasional online statistics crashes.
• Occasional crashes during the interactive live streaming.
• Excessive increase in the memory usage when multiple delegated hosts start streaming in the channel.
• Occasional video freeze after a view size change.
• Failing to report the uid and volume of the speaker in a channel.

v2.2.2

v2.2.2 is released on June 21, 2018.

Issues fixed

• Fixed occasional online statistics crashes.
• Fixed the issue of failing to report the uid and volume of the speaker in a channel.
• Fixed the issue of occasional video freeze after a view size change.

v2.2.1

v2.2.1 is released on May 30th, 2018 and improves the internal code implementation.

v2.2.0

v2.2.0 is released on May 4, 2018.

New features

1. Play the audio effect in the channel

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.

2. Deploy the proxy at the server

We provide a proxy package for enterprise users with corporate firewalls to deploy before accessing our services.

3. Get the remote video state

Adds the remoteVideoStateChangedOfUid method to get the state of the remote video stream.

4. Add watermarks on the interactive video streaming

Adds the watermark function for users to add a PNG file to the local or Media Push as a watermark. Adds the addVideoWatermark and clearVideoWatermarks methods to add and delete watermarks in the interactive video streaming. Adds the watermark parameter in the LiveTranscording interface to add watermarks in Media Push.

Improvements

1. Audio volume indication

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.

2. Network quality detection during a session

To meet the customers’ need for real-time network quality detection in the channel, the onNetworkQuality method improves its data accuracy.

3. Last mile network quality detection before joining a channel

To test if the customers’ network condition can support voice or video calls before joining the channel, the onLastmileQuality callback changes its detection from a fixed bitrate to the bitrate set by the customer in videoProfile to improve data accuracy. When the network condition is unknown, the SDK still triggers this callback once every 2 seconds.

4. Audio Quality Enhancement

Improves the audio quality in scenarios that involve music playback.

Issues fixed

• Occasional crashes on the macOS device.
• Occasional screen display abnormalities when a large number of audience members join as the host in an interactive streaming channel.

v2.1.3

v2.1.3 is released on April 19, 2018.

In v2.1.3, we updated the bitrate values of the setVideoProfile method in the LiveBroadcasting profile. The bitrate values in v2.1.3 stay consistent with those in v2.0.

Issues fixed

• Block callbacks are occasionally not received if the delegate is not set.
• NSAssertionHandler appears in external links to the SDK.
• Occasional recording failures on some phones when a user leaves a channel and turns on the built-in recording device.

Improvements

Improves the performance of screen sharing by shortening the time interval between which users switch from screen sharing to the normal Communication or LiveBroadcasting profile.

v2.1.2

v2.1.2 is released on April 2, 2018.

If you upgraded the SDK to v2.1.2 from a previous version, the LiveBroadcasting video quality will be better than the Communication video quality in the same resolutions, resulting in the live broadcasts using more bandwidth.

New features

Extends the setVideoProfile method to enable users to manually set the resolution, frame rate, and bitrate of the video.

Issues fixed

The video resolution of the shared screen is worse in the Communication profile than in LiveBroadcasting profile.

v2.1.1

v2.1.1 is released on March 16, 2018.

We identified a critical bug in SDK v2.1. Upgrade to v2.1.1 if you are using the Agora SDK v2.1.

v2.1.0

V2.1.0 is released on March 7, 2018.

New features

1. Voice optimization

Adds a scenario for the game chat room to reduce the bandwidth and cancel the noise with the setAudioProfile method.

2. Enhances the audio effect input from the built-in microphone

In an interactive streaming, the host can enhance the local audio effects from the built-in microphone with the setLocalVoiceEqualization and setLocalVoiceReverb methods by implementing the voice equalization and reverberation effects.

3. Online statistics query

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:

• Voice or video calls: See Online Statistics Query API.
• Interactive streaming: See Online Statistics Query API.

4. 17-way Video

Adds the support of 17-way video in interactive streaming, see:

• Start Live interactive streaming
• Video Conference of 7+ Users

5. Video source customization

Supports the default video-capturing features provided by the camera and the customized video source.

6. Renderer customization

Supports the default functions provided by the renderers to display the local and remote videos to meet your requirements. We provide a set of interfaces for customized renderers.

7. Screen sharing for interactive streaming

• Before v2.1.0: The Agora SDK only supported the screen-sharing function in video calls
• From v2.1.0: The Agora SDK added the screen-sharing function in interactive streaming.

Improvements

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, hosting in, and stream-pushing).
Billing Optimization	Small video resolutions are charged according to voice-only mode. For example, 16 x 16.
API Naming Optimization	Modifies a set of names for the API attributes and enumeration values.

v2.0.2

v2.0.2 is released on December 15, 2017 and fixes the FFmpeg symbol conflict.

v2.0

v2.0 is released on December 6, 2017.

New features

• Adds the setRemoteVideoStreamType and enableDualStreamMode methods in the Communication profile to support dual streams.

• Updates the following callbacks for audio mixing and sound effects:

  Name	Description
  rtcEngineMediaEngineDidAudioMixingFinish	Removed. Replaced by rtcEngineLocalAudioMixingDidFinish.
  rtcEngineDidAudioEffectFinish	Added. Notifies the app when the local audio effect playback stops.
  rtcEngineRemoteAudioMixingDidStart	Added. Notifies the app when the remote user starts audio mixing.
  rtcEngineRemoteAudioMixingDidFinish	Added. Notifies the app when the remote user stops audio mixing.

• Adds the camera management function in the Communication and LiveBroadcasting profiles by adding the following API methods:

  Name	Description
  isCameraZoomSupported	Checks whether the device supports camera zoom.
  isCameraTorchSupported	Checks whether the device supports camera flash.
  isCameraFocusPositionInReviewSupported	Checks whether the device supports camera manual focus.
  isCameraAutoFocusFaceModeSupported	Checks whether the device supports camera auto-face focus.
  setCameraZoomFactor	Sets the camera zoom ratio.
  setCameraFocusPositionInPreview	Sets the position for manual focus and activates focusing.
  setCameraTorchOn	Sets the device to turn on the camera flash.
  setCameraAutoFocusFaceModeEnabled	Sets the device to start auto-face focusing.

• Supports the external audio source in the Communication and LiveBroadcasting profiles by adding the following API methods:

  Name	Description
  enableExternalAudioSourceWithSampleRate	Enables the external audio source.
  disableExternalAudioSource	Disables the external audio source.
  pushExternalAudioFrameRawData	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 LiveBroadcasting profiles. Contact support@agora.io to enable this function, if required.

Issues fixed

Audio routing and Bluetooth issues.

v1.14

v1.14 is released on October 20, 2017.

New features

• Adds the setAudioProfile method to set the audio parameters and scenarios.
• Adds the setLocalVoicePitch method to set the local voice pitch.
• LiveBroadcasting: Adds the setInEarMonitoringVolume method to adjust the volume of the in-ear monitor.

Improvements

• Optimizes the audio at high bitrates.
• LiveBroadcasting: The audience can view the host within one second in a single-stream mode (858 ms on average, and 625 ms in good network conditions).
• Adds the ability to reduce the bandwidth.
  • Before v1.14: If you muted the audio of a specific user, the network still sent the stream.
  • Starting from v1.14: If you mute the audio of a specific user, the network will not send the stream of the user to reduce the bandwidth.
• Accurate control over the bitrate:
  • Before v1.14: Inaccurate control over the bitrate often caused huge fluctuations, leading to network congestion and higher rates of packet and frame loss. This affected the accuracy of the bandwidth estimation module, especially when the network was in poor conditions.
  • Starting from v1.14: Accurate control over the bitrate prevents huge fluctuations avoiding network congestion and shortening the transmission latency.

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.

New features

• Adds the function to dynamically enable and disable acquiring the sound card in the interactive live streaming.
• Adds the function to disable the audio playback.
• Adds the module map for the SDK, which means bridging header files are not necessary for Swift projects.
• Supports the profile configuration for stream-pushing on the client side.
• Adds the didClientRoleChanged callback to indicate a user role change between the host and audience in the interactive live streaming.
• Supports the push-stream failure callback on the server side.

Improvements:

• Screen Sharing: Enhances the video definition and fluency.
• Screen Sharing: Supports updating the captured region dynamically.
• The video profile is controllable by the software codec.

Issues fixed:

Occasional crashes on some devices.

v1.12

v1.12 is released on July 25, 2017.

New functions:

• Adds the injectStream method to inject an RTMP stream into the current channel in the LiveBroadcasting profile.
• Adds the aes-128-ecb encryption mode in the setEncryptionMode method.
• Adds the quality parameter in the startAudioRecording method to set the recording audio quality.
• Adds a set of API methods to manage the audio effect.
• Adds the ActiveSpeaker method to report on the active speaker in the current channel.
• Removes the setScreenCaptureWindow method, and updates the startScreenCapture method to share the whole screen and specify the window or region in the Communication profile.
• Adds displaying the mouse function when the screen-sharing function is enabled in the Communication profile.

Improvements:

In the Communication profile, the 320 × 180 resolution profile is improved.

• Keeps the video smooth under poor network and equipment conditions.
• Enhances the image quality to be better than 180p under good network and equipment conditions.

Issues fixed:

Occasional crashes.