Skip to content

Commit 5d9f25b

Browse files
committed
Fixed spelling issue and added TOC entry
1 parent 41527d2 commit 5d9f25b

File tree

6 files changed

+54
-50
lines changed

6 files changed

+54
-50
lines changed
Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Quickstart - Add precall diagnostics to your app
2+
title: Quickstart - Add pre-call diagnostics to your app
33
titleSuffix: An Azure Communication Services quickstart
4-
description: In this quickstart, you will learn how to add pre call diagnostics capabilities to your app by using Azure Communication Services.
4+
description: This quickstart describes how to add pre-call diagnostics capabilities to your app using Azure Communication Services.
55
author: yassirbisteni
66
manager: bobgao
77
ms.author: yassirb
@@ -13,21 +13,22 @@ zone_pivot_groups: acs-plat-web-windows-android-ios
1313
ms.custom: mode-other, devx-track-js
1414
---
1515

16-
# Quickstart: Add precall diagnostics to your app
16+
# Quickstart: Add pre-call diagnostics to your app
17+
1718
::: zone pivot="platform-web"
18-
[!INCLUDE [Precall diagnostics with JavaScript](./includes/pre-call-diagnostics/pre-call-diagnostics-javascript.md)]
19+
[!INCLUDE [Pre-call diagnostics with JavaScript](./includes/pre-call-diagnostics/pre-call-diagnostics-javascript.md)]
1920
::: zone-end
2021

2122
::: zone pivot="platform-windows"
22-
[!INCLUDE [Precall diagnostics with Windows](./includes/pre-call-diagnostics/pre-call-diagnostics-windows.md)]
23+
[!INCLUDE [Pre-call diagnostics with Windows](./includes/pre-call-diagnostics/pre-call-diagnostics-windows.md)]
2324
::: zone-end
2425

2526
::: zone pivot="platform-android"
26-
[!INCLUDE [Precall diagnostics with Android](./includes/pre-call-diagnostics/pre-call-diagnostics-android.md)]
27+
[!INCLUDE [Pre-call diagnostics with Android](./includes/pre-call-diagnostics/pre-call-diagnostics-android.md)]
2728
::: zone-end
2829

2930
::: zone pivot="platform-ios"
30-
[!INCLUDE [Precall diagnostics with iOS](./includes/pre-call-diagnostics/pre-call-diagnostics-ios.md)]
31+
[!INCLUDE [Pre-call diagnostics with iOS](./includes/pre-call-diagnostics/pre-call-diagnostics-ios.md)]
3132
::: zone-end
3233

3334
## Pricing
@@ -36,14 +37,14 @@ When the pre-call diagnostic test runs behind the scenes, it uses calling minute
3637

3738
## Next steps
3839

39-
- [Check your network condition with the diagnostics tool](../../concepts/developer-tools/network-diagnostic.md)
40-
- [Explore User-Facing Diagnostic APIs](../../concepts/voice-video-calling/user-facing-diagnostics.md)
41-
- [Enable Media Quality Statistics in your application](../../concepts/voice-video-calling/media-quality-sdk.md)
42-
- [Consume call logs with Azure Monitor](../../concepts/analytics/logs/voice-and-video-logs.md)
40+
- [Check your network condition with the diagnostics tool](../../concepts/developer-tools/network-diagnostic.md).
41+
- [Explore User-Facing Diagnostic APIs](../../concepts/voice-video-calling/user-facing-diagnostics.md).
42+
- [Enable Media Quality Statistics in your application](../../concepts/voice-video-calling/media-quality-sdk.md).
43+
- [Consume call logs with Azure Monitor](../../concepts/analytics/logs/voice-and-video-logs.md).
4344

4445
## Related articles
4546

4647
- Check out the [calling hero sample](../../samples/calling-hero-sample.md).
4748
- Get started with the [UI Library](../../concepts/ui-library/ui-library-overview.md).
4849
- Learn about [Calling SDK capabilities](./getting-started-with-calling.md?pivots=platform-web).
49-
- Learn more about [how calling works](../../concepts/voice-video-calling/about-call-types.md).
50+
- Learn more about [how calling works](../../concepts/voice-video-calling/about-call-types.md).

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Azure Communication Services precall diagnostics
2+
title: Azure Communication Services pre-call diagnostics
33
titleSuffix: An Azure Communication Services concept document
4-
description: Overview of the precall diagnostic API feature.
4+
description: Overview of the pre-call diagnostic API feature.
55
author: yassirbisteni
66
manager: bobgao
77
services: azure-communication-services
@@ -11,15 +11,15 @@ ms.topic: conceptual
1111
ms.service: azure-communication-services
1212
---
1313

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

