Release notes

This page provides the release notes for the following:

• Video SDK

• Notifications

• AI Noise Suppression

• Virtual Background

v2.3.0 was released on August 21, 2024.

This version updates the built-in Web SDK to v4.22.0. For more details on the changes between Web SDK v4.21.0 and 4.22 .0, see the Web SDK release notes.

v2.2.0 was released on June 13, 2024.

This version updates the built-in Web SDK to v4.21.0. For more details on the changes between Web SDK v4.20.0 and 4.21.0, see the Web SDK release notes.

v2.1.0 was released on January 5, 2024.

This version updates the built-in SDK for Web in the SDK for React JS to version 4.20.0. Check the related changes in the Web SDK release notes.

v2.0.0 was released on December 22, 2023.

SDK structural optimization

The SDK for ReactJS is developed based on the SDK for Web v4.x. To further enhance usability, this version incorporates all Web SDK APIs into the ReactJS SDK, eliminating the need to integrate the Web SDK separately.

Upon upgrading to this version, make the following modifications:

• Reintegrate the React SDK. Taking npm as an example:

  # Remove existing dependencies
  

  npm uninstall agora-rtc-react agora-rtc-sdk-ng
  

  # Reinstall dependencies
  

  npm install agora-rtc-react
  

• Adjust the import of the AgoraRTC interface from the Web SDK. Taking the combined import of AgoraRTC and AgoraRTCProvider as an example:

  // Before this version
  

  import AgoraRTC from "agora-rtc-sdk-ng";
  

  import { AgoraRTCProvider } from "agora-rtc-react";
  

  // As of this version
  

  import AgoraRTC, { AgoraRTCProvider } from "agora-rtc-react"
  

NetworkQuality renaming

To avoid redundancy with the Web SDK's API, this version makes the following changes to the ReactJS SDK's NetworkQuality interface:

• Rename NetworkQuality to NetworkQualityEx and have NetworkQualityEx inherit the NetworkQuality interface from the Web SDK.
• Rename the uplink and downlink properties to uplinkNetworkQuality and downlinkNetworkQuality, respectively.

If you use the NetworkQuality interface from the ReactJS SDK, make the necessary code modifications after upgrading to this version.

This version adds the cameraVideoTrackConfig parameter to useLocalCameraTrack, enabling you to set video capture configurations such as capture devices and encoder when creating a camera video track.

This version fixed the issue that the SDK threw the error CAN_NOT_PUBLISH_MULTIPLE_VIDEO_TRACKS in Firefox's developer mode.

Added

• cameraVideoTrackConfig to useLocalCameraTrack

Modified

• NetworkQuality to NetworkQualityEx
  • uplink to uplinkNetworkQuality
  • downlink to downlinkNetworkQuality

• After you enable Notifications, your server receives the events that you subscribe to in the form of HTTPS requests.
• To improve communication security between the Notifications and your server, Agora SD-RTN™ uses signatures for identity verification.
• As of this release, you can use Notifications in conjunction with this product.

Agora charges additionally for this extension. See Pricing.

This release improves the calculation performance of the AI-powered noise suppression algorithm.

This release adds the following APIs and parameters:

• APIs:
  • checkCompatibility: Checks whether the AI Noise Suppression extension is supported on the current browser.
  • setMode: Sets the noise suppression mode as AI noise suppression or stationary noise suppression.
  • setLevel: Sets the AI noise suppression level.
• Parameters:
  • elapsedTime in onoverload: Reports the time in ms that the extension needs to process one audio frame.

For API details, see AI Noise Suppression.

This release brings the following changes:

• AI Noise Suppression supports Agora Video SDK for Web v4.15.0 or later.
• The extension has Wasm dependencies only. Because JS dependencies are removed, you need to publish the Wasm files located in the node_modules/agora-extension-ai-denoiser/external directory again. If you have enabled the Content Security Policy (CSP), you need to modify the CSP configuration. See AI Noise Suppression for details.
• The audio data is dumped in PCM format instead of WAV format.
• To adjust the intensity of noise suppression, best practice is to call setLevel.

First release.

v1.2.0 was released on December 10, 2023.

As of this version, the Virtual Background extension incorporates the necessary Wasm module. You no longer need to publish the Wasm file separately, and pass the wasmDir parameter when calling the init method to initialize the extension.

After upgrading to this version, please modify your code accordingly.

This release upgrades the background segmentation algorithm of the extension, optimizing the segmentation effects on the subject, edges, and fingers in complex static and dynamic backgrounds.

This release fixed the issue that checkCompatibility could return inaccurate results on specific devices.

The wasmDir parameter of the init method is now optional.

This release fixes the occasional issue of jagged background images on Chrome for Android.

You can now specify the fit property when calling setOptions. This sets how the background is resized to fit the container. For API details, see Virtual background.

Virtual Background supports Agora Video SDK for Web v4.15.0 or later.

You can now call checkCompatibility and test if AI Noise Suppression extension is supported on the current browser. For API details, see Virtual background.

A black bar is no longer displayed to the left of the virtual background.

You can create multiple VirtualBackgroundProcessor instances to process multiple video streams.

First release.