diff --git a/docs/flutter/v2/how-to-guides/extend-capabilities/noise-cancellation.mdx b/docs/flutter/v2/how-to-guides/extend-capabilities/noise-cancellation.mdx index 8d29a11d3..321f7a63a 100644 --- a/docs/flutter/v2/how-to-guides/extend-capabilities/noise-cancellation.mdx +++ b/docs/flutter/v2/how-to-guides/extend-capabilities/noise-cancellation.mdx @@ -3,6 +3,8 @@ title: Noise Cancellation nav: 13.1 --- +import AndroidSdkVersionShield from '@/common/android-sdk-version-shield.md'; + The Noise Cancellation feature is an invaluable tool designed to enhance the audio quality in scenarios such as conferences, live streams, and recordings where unwanted background noise can degrade the listening experience. By leveraging advanced Artificial Intelligence (AI) algorithms, this feature intelligently identifies and suppresses extraneous sounds, ensuring clear and crisp audio output. ## Key Benefits @@ -31,7 +33,25 @@ HMSSDK provides `HMSNoiseCancellationController` to control Noise Cancellation i
-### Step 1: Set the enableNoiseCancellation property in HMSAudioTrackSetting as true +### Step 1: Add Noise Cancellation library dependency (Android only) + +Add the following dependency to your app's `build.gradle` file to integrate the Noise Cancellation feature into your Flutter application: +``` +dependencies { + ... + implementation "live.100ms:hms-noise-cancellation-android:2.9.67" +} +``` + +Ensure that you add the above dependency in the `dependencies` block of the `my_app_name/android/app/build.gradle` file. + +Check the reference [here](https://github.com/100mslive/100ms-flutter/blob/53466d8b225125bdfc0916ada15f6ba009a79afd/packages/hmssdk_flutter/example/android/app/build.gradle#L86) to see it in action in the sample app. + +Replace `2.9.67` with the latest version of the Noise Cancellation library available on the Maven Repository. + +This step is required only for the Android app. On iOS, the Noise Cancellation library is already integrated into the HMSSDK. + +### Step 2: Set the enableNoiseCancellation property in HMSAudioTrackSetting as true ```dart{6} /// To enable noise cancellation set the `enableNoiseCancellation` property to true @@ -42,7 +62,7 @@ var audioTrackSetting = HMSAudioTrackSetting( enableNoiseCancellation: true); ``` -### Step 2: Pass the Track Settings to the HMSSDK constructor +### Step 3: Pass the Track Settings to the HMSSDK constructor ```dart{4} /// Create Instance of `HMSTrackSetting` @@ -60,7 +80,7 @@ var hmsSDK = HMSSDK( hmsTrackSetting: trackSettings); ``` -### Step 3: Check for Noise Cancellation availability +### Step 4: Check for Noise Cancellation availability > 🔑 Note: You can call this API to check the state of Noise Cancellation only after successfully joining the Room. @@ -76,7 +96,7 @@ class Meeting implements HMSUpdateListener, HMSActionResultListener{ } ``` -### Step 4: If Noise Cancellation is available, enable it +### Step 5: If Noise Cancellation is available, enable it ```dart{13} class Meeting implements HMSUpdateListener, HMSActionResultListener{ @@ -97,7 +117,7 @@ class Meeting implements HMSUpdateListener, HMSActionResultListener{ } ``` -### Step 5: To disable Noise Cancellation use HMSNoiseCancellationController's disable method +### Step 6: To disable Noise Cancellation use HMSNoiseCancellationController's disable method ```dart{12} class Meeting implements HMSUpdateListener, HMSActionResultListener{ diff --git a/docs/flutter/v2/release-notes/release-notes.mdx b/docs/flutter/v2/release-notes/release-notes.mdx index 563710807..63771d0fd 100644 --- a/docs/flutter/v2/release-notes/release-notes.mdx +++ b/docs/flutter/v2/release-notes/release-notes.mdx @@ -11,6 +11,51 @@ nav: 99 | hmssdk_flutter | [![Pub Version](https://img.shields.io/pub/v/hmssdk_flutter)](https://pub.dev/packages/hmssdk_flutter) | | hms_video_plugin | [![Pub Version](https://img.shields.io/pub/v/hms_video_plugin)](https://pub.dev/packages/hms_video_plugin) | +# 1.10.6 - 2024-09-17 + +| Package | Version | +| ----------------------------| ------ | +| hms_room_kit | 1.1.6 | +| hmssdk_flutter | 1.10.6 | + +### Breaking Changes in hms_room_kit + +- Removed Noise Cancellation dependency from Prebuilt on Android + + Noise Cancellation dependency is removed from Prebuilt on Android. + Users will have to add the dependency manually in their Android project to use Noise Cancellation. + This change is made to reduce the size of the Prebuilt package. + Refer to the [Noise Cancellation](https://www.100ms.live/docs/flutter/v2/how-to-guides/extend-capabilities/noise-cancellation) documentation for more details. + + +### hmssdk_flutter + +- Added Camera Zoom Controls in `HMSCameraControls` + + Users can now control the camera zoom using the `HMSCameraControls` class. The `setZoom` method can be used to set the zoom level of the camera. + + Learn more about Camera Zoom Controls [here](https://www.100ms.live/docs/flutter/v2/how-to-guides/configure-your-device/camera/camera-controls). + +### hms_room_kit + +- Added support to control Automatic Gain Control and Noise Suppresion in Prebuilt + + Prebuilt now supports toggling Automatic Gain Control (AGC) and Noise Suppresion for better audio quality. Users can enable or disable AGC and Noise Suppresion from the prebuilt interface. + +- Resolved an issue where the Prebuilt UI was not updating on performing End Session + +- Hand Raise sorting based on Time + + Hand Raise list is now sorted based on the time of raising the hand. Refer to the [Hand Raise](https://www.100ms.live/docs/flutter/v2/how-to-guides/interact-with-room/peer/large-room) documentation for more details. + +- Added support to perform Switch Role of any user on Prebuilt + + Users can now switch the role of any user, if they have necessary permissions, from the Prebuilt interface. Refer to the [Change Role](https://www.100ms.live/docs/flutter/v2/how-to-guides/interact-with-room/peer/change-role) documentation for more details. + +Uses Android SDK 2.9.67 & iOS SDK 1.16.1 + +**Full Changelog**: [1.10.5...1.10.6](https://github.com/100mslive/100ms-flutter/compare/1.10.5...1.10.6) + # 1.10.5 - 2024-07-25 | Package | Version |