Skip to content

Commit 710cb22

Browse files
committed
Fixed warnings
1 parent 8b2f585 commit 710cb22

File tree

6 files changed

+16
-18
lines changed

6 files changed

+16
-18
lines changed

articles/communication-services/concepts/voice-video-calling/pre-call-diagnostics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.topic: conceptual
1111
ms.service: azure-communication-services
1212
---
1313

14-
# Pre-call diagnostic
14+
# Pre-call diagnostic overview
1515

1616
[!INCLUDE [Public Preview Disclaimer](../../includes/public-preview-include.md)]
1717

articles/communication-services/quickstarts/voice-video-calling/get-started-pre-call-diagnostics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: Quickstart - Add precall diagnostics to your app
33
titleSuffix: An Azure Communication Services quickstart
44
description: In this quickstart, you will learn how to add pre call diagnostics capabilities to your app by using Azure Communication Services.
55
author: yassirbisteni
6-
7-
ms.author: ybisteni
6+
manager: bobgao
7+
ms.author: yassirb
88
ms.date: 12/12/2024
99
ms.topic: quickstart
1010
ms.service: azure-communication-services

articles/communication-services/quickstarts/voice-video-calling/includes/pre-call-diagnostics/pre-call-diagnostics-android.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.service: azure-communication-services
1515

1616
[!INCLUDE [Public Preview Disclaimer](../../../../includes/public-preview-include.md)]
1717

18-
The precall API feature allows developers to programmatically validate a client’s readiness to join an Azure Communication Services call. You can only access precall features using the Calling SDK. The precall diagnostic feature provides multiple diagnostics including device, connection, and call quality. Provide us with [feedback](../../support.md) about which platforms you want to see precall diagnostics enabled.
18+
The precall API feature allows developers to programmatically validate a client’s readiness to join an Azure Communication Services call. You can only access precall features using the Calling SDK. The precall diagnostic feature provides multiple diagnostics including device, connection, and call quality. Provide us with [feedback](../../../../support.md) about which platforms you want to see precall diagnostics enabled.
1919

2020
## Precall diagnostics access
2121

articles/communication-services/quickstarts/voice-video-calling/includes/pre-call-diagnostics/pre-call-diagnostics-ios.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.service: azure-communication-services
1515

1616
[!INCLUDE [Public Preview Disclaimer](../../../../includes/public-preview-include.md)]
1717

18-
The precall API feature allows developers to programmatically validate a client’s readiness to join an Azure Communication Services call. You can only access precall features using the Calling SDK. The precall diagnostic feature provides multiple diagnostics including device, connection, and call quality. Provide us with [feedback](../../support.md) about which platforms you want to see precall diagnostics enabled.
18+
The precall API feature allows developers to programmatically validate a client’s readiness to join an Azure Communication Services call. You can only access precall features using the Calling SDK. The precall diagnostic feature provides multiple diagnostics including device, connection, and call quality. Provide us with [feedback](../../../../support.md) about which platforms you want to see precall diagnostics enabled.
1919

2020
## Precall diagnostics access
2121

articles/communication-services/quickstarts/voice-video-calling/includes/pre-call-diagnostics/pre-call-diagnostics-javascript.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,20 @@ ms.service: azure-communication-services
1515

1616
[!INCLUDE [Public Preview Disclaimer](../../../../includes/public-preview-include.md)]
1717

18-
The precall API feature enables developers to programmatically validate a client’s readiness to join an Azure Communication Services call. You can only access precall features using the Calling SDK. The precall diagnostic feature provides multiple diagnostics including device, connection, and call quality. Provide us with [feedback](../../support.md) about which platforms you want to see precall diagnostics enabled.
18+
The precall API feature enables developers to programmatically validate a client’s readiness to join an Azure Communication Services call. You can only access precall features using the Calling SDK. The precall diagnostic feature provides multiple diagnostics including device, connection, and call quality. Provide us with [feedback](../../../../support.md) about which platforms you want to see precall diagnostics enabled.
1919

2020
## Prerequisites
2121

