Merge pull request #302173 from sloanster/patch-39

Update web.md

Author: Stacyrch140

articles/communication-services/toc.yml

@@ -526,13 +526,13 @@ items:
       href: quickstarts/voice-video-calling/local-preview-mirroring.md
     - name: Optimize video placement on your web app
       href: quickstarts/voice-video-calling/optimizing-video-placement.md
-      displayName: Optimal Video Count, OVC, dual pin
-    - name: Simulcast
+      displayName: Optimal Video Count, OVC, dual pin, 1080P
+    - name: Understanding Simulcast
       href: concepts/voice-video-calling/simulcast.md
-      displayName: diagnostics, diagnose, feedback, quality, reliability, users, call, quick, satisfaction, improve, issues
-    - name: Enable audio noise suppression improvements
+      displayName: diagnostics, diagnose, feedback, quality, reliability, users, call, quick, satisfaction, improve, issues, simulcast
+    - name: Add audio quality improvements
       href: tutorials/audio-quality-enhancements/add-noise-supression.md
-      displayName: noise suppression, audio quality, noise removal, background noise, deep noise, voice isolation
+      displayName: noise suppression, audio quality, noise removal, background noise, deep noise, voice isolation, echo cancellation
     - name: Enable video background effects
       href: quickstarts/voice-video-calling/get-started-video-effects.md
       displayName: background blur, background replace, background replacement, frosted glass

articles/communication-services/tutorials/audio-quality-enhancements/includes/web.md

@@ -32,11 +32,7 @@ Key traits for echo cancelation:
 ## Use audio effects: Install the calling effects npm package
 
 > [!IMPORTANT]