20-
## Precall diagnostics access
20+
### Pre-call diagnostics access
2121

22-
To access precall diagnostics, you need to initialize a `CallClient`, and provision an Azure Communication Services access token. Then you can access the `PreCallDiagnostics` feature and the `startTest` method.
22+
To access pre-call diagnostics, you need to initialize a `CallClient`, and provision an Azure Communication Services access token. Then you can access the `PreCallDiagnostics` feature and the `startTest` method.
2323

2424
```java
2525
String acsToken = "";
@@ -38,7 +38,7 @@ catch (Exception ex) { }
3838

3939
Once it finishes running, developers can access the result object.
4040

41-
## Diagnostic results
41+
### Diagnostic results
4242

4343
Pre-call diagnostics return a full diagnostic of the device including details like availability and compatibility, call quality statistics, and in-call diagnostics. The results are returned as a `PreCallDiagnosticsReadyEvent` object.
4444

@@ -66,7 +66,7 @@ public void OnPreCallDiagnosticsReady(PreCallDiagnosticsReadyEvent args)
6666
}
6767
```
6868

69-
You can access individual result objects using the `PreCallDiagnosticsReadyEvent` type. Results for individual tests are returned as they are completed with many of the test results being available immediately. The results might take up to 1 minute as the test validates the quality of the video and audio.
69+
You can access individual result objects using the `PreCallDiagnosticsReadyEvent` type. Results for individual tests are returned when completed with many of the test results being available immediately. The results might take up to 1 minute as the test validates the quality of the video and audio.
7070

7171
### Device permissions
7272

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

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
---
2-
title: Azure Communication Services precall diagnostics
2+
title: Azure Communication Services pre-call diagnostics
33
titleSuffix: An Azure Communication Services concept document
4-
description: Overview of the precall diagnostic API feature.
4+
description: Implement the pre-call diagnostic API feature.
55
author: yassirbisteni
66
manager: bobgao
77
services: azure-communication-services
8-
ms.author: yassirb
9-
ms.date: 12/12/2024
8+
ms.author: ybisteni
9+
ms.date: 11/11/2024
1010
ms.topic: conceptual
1111
ms.service: azure-communication-services
1212
---
1313

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

20-
## Precall diagnostics access
20+
### Pre-call diagnostics access
2121

22-
To access precall diagnostics, you need to initialize a `CallClient`, and provision an Azure Communication Services access token. Then you can access the `PreCallDiagnostics` feature and the `startTest` method.
22+
To access pre-call diagnostics, you need to initialize a `CallClient`, and provision an Azure Communication Services access token. Then you can access the `PreCallDiagnostics` feature and the `startTest` method.
2323

2424
```swift
2525
let acsToken: String;
@@ -65,9 +65,9 @@ class PreCallDiagnosticsCallClientFeatureObserver: NSObject, PreCallDiagnosticsC
6565

6666
Once it finishes running, developers can access the result object.
6767

68-
## Diagnostic results
68+
### Diagnostic results
6969

70-
Pre-call diagnostics return a full diagnostic of the device including details like availability and compatibility, call quality statistics, and in-call diagnostics. The results are returned as a `PreCallDiagnosticsReadyEvent` object.
70+
Pre-call diagnostics returns a full diagnostic of the device including details like availability and compatibility, call quality statistics, and in-call diagnostics. The results are returned as a `PreCallDiagnosticsReadyEvent` object.
7171

7272
```swift
7373
func onPreCallDiagnosticsReady(args: PreCallDiagnosticsReadyEventArgs) -> Void
@@ -91,12 +91,12 @@ func onPreCallDiagnosticsReady(args: PreCallDiagnosticsReadyEventArgs) -> Void
9191
}
9292
```
9393

94-
You can access individual result objects using the `PreCallDiagnosticsReadyEvent` type. Results for individual tests are returned as they are completed with many of the test results being available immediately. The results might take up to 1 minute as the test validates the quality of the video and audio.
94+
You can access individual result objects using the `PreCallDiagnosticsReadyEvent` type. Results for individual tests are returned as they're completed with many of the test results being available immediately. The results might take up to 1 minute as the test validates the quality of the video and audio.
9595

96-
### Device permissions
96+
#### Device permissions
9797

9898
The permission check determines whether video and audio devices are available from a permissions perspective. Provides `boolean` value for `audio` and `video` devices.
9999

100100
```swift
101101
let permissionList = preCallDiagnosticsFeature?.devicePermissions()
102-
```
102+
```

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Azure Communication Services precall diagnostics
2+
title: Azure Communication Services pre-call diagnostics
33
titleSuffix: An Azure Communication Services concept document
4-
description: Overview of the precall diagnostic API feature.
4+
description: Overview of the pre-call diagnostic API feature.
55
author: tophpalmer
66
manager: chpalm
77
services: azure-communication-services
@@ -11,11 +11,11 @@ ms.topic: conceptual
1111
ms.service: azure-communication-services
1212
---
1313

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