2222
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
2323
- [Node.js](https://nodejs.org/) active Long Term Support(LTS) versions are recommended.
24-
- An active Communication Services resource. [Create a Communication Services resource](../../quickstarts/create-communication-resource.md).
25-
- A User Access Token to instantiate the call client. Learn how to [create and manage user access tokens](../../quickstarts/identity/access-tokens.md). You can also use the Azure CLI and run the next command with your connection string to create a user and an access token. Remember to copy the connection string from the resource through Azure portal.
24+
- An active Communication Services resource. [Create a Communication Services resource](../../../create-communication-resource.md).
25+
- A User Access Token to instantiate the call client. Learn how to [create and manage user access tokens](../../../identity/access-tokens.md). You can also use the Azure CLI and run the next command with your connection string to create a user and an access token. Remember to copy the connection string from the resource through Azure portal.
2626

2727
```azurecli-interactive
2828
az communication identity token issue --scope voip --connection-string "yourConnectionString"
2929
```
3030

31-
For more information, see [Use Azure CLI to Create and Manage Access Tokens](../../quickstarts/identity/access-tokens.md?pivots=platform-azcli).
31+
For more information, see [Use Azure CLI to Create and Manage Access Tokens](../../../identity/access-tokens.md?pivots=platform-azcli).
3232

3333
## Accessing precall diagnostics
3434

@@ -82,7 +82,7 @@ const browserSupport = await preCallDiagnosticsResult.browserSupport;
8282

8383
```
8484

85-
If the test fails and the browser being used by the user is `NotSupported`, the easiest way to fix that is by asking the user to switch to a supported browser. Refer to the supported browsers in [Calling SDK overview > JavaScript Calling SDK support by OS and browser](./calling-sdk-features.md#javascript-calling-sdk-support-by-os-and-browser).
85+
If the test fails and the browser being used by the user is `NotSupported`, the easiest way to fix that is by asking the user to switch to a supported browser. Refer to the supported browsers in [Calling SDK overview > JavaScript Calling SDK support by OS and browser](../../../../concepts/voice-video-calling/calling-sdk-features.md#javascript-calling-sdk-support-by-os-and-browser).
8686

8787
>[!NOTE]
8888
>Known issue: `browser support` test returning `Unknown` in cases where it should be returning a correct value.
@@ -118,30 +118,28 @@ Device availability. Checks whether microphone, camera, and speaker devices are
118118

119119
```
120120

121-
If devices aren't available, the user shouldn't continue into joining a call. Rather, prompt the user to check device connections to ensure any headsets, cameras, or speakers are properly connected. For more information about device management, see [Manage video during calls](../../how-tos/calling-sdk/manage-video.md?pivots=platform-web#device-management).
121+
If devices aren't available, the user shouldn't continue into joining a call. Rather, prompt the user to check device connections to ensure any headsets, cameras, or speakers are properly connected. For more information about device management, see [Manage video during calls](../../../../how-tos/calling-sdk/manage-video.md?pivots=platform-web#device-management).
122122

123123
### InCall diagnostics
124124

125125
Performs a quick call to check in-call metrics for audio and video and provides results back. Includes connectivity (`connected`, boolean), bandwidth quality (`bandWidth`, `'Bad' | 'Average' | 'Good'`) and call diagnostics for audio and video (`diagnostics`). Provided diagnostic categories include `jitter`, `packetLoss`, and `rtt` and results are generated using a simple quality grade (`'Bad' | 'Average' | 'Good'`).
126126

127-
InCall diagnostics uses [Media quality statistics](./media-quality-sdk.md) to calculate quality scores and diagnose issues. During the precall diagnostic, the full set of media quality statistics are available for consumption. These statistics include raw values across video and audio metrics that you can use programatically.
127+
InCall diagnostics uses [Media quality statistics](../../../../concepts/voice-video-calling/media-quality-sdk.md) to calculate quality scores and diagnose issues. During the precall diagnostic, the full set of media quality statistics are available for consumption. These statistics include raw values across video and audio metrics that you can use programatically.
128128

129-
The InCall diagnostic provides a convenience layer on top of media quality statistics to consume the results without the need to process all the raw data. For more information including instructions to access, see [Media quality statistics for an ongoing call](./media-quality-sdk.md#media-quality-statistics-for-an-ongoing-call).
129+
The InCall diagnostic provides a convenience layer on top of media quality statistics to consume the results without the need to process all the raw data. For more information including instructions to access, see [Media quality statistics for an ongoing call](../../../../concepts/voice-video-calling/media-quality-sdk.md#media-quality-statistics-for-an-ongoing-call).
130130

131131

132132
```javascript
133-
134133
const inCallDiagnostics = await preCallDiagnosticsResult.inCallDiagnostics;
135134
if(inCallDiagnostics) {
136135
console.log(inCallDiagnostics.connected)
137136
console.log(inCallDiagnostics.bandWidth)
138137
console.log(inCallDiagnostics.diagnostics.audio)
139138
console.log(inCallDiagnostics.diagnostics.video)
140139
}
141-
142140
```
143141

144-
At this step, there are multiple possible failure points. The values provided by the API are based on the threshold values required by the service. The raw thresholds can be found in [Media quality statistics](./media-quality-sdk.md#best-practices).
142+
At this step, there are multiple possible failure points. The values provided by the API are based on the threshold values required by the service. The raw thresholds can be found in [Media quality statistics](../../../../concepts/voice-video-calling/media-quality-sdk.md#best-practices).
145143

146-
- If a connection fails, prompt users to recheck their network connectivity. Connection failures can also be attributed to network conditions like DNS, proxies, or firewalls. For more information on recommended network setting, see [Network recommendations](network-requirements.md).
144+
- If a connection fails, prompt users to recheck their network connectivity. Connection failures can also be attributed to network conditions like DNS, proxies, or firewalls. For more information on recommended network setting, see [Network recommendations](../../../../concepts/voice-video-calling/network-requirements.md).
147145
- If bandwidth is `Bad`, prompt users to try a different network or verify the bandwidth availability on their current network. Ensure no other high bandwidth activities are taking place.

articles/communication-services/quickstarts/voice-video-calling/includes/pre-call-diagnostics/pre-call-diagnostics-windows.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.service: azure-communication-services
1515

1616
[!INCLUDE [Public Preview Disclaimer](../../../../includes/public-preview-include.md)]
1717

18-
The precall API feature allows developers to programmatically validate a client’s readiness to join an Azure Communication Services call. You can only access precall features using the Calling SDK. The precall diagnostic feature provides multiple diagnostics including device, connection, and call quality. Provide us with [feedback](../../support.md) about which platforms you want to see precall diagnostics enabled.
18+
The precall API feature allows developers to programmatically validate a client’s readiness to join an Azure Communication Services call. You can only access precall features using the Calling SDK. The precall diagnostic feature provides multiple diagnostics including device, connection, and call quality. Provide us with [feedback](../../../../support.md) about which platforms you want to see precall diagnostics enabled.
1919

2020
## Precall diagnostics access
2121

0 commit comments

Comments
 (0)