Skip to content

Commit 9ff3155

Browse files
authored
update 7
1 parent 8fd196d commit 9ff3155

File tree

1 file changed

+24
-1
lines changed
  • articles/communication-services/tutorials/audio-quality-enhancements/includes

1 file changed

+24
-1
lines changed

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

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,30 @@ If you use the **public preview** of the Calling SDK, you must use the [beta ver
5656
```
5757

5858
## Enable Audio Effects you wish to use
59-
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.
59+
The following is a tree-structured representation of the AudioEffects interface:
60+
```
61+
AudioEffectsFeature
62+
├── Properties
63+
│ ├── activeEffects: ActiveAudioEffects (read-only)
64+
│ └── name: string (inherited from AudioStreamFeature)
65+
66+
├── Methods
67+
│ ├── isSupported(effect: "BrowserNoiseSuppression" | DeepNoiseSuppressionEffect): Promise<boolean>
68+
│ ├── startEffects(config: AudioEffectsStartConfig): Promise<void>
69+
│ ├── stopEffects(config: AudioEffectsStopConfig): Promise<void>
70+
│ ├── on(event: "effectsStarted" | "effectsStopped" | "effectsError", listener: AudioEffectsFeatureListener): void
71+
│ └── off(event: "effectsStarted" | "effectsStopped" | "effectsError", listener: AudioEffectsFeatureListener): void
72+
73+
└── Inherited Methods (from AudioStreamFeature)
74+
└── dispose(): void
75+
```
76+
Where
77+
- `activeEffects` gives you the currently running audio effects.
78+
- `isSupported` checks if a specific effect is available in the current environment.
79+
- `startEffects` and `stopEffects` control the activation of effects (noise suppression, echo cancellation)
80+
- `on`/`off` let you subscribe/unsubscribe to events
81+
82+
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.
6083

6184

6285
### Initialize the Audio Effects Feature

0 commit comments

Comments
 (0)