-> **Noise Suppression** features are available in GA SDK version `1.28.4` or later, alongside the Azure Communication Services Calling Effects SDK version GA `1.1.2` or later. The general availability (GA) stable version `1.28.4` and later of the Calling SDK support noise suppression features. Alternatively, if you opt to use the public preview version, Calling SDK versions `1.24.2-beta.1` and later also support noise suppression.
-
-> This tutorial employs the Azure Communication Services Calling SDK version `1.28.4` or later, alongside the Azure Communication Services Calling Effects SDK version `1.1.2` or later. The general availability (GA) stable version `1.28.4` and later of the Calling SDK support noise suppression features. Alternatively, if you opt to use the public preview version, Calling SDK versions `1.24.2-beta.1` and later also support noise suppression.
-> 
-> Current browser support for adding audio noise suppression effects is available only on Chrome and Microsoft Edge desktop browsers.
+> **Noise Suppression** features are available in GA WebJS SDK version `1.28.4` or later, alongside the Azure Communication Services Calling Effects SDK version GA `1.1.2` or later. Alternatively, if you opt to use the public preview version, Calling SDK versions `1.24.2-beta.1` and later also support noise suppression.
 
 > [!IMPORTANT]
 > **Echo Cancellation** features are available in public preview SDK version [1.37.1](https://github.com/Azure/Communication/blob/master/releasenotes/acs-javascript-calling-library-release-notes.md#1371-beta1-2025-06-16). Also note that to use echo cancelation you must use public preview audio effects SDK version beta version [1.21.1-beta](https://www.npmjs.com/package/@azure/communication-calling-effects/v/1.2.1-beta.1) or later.
@@ -60,7 +56,30 @@ If you use the **public preview** of the Calling SDK, you must use the [beta ver
 ```
 
 ## Enable Audio Effects you wish to use
-For information on the interface that details audio effects properties and methods, see the [Audio Effects Feature interface](/javascript/api/azure-communication-services/@azure/communication-calling/audioeffectsfeature?view=azure-communication-services-js&preserve-view=true) API documentation page.
+The following is a tree-structured representation of the AudioEffects interface:
+```
+AudioEffectsFeature
+├── Properties
+│   ├── activeEffects: ActiveAudioEffects (read-only)
+│   └── name: string (inherited from AudioStreamFeature)
+│
+├── Methods
+│   ├── isSupported(effect: "BrowserNoiseSuppression" | DeepNoiseSuppressionEffect): Promise<boolean>
+│   ├── startEffects(config: AudioEffectsStartConfig): Promise<void>
+│   ├── stopEffects(config: AudioEffectsStopConfig): Promise<void>
+│   ├── on(event: "effectsStarted" | "effectsStopped" | "effectsError", listener: AudioEffectsFeatureListener): void
+│   └── off(event: "effectsStarted" | "effectsStopped" | "effectsError", listener: AudioEffectsFeatureListener): void
+│
+└── Inherited Methods (from AudioStreamFeature)
+    └── dispose(): void
+```
+Where
+- `activeEffects` gives you the currently running audio effects.
+- `isSupported` checks if a specific effect is available in the current environment.
+- `startEffects` and `stopEffects` control the activation of effects (noise suppression, echo cancellation)
+- `on`/`off` let you subscribe/unsubscribe to events
+
+For more information on the interface that details audio effects properties and methods, see the [Audio Effects Feature interface](/javascript/api/azure-communication-services/@azure/communication-calling/audioeffectsfeature?view=azure-communication-services-js&preserve-view=true) API documentation page.
 
 
 ### Initialize the Audio Effects Feature
@@ -89,10 +108,14 @@ audioEffectsFeatureApi.on('effectsStopped', (activeEffects: ActiveAudioEffects)
     console.log(`Current status audio effects: ${activeEffects}`);
 });
 
-
 audioEffectsFeatureApi.on('effectsError', (error: AudioEffectErrorPayload) => {
     console.log(`Error with audio effects: ${error.message}`);
 });
+
+// Start Communication Services Noise Suppression
+await audioEffectsFeatureApi.startEffects({
+    noiseSuppression: deepNoiseSuppression
+});
 ```
 ### Enable Echo Cancellation
 The following code snippet shows an example on how to enable **echo cancellation** from within the WebJS environment.
@@ -110,6 +133,11 @@ const localAudioStreamInCall = call.localAudioStreams[0];
 // Get the audio effects feature API from LocalAudioStream
 const audioEffectsFeatureApi = localAudioStreamInCall.feature(AzureCommunicationCallingSDK.Features.AudioEffects);
 
+// Start Communication Services echo cancellation
+await audioEffectsFeatureApi.startEffects({
+    echoCancellation: echoCancellationEffect
+}); 
+
 ```
 ### Validate that the current browser environment supports audio effects
 We recommend that you check support for the effect in the current browser environment by using the `isSupported` method on the feature API. Remember that audio effects are only supported on desktop browsers for Chrome and Edge.
@@ -130,7 +158,7 @@ if (isNoiseSuppressionSupported) {
 ```
 
 ## Bring it all together: Load and start noise suppression and echo cancelation  
-To initiate a call with noise suppression and echo cancelation enabled, create a new `LocalAudioStream` property using `AudioDeviceInfo`. Ensure that the `LocalAudioStream` source isn't set as a raw `MediaStream` property to support audio effects. Then, include this property within `CallStartOptions.audioOptions` when starting the call.
+To initiate a call with both **noise suppression** and **echo cancelation** enabled, create a new `LocalAudioStream` property using `AudioDeviceInfo`. Ensure that the `LocalAudioStream` source isn't set as a raw `MediaStream` property to support audio effects. Then, include this property within `CallStartOptions.audioOptions` when starting the call.
 
 ```js
 import { EchoCancellationEffect, DeepNoiseSuppressionEffect } from '@azure/communication-calling-effects';
@@ -216,7 +244,7 @@ await audioEffectsFeatureApi.stopEffects({
 ```
 
 ## Check what audio effects are active
-To check what noise suppression effects are currently active, you can use the `activeEffects` property. The `activeEffects` property returns an object with the names of the current active effects.
+To check what noise suppression effects are currently active, you can use the `activeEffects` property. The `activeEffects` property returns an object with the names of the current active effects. See [here](/javascript/api/azure-communication-services/@azure/communication-calling/activeaudioeffects?view=azure-communication-services-js&preserve-view=true) for more details on the `activeEffects` interface.
 
 ```js
 import { EchoCancellationEffect, DeepNoiseSuppressionEffect } from '@azure/communication-calling-effects';
@@ -227,20 +255,16 @@ const localAudioStreamInCall = call.localAudioStreams[0];
 // Get the audio effects feature API from LocalAudioStream
 const audioEffectsFeatureApi = localAudioStreamInCall.feature(AzureCommunicationCallingSDK.Features.AudioEffects);
 
-// Subscribe to useful events that show audio effects status
-audioEffectsFeatureApi.on('effectsStarted', (activeEffects: ActiveAudioEffects) => {
-    console.log(`Current status audio effects: ${activeEffects}`);
-});
-
-
-audioEffectsFeatureApi.on('effectsStopped', (activeEffects: ActiveAudioEffects) => {
-    console.log(`Current status audio effects: ${activeEffects}`);
-});
+// Get the current active effects
+const activeAudioEffects = audioEffectsFeatureApi.activeEffects;
 
-
-audioEffectsFeatureApi.on('effectsError', (error: AudioEffectErrorPayload) => {
-    console.log(`Error with audio effects: ${error.message}`);
-});
+if (activeAudioEffects.noiseSuppression === 'DeepNoiseSuppression') {
+    // Deep Noise Suppression is currently active
+}
+if (activeAudioEffects.echoCancellation === 'EchoCancellation') {
+    // Echo Cancellation is currently active
+}
+;
 ```
 ## Best Practices
 The Azure Communication Services WebJS audio effects package provides tools for reducing unwanted sounds. Other measures can be taken to improve audio quality, such as: