Skip to content

Commit 9abba80

Browse files
authored
Merge pull request #283591 from tomaschladek/tchladek_transcription
Tchladek transcription
2 parents 552daba + 04c67b3 commit 9abba80

File tree

2 files changed

+74
-7
lines changed

2 files changed

+74
-7
lines changed

articles/communication-services/how-tos/calling-sdk/call-transcription.md

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,12 @@ ms.subservice: calling
99
ms.topic: how-to
1010
ms.date: 08/10/2021
1111
ms.custom: template-how-to
12-
zone_pivot_groups: acs-plat-ios-android-windows
13-
14-
#Customer intent: As a developer, I want to display the call transcription state on the client.
12+
zone_pivot_groups: acs-plat-web-ios-android-windows
1513
---
1614

1715
# Display call transcription state on the client
1816

19-
> [!NOTE]
20-
> Call transcription state is only available from Teams meetings. Currently there's no support for call transcription state for Azure Communication Services to Azure Communication Services calls.
21-
22-
When using call transcription you may want to let your users know that a call is being transcribe. Here's how.
17+
You need to collect consent from all participants in the call before you can transcribe them. Microsoft Teams allows users to start transcription in the meetings or calls. You would receive event when transcription has started on you can check the transcription state, if transcription started before you joined the call or meeting.
2318

2419
## Prerequisites
2520

@@ -28,6 +23,37 @@ When using call transcription you may want to let your users know that a call is
2823
- A user access token to enable the calling client. For more information, see [Create and manage access tokens](../../quickstarts/identity/access-tokens.md).
2924
- Optional: Complete the quickstart to [add voice calling to your application](../../quickstarts/voice-video-calling/getting-started-with-calling.md)
3025

26+
## Support
27+
The following tables define support of call transcription in Azure Communication Services.
28+
29+
## Identities and call types
30+
The following tables show support of transcription for specific call type and identity.
31+
32+
|Identities | Teams meeting | Room | 1:1 call | Group call | 1:1 Teams interop call | Group Teams interop call |
33+
|-----------------------------|---------------|------|----------|------------|------------------------|--------------------------|
34+
|Communication Services user | ✔️ | | | | ✔️ | ✔️ |
35+
|Microsoft 365 user | ✔️ | | | | ✔️ | ✔️ |
36+
37+
## Operations
38+
The following tables show support of individual APIs in calling SDK to individual identity types.
39+
40+
|Operations | Communication Services user | Microsoft 365 user |
41+
|-----------------------------|------------------------------|-------------------|
42+
|Get event that transcription has started | ✔️ | ✔️ |
43+
|Get transcription state | ✔️ | ✔️ |
44+
|Start or stop transcription | | |
45+
46+
## SDKs
47+
The following tables show support of transcription in individual Azure Communication Services SDKs.
48+
49+
| Platforms | Web | Web UI | iOS | iOS UI | Android | Android UI | Windows |
50+
|-------------|-----|--------|-----|--------|---------|------------|---------|
51+
|Is Supported | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
52+
53+
::: zone pivot="platform-web"
54+
[!INCLUDE [Call transcription client-side Web](./includes/call-transcription/call-transcription-web.md)]
55+
::: zone-end
56+
3157
::: zone pivot="platform-android"
3258
[!INCLUDE [Call transcription client-side Android](./includes/call-transcription/call-transcription-android.md)]
3359
::: zone-end
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
author: tomaschladek
3+
ms.service: azure-communication-services
4+
ms.topic: include
5+
ms.date: 08/08/2024
6+
ms.author: tchladek
7+
---
8+
9+
[!INCLUDE [Install SDK](../install-sdk/install-sdk-web.md)]
10+
11+
> [!WARNING]
12+
> Due to changes in Microsoft Teams, JavaScript calling SDKs with versions 1.21 and lower stops Teams transcription and blocks Teams users to start transcription. If you would like to leverage Teams transcription in the calls and meetings, you need to upgrade your calling SDK to at least version 1.22.
13+
14+
## Call transcription
15+
16+
`Transcription` is an extended feature of the class `Call`. You first need to obtain the transcription feature API object
17+
18+
```js
19+
const callTranscriptionFeature = call.feature(Features.Transcription);
20+
```
21+
22+
You can check state of the transcription in the property `isTranscriptionActive`. If value is set to `true`, then transcription is active.
23+
24+
```js
25+
const isTranscriptionActive = callTranscriptionFeature.isTranscriptionActive;
26+
```
27+
28+
You can subscribe to event that is triggered when state of transcription changes:
29+
30+
```js
31+
const isTranscriptionActiveChangedHandler = () => {
32+
console.log(callTranscriptionFeature.isTranscriptionActive);
33+
};
34+
callTranscriptionFeature.on('isTranscriptionActiveChanged', isTranscriptionActiveChangedHandler);
35+
```
36+
37+
You can unsubscribe from the event with the following code:
38+
39+
```js
40+
callTranscriptionFeature.off('isTranscriptionActiveChanged', isTranscriptionActiveChangedHandler);
41+
```

0 commit comments

Comments
 (0)