2020
## Prerequisites
2121

@@ -30,12 +30,12 @@ The precall API feature enables developers to programmatically validate a client
3030

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

33-
## Accessing precall diagnostics
33+
## Accessing pre-call diagnostics
3434

3535
>[!IMPORTANT]
3636
>Pre-call diagnostics are available starting with version [1.9.1-beta.1](https://www.npmjs.com/package/@azure/communication-calling/v/1.9.1-beta.1) of the Calling SDK. Make sure to use that version or higher when following these instructions.
3737
38-
To Access precall diagnostics, you need to initialize a `callClient`, and provision an Azure Communication Services access token. There you can access the `PreCallDiagnostics` feature and the `startTest` method.
38+
To access pre-call diagnostics, you need to initialize a `callClient`, and provision an Azure Communication Services access token. There you can access the `PreCallDiagnostics` feature and the `startTest` method.
3939

4040
```javascript
4141
import { CallClient, Features} from "@azure/communication-calling";
@@ -124,7 +124,7 @@ If devices aren't available, the user shouldn't continue into joining a call. Ra
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](../../../../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.
127+
InCall diagnostics uses [Media quality statistics](../../../../concepts/voice-video-calling/media-quality-sdk.md) to calculate quality scores and diagnose issues. During the pre-call 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

129129
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

@@ -142,4 +142,4 @@ The InCall diagnostic provides a convenience layer on top of media quality stati
142142
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).
143143

144144
- 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).
145-
- 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.
145+
- 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: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Azure Communication Services precall diagnostics
2+
title: Azure Communication Services pre-call diagnostics
33
titleSuffix: An Azure Communication Services concept document
4-
description: Overview of the precall diagnostic API feature.
4+
description: Overview of the pre-call diagnostic API feature.
55
author: yassirbisteni
66
manager: bobgao
77
services: azure-communication-services
@@ -11,15 +11,15 @@ ms.topic: conceptual
1111
ms.service: azure-communication-services
1212
---
1313

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

20-
## Precall diagnostics access
20+
### Pre-call diagnostics access
2121

22-
To access precall diagnostics, you need to initialize a `CallClient`, and provision an Azure Communication Services access token. Then you can access the `PreCallDiagnostics` feature and the `startTest` method.
22+
To access pre-call diagnostics, you need to initialize a `CallClient`, and provision an Azure Communication Services access token. Then you can access the `PreCallDiagnostics` feature and the `startTest` method.
2323

2424
```c#
2525
string acsToken = "";
@@ -39,9 +39,9 @@ catch (Exception ex) { }
3939

4040
Once it finishes running, developers can access the result object.
4141

42-
## Diagnostic results
42+
### Diagnostic results
4343

44-
Precall diagnostics return a full diagnostic of the device including details like availability and compatibility, call quality statistics, and in-call diagnostics. The results are returned as a `PreCallDiagnosticsReadyEvent` object.
44+
Pre-call diagnostics return a full diagnostic of the device including details like availability and compatibility, call quality statistics, and in-call diagnostics. The results are returned as a `PreCallDiagnosticsReadyEvent` object.
4545

4646
```c#
4747
private void DiagnosticsReady(object sender, PreCallDiagnosticsReadyEventArgs args)

articles/communication-services/toc.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -390,9 +390,12 @@ items:
390390
- name: Diagnose media quality issues
391391
href: concepts/voice-video-calling/media-quality-sdk.md
392392
displayName: diagnostics, diagnose, feedback, quality, reliability, users, call, quick, satisfaction, improve, issues
393-
- name: Ensure precall readiness
393+
- name: Ensure pre-call readiness
394394
href: concepts/voice-video-calling/pre-call-diagnostics.md
395395
displayName: diagnostics, diagnose, feedback, quality, reliability, users, call, quick, satisfaction, improve, issues
396+
- name: Add pre-call diagnostics
397+
href: quickstarts/voice-video-calling/get-started-pre-call-diagnostics.md
398+
displayName: diagnostics, diagnose, feedback, quality, reliability, users, call, quick, satisfaction, improve, issues
396399
- name: Check if user is running supported browser
397400
href: how-tos/calling-sdk/browser-support.md
398401
displayName: diagnostics, diagnose, feedback, quality, reliability, users, call, quick, satisfaction, improve, issues

0 commit comments

Comments
 (0)