Skip to content

Commit b4d856a

Browse files
Merge pull request #281092 from valindrae/closed-captions-GA-changes
Closed captions ga changes
2 parents f3b6771 + 021dff5 commit b4d856a

File tree

3 files changed

+19
-15
lines changed

3 files changed

+19
-15
lines changed

articles/communication-services/concepts/voice-video-calling/closed-captions.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,19 @@ author: Kunaal
66
ms.service: azure-communication-services
77
ms.subservice: calling
88
ms.topic: concept-article
9-
ms.date: 02/27/2024
9+
ms.date: 07/08/2024
1010
ms.author: kpunjabi
1111
ms.custom: public_preview
1212
---
1313

1414
# Closed Captions overview
1515

16-
[!INCLUDE [Public Preview Disclaimer](../../includes/public-preview-include-document.md)]
17-
18-
>[!NOTE]
19-
>Closed Captions will not be billed at the beginning of its Public Preview. This is for a limited time only, usage of Captions will likely be billed starting from June.
20-
2116
Closed captions are a textual representation of a voice or video conversation that is displayed to users in real-time. Azure Communication Services Closed captions offer developers the ability to allow users to select when they wish to toggle captions on or off. These captions are only available during the call/meeting for the user that has selected to enable captions, Azure Communication Services does **not** store these captions anywhere. Here are main scenarios where Closed Captions are useful:
2217

2318
## Common use cases
2419

2520
### Building accessible experiences
26-
Accessibility – For people with hearing impairments or who are new to the language to participate in calls and meetings. A key feature requirement in the Telemedical industry is to help patients communicate effectively with their health care providers.
21+
Accessibility – For people with hearing impairments or who are new to the language to participate in calls and meetings. A key feature requirement in the Telemedical industry is to help patients communicate effectively with their health care providers. This can also be useful when you have scenarios where users might be joining from a PSTN phone number, this will allow your application to receive the captioning data for those users too so that everyone's input is available during these interactions.
2722

2823
### Teams interoperability
2924
Use Teams – Organizations using Azure Communication Services and Teams can use Teams closed captions to improve their applications by providing closed captions capabilities to users. Those organizations can keep using Microsoft Teams for all calls and meetings without third party applications providing this capability. Learn more about how you can use captions in [Teams interoperability](../interop/enable-closed-captions.md) scenarios.
@@ -46,8 +41,6 @@ Interoperability between Azure Communication Services and Microsoft Teams enable
4641

4742
Microsoft indicates to you via the Azure Communication Services API that recording or closed captions has commenced, and you must communicate this fact, in real-time, to your users within your application's user interface. You agree to indemnify Microsoft for all costs and damages incurred due to your failure to comply with this obligation.
4843

49-
## Known limitations
50-
- Closed captions feature isn't supported on Firefox.
5144

5245
## Next steps
5346

articles/communication-services/how-tos/calling-sdk/includes/closed-captions/closed-captions-teams-interop-web.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ author: valindrae
55
ms.service: azure-communication-services
66
ms.subservice: calling
77
ms.topic: include
8-
ms.topic: include file
98
ms.date: 07/21/2023
109
ms.author: kpunjabi
1110
---

articles/communication-services/quickstarts/voice-video-calling/includes/closed-captions/closed-captions-javascript.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
---
2-
title: include file
2+
title: Get started with Closed captions for Web app
33
description: Web how-to guide for enabling Closed captions during an ACS call.
44
author: Kunaal
55
ms.service: azure-communication-services
66
ms.subservice: calling
77
ms.topic: include
8-
ms.topic: include file
9-
ms.date: 12/19/2023
8+
ms.date: 07/08/2024
109
ms.author: kpunjabi
1110
---
1211

@@ -49,7 +48,7 @@ if (captionsCallFeature.captions.kind === 'Captions') {
4948
### Add a listener to receive captions active/inactive status
5049
```typescript
5150
const captionsActiveChangedHandler = () => {
52-
if (captions.isCaptionsFeatureActive()) {
51+
if (captions.isCaptionsFeatureActive) {
5352
/* USER CODE HERE - E.G. RENDER TO DOM */
5453
}
5554
}
@@ -90,7 +89,7 @@ const captionsReceivedHandler : CaptionsHandler = (data: CaptionsInfo) => {
9089
captionContainer.style['borderBottom'] = '1px solid';
9190
captionContainer.style['whiteSpace'] = 'pre-line';
9291
captionContainer.textContent = captionText;
93-
captionContainer.classList.add(newClassName);
92+
captionContainer.classList.add(outgoingCaption);
9493

9594
captionArea.appendChild(captionContainer);
9695
} else {
@@ -106,6 +105,8 @@ captions.on('CaptionsReceived', captionsReceivedHandler);
106105

107106
### Add a listener to receive spoken language changed status
108107
```typescript
108+
// set a local variable currentSpokenLanguage to track the current spoken language in the call
109+
let currentSpokenLanguage = ''
109110
const spokenLanguageChangedHandler = () => {
110111
if (captions.activeSpokenLanguage !== currentSpokenLanguage) {
111112
/* USER CODE HERE - E.G. RENDER TO DOM */
@@ -167,3 +168,14 @@ try {
167168
/* USER ERROR HANDLING CODE HERE */
168169
}
169170
```
171+
172+
### Add a listener to receive captions kind changed status
173+
Captions kind can change from Captions to TeamsCaptions if a Teams/CTE user joins the call or if the call changes
174+
to an interop call type. Resubscription to [Teams Captions listeners](../../../../how-tos/calling-sdk/closed-captions-teams-interop-how-to.md) is required to continue the Captions experience. TeamsCaptions kind can not be switched or changed back to Captions kind in a call once TeamsCaptions is utilized in the call.
175+
176+
```typescript
177+
const captionsKindChangedHandler = () => {
178+
/* USER CODE HERE - E.G. SUBSCRIBE TO TEAMS CAPTIONS */
179+
}
180+
captions.on('CaptionsKindChanged', captionsKindChangedHandler)
181+
```

0 commit comments

Comments
 (0)