Skip to content

Commit a80d1a7

Browse files
Merge pull request #303458 from sloanster/patch-47
Update volume-indicator-javascript.md
2 parents 2157bf4 + c851e33 commit a80d1a7

File tree

3 files changed

+7
-8
lines changed

3 files changed

+7
-8
lines changed

articles/communication-services/quickstarts/voice-video-calling/get-started-volume-indicator.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ titleSuffix: An Azure Communication Services quickstart
55
description: In this quickstart, you'll learn how to check call volume within your Calling app when using Azure Communication Services.
66
author: sloanster
77
services: azure-communication-services
8-
ms.date: 03/26/2024
8+
ms.date: 07/28/2025
99
ms.topic: quickstart
1010
ms.service: azure-communication-services
1111
ms.subservice: calling

articles/communication-services/quickstarts/voice-video-calling/includes/volume-indicator/volume-indicator-javascript.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: Quickstart - Add volume indicator to your Web calling app
33
titleSuffix: An Azure Communication Services quickstart
4-
description: In this quickstart, you'll learn how to check call volume within your Web app when using Azure Communication Services.
4+
description: In this quickstart, you learn how to check call volume within your Web app when using Azure Communication Services.
55
author: sloanster
66

77
ms.author: micahvivion
8-
ms.date: 1/18/2023
8+
ms.date: 07/28/2025
99
ms.topic: include
1010
ms.service: azure-communication-services
1111
ms.subservice: calling
@@ -14,12 +14,8 @@ ms.custom: mode-other
1414

1515
As a developer you can have control over checking microphone volume in JavaScript. This quickstart shows examples of how to accomplish it within the Azure Communication Services WebJS.
1616

17-
## Prerequisites
18-
>[!IMPORTANT]
19-
> The quick start examples here are available starting in version [1.13.1](https://www.npmjs.com/package/@azure/communication-calling/v/1.13.1) of the calling Web SDK. Make sure to use that SDK version or newer when trying this quickstart.
20-
2117
## Checking the audio stream volume
22-
As a developer it can be nice to have the ability to check and display to end users the current local microphone volume or the incoming microphone level. Azure Communication Services calling API exposes this information using `getVolume`. The `getVolume` value is a number ranging from 0 to 100 (with 0 noting zero audio detected, 100 as the max level detectable). This value is sampled every 200 ms to get near real time value of volume level. Different microphone hardware has different level of sensitivity and it can show different volume levels for the similar environment.
18+
Developers may need to check and display the current local microphone volume or incoming microphone level to end users. The Azure Communication Services calling API provides access to this information through `getVolume`. The `getVolume` value is a number from 0 to 100, where 0 represents no audio detected and 100 is the maximum detectable level. This value is sampled every 200 ms to provide a near real-time measurement of the volume level. Microphone hardware can vary in sensitivity, which may result in different volume readings under similar environmental conditions.
2319

2420
### Example usage
2521
This example shows how to generate the volume level by accessing `getVolume` of the local audio stream and of the remote incoming audio stream.

articles/communication-services/toc.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -542,6 +542,9 @@ items:
542542
- name: Enable video background effects
543543
href: quickstarts/voice-video-calling/get-started-video-effects.md
544544
displayName: background blur, background replace, background replacement, frosted glass
545+
- name: Enable volume indicator controls
546+
href: quickstarts/voice-video-calling/get-started-volume-indicator.md
547+
displayName: volume, audio level, microphone sensitivity, taling indicator, volume input, sound intensity, volume display
545548
- name: Pass user-to-user information (UUI) data in a header
546549
href: how-tos/calling-sdk/call-context.md
547550
- name: Data channel

0 commit comments

Comments
 (0)