Skip to content

Commit 583bd42

Browse files
committed
Add closed captions support into UI library
1 parent c18b693 commit 583bd42

File tree

8 files changed

+101
-0
lines changed

8 files changed

+101
-0
lines changed
886 KB
Loading

articles/communication-services/concepts/ui-library/includes/mobile-ui-use-cases.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ You can use the call composite in Communication Services to create these use cas
2222
| [Teams interoperability](../../teams-interop.md) | Join the call lobby |
2323
| | Display a transcription and recording alert banner |
2424
| | Admit/Reject lobby participants |
25+
| Closed Captions | Teams interoperability |
26+
| | Group call, Rooms call, and 1:1 call |
2527
| Participant gallery | Show remote participants on a grid |
2628
| | Make video preview available throughout a call for a local user |
2729
| | Make default avatars available when video is off |
@@ -69,6 +71,17 @@ The distinction between each role lies in the capabilities they possess during a
6971
> [!NOTE]
7072
> The Rooms API serves the purpose of creating rooms, managing users, and adjusting the lifetime of rooms. It is important to note that the Rooms API is a back-end service that is separate from the UI Library.
7173
74+
### Closed captions
75+
76+
Closed captions enable a wide range of scenarios, including interoperability with Teams, Azure Communication Services Group calls, Rooms calls, and one-on-one calls. This feature ensures that users can follow along with conversations in various calling environments, **enhancing accessibility** and user experience. However, it's important to note that users need to manually select the language for captions using the UI Library out of the box, as the system doesn't automatically detect the spoken language.
77+
78+
:::image type="content" source="mobile-ui-closed-captions.png" alt-text="Closed captions looks like into the UI Library":::
79+
80+
> [!NOTE]
81+
>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.
82+
83+
If you're looking more detailed information about closed captions, feel free to visit [the documentation](../../voice-video-calling/closed-captions.md) to review explanations and usage guidelines. Additionally, if you want to jump directly into the configuration of closed captions directly within the UI Library, you can follow our [tutorial](../../../how-tos/ui-library-sdk/closed-captions.md) for easy setup.
84+
7285
### View shared content
7386

7487
Through the UI Library for mobile native platforms, call participants can view shared content when other participants share their screens during a Teams call. A remote participant can use stretch and pinch gestures to zoom in or out on the shared content in the call.

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,4 @@ Microsoft indicates to you via the Azure Communication Services API that recordi
5353

5454
- Get started with a [Closed Captions Quickstart](../../quickstarts/voice-video-calling/get-started-with-closed-captions.md)
5555
- Learn more about using closed captions in [Teams interop](../interop/enable-closed-captions.md) scenarios.
56+
- Learn more about using closed captions in [UI Library](../ui-library/ui-library-overview.md) scenarios.
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: Enable scenarios using close captions and the UI Library
3+
titleSuffix: An Azure Communication Services how-to guide
4+
description: Enable scenarios using closed captions and Azure Communication Services UI Library.
5+
author: garchiro7
6+
ms.author: jorgegarc
7+
ms.service: azure-communication-services
8+
ms.subservice: calling
9+
ms.topic: how-to
10+
ms.date: 07/01/2024
11+
ms.custom: template-how-to
12+
zone_pivot_groups: acs-plat-ios-android
13+
14+
#Customer intent: As a developer, I want setup closed captions into a call using the UI Library.
15+
---
16+
17+
# Closed captions
18+
19+
Closed captions play a critical role in video voice calling apps, providing numerous benefits that enhance the accessibility, usability, and overall user experience of these platforms.
20+
21+
The Azure Communication Services UI Library offers the capabilities to enable closed captions in the calling composite and set up the default language, but the end users are always capable to select the language via UI interaction.
22+
23+
:::image type="content" source="./includes/closed-captions/mobile-ui-closed-captions.png" alt-text="Closed captions looks like into the UI Library":::
24+
25+
In this article, you learn how to enable closed captions scenarios using the UI Library.
26+
27+
## Prerequisites
28+
29+
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
30+
- A deployed Communication Services resource. [Create a Communication Services resource](../../quickstarts/create-communication-resource.md).
31+
- A user access token to enable the call client. [Get a user access token](../../quickstarts/access-tokens.md).
32+
- Optional: Completion of the [quickstart for getting started with the UI Library composites](../../quickstarts/ui-library/get-started-composites.md).
33+
34+
## Set up the feature
35+
36+
::: zone pivot="platform-android"
37+
[!INCLUDE [Enable closed captions in the Android UI Library](./includes/closed-captions/android.md)]
38+
::: zone-end
39+
40+
::: zone pivot="platform-ios"
41+
[!INCLUDE [Enable closed captions in the iOS UI Library](./includes/closed-captions/ios.md)]
42+
::: zone-end
43+
44+
## Next steps
45+
46+
- [Learn more about the UI Library](../../concepts/ui-library/ui-library-overview.md)
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
description: description: Enable scenarios using closed captions and the UI Library in Android
3+
author: garchiro7
4+
5+
ms.author: jorgegarc
6+
ms.date: 07/01/2024
7+
ms.topic: include
8+
ms.service: azure-communication-services
9+
---
10+
11+
### Enable closed captions
12+
13+
#### [Kotlin](#tab/kotlin)
14+
15+
```kotlin
16+
17+
```
18+
19+
#### [Java](#tab/java)
20+
21+
```java
22+
23+
```
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
description: Enable scenarios using closed captions and the UI Library in iOS
3+
author: garchiro7
4+
5+
ms.author: jorgegarc
6+
ms.date: 07/01/2024
7+
ms.topic: include
8+
ms.service: azure-communication-services
9+
---
10+
11+
### Enable closed captions
12+
13+
```swift
14+
15+
```
16+
886 KB
Loading

articles/communication-services/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -422,6 +422,8 @@ items:
422422
items:
423423
- name: Configure default orientation
424424
href: how-tos/ui-library-sdk/orientation.md
425+
- name: Configure closed captions
426+
href: how-tos/ui-library-sdk/closed-captions.md
425427
- name: Configure theming
426428
href: how-tos/ui-library-sdk/theming.md
427429
- name: Disable end call confirmation

0 commit comments

Comments
 (0)