Skip to content

Commit e5a8b0f

Browse files
garchiro7garchiro7
committed
update the how to doc
1 parent 635a194 commit e5a8b0f

File tree

5 files changed

+75
-43
lines changed

5 files changed

+75
-43
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,4 +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.
56+
- Learn more about the [UI Library](../ui-library/ui-library-overview.md).

‎articles/communication-services/how-tos/calling-sdk/closed-captions-teams-interop-how-to.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,3 +43,4 @@ For more information, see the following articles:
4343
- Learn about [Voice](./manage-calls.md) and [Video calling](./manage-video.md).
4444
- Learn about [Teams interoperability](./teams-interoperability.md).
4545
- Learn more about Microsoft Teams [live translated captions](https://support.microsoft.com//office/use-live-captions-in-a-teams-meeting-4be2d304-f675-4b57-8347-cbd000a21260).
46+
- Learn more about the [UI Library](../../concepts//ui-library/ui-library-overview.md).

‎articles/communication-services/how-tos/ui-library-sdk/closed-captions.md

Lines changed: 53 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -18,66 +18,77 @@ zone_pivot_groups: acs-plat-ios-android
1818

1919
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.
2020

21-
In this article, you learn how to enable closed captions scenarios using the UI Library.
21+
In this article, you learn how to enable closed captions scenarios using the UI Library. There is two main scenarios to enable closed captions: Azure Communication Services video and voice calls and Interop calls.
2222

2323
## Azure Communication Service Based Captions
2424

25-
Supported by default for calls involving Azure Communication Service users only. Currently, Azure Communication Service captions **do not** support language translation.
25+
Supported for calls involving Azure Communication Service users only. Currently, Azure Communication Service captions **do not support language translation**.
2626

2727
## Teams Interop Closed Captions
2828

29-
Also supported by default and included during calls with **one or more** Teams users.
30-
Translation Support: Unlike Azure Communication Service captions, Teams Interop Closed Captions support translation. Users can opt to have captions translated into a different language through the captions settings.
29+
Supported during calls with one or more Teams users.
3130

32-
## Activate Closed Captions
31+
### Translation Support
3332

34-
### User Interaction
33+
Unlike Azure Communication Service closed captions, Teams Interop closed captions support translation. Users can opt to have closed captions translated into a different language through the captions settings.
3534

36-
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.
35+
## How to Use Captions
3736

38-
:::image type="content" source="./includes/closed-captions/mobile-ui-closed-captions.png" alt-text="Closed captions looks like into the UI Library":::
37+
Captions are seamlessly integrated within the `CallingUILibrary`.
38+
39+
1. **Activate Captions**:
40+
- During a connected call, navigate to the control bar and click the **more button**.
41+
- In the menu pop-up, toggle to turn captions on.
3942

40-
#### Spoken language
43+
2. **Adjust Spoken Language**:
44+
- If a different language is being used in the meeting, users can change the spoken language via the UI. This change applies to all users in the call.
4145

42-
If a different language is being used in the meeting, users can change the spoken language via the UI. This change applies to all users in the call.
46+
3. **Set Caption Language** (for Teams Interop Closed Captions):
47+
- By default, live captions are displayed in the language that’s spoken during the meeting or event. Live translated captions allow users to see captions translated into the language they’re most comfortable with.
48+
- Change the caption language by clicking on the **Captions Language button** after captions have started, if translation to a different language is desired.
4349

44-
#### Caption Language
50+
:::image type="content" source="./includes/closed-captions/mobile-ui-closed-captions.png" alt-text="Closed captions looks like into the UI Library":::
4551

46-
- There's no default caption language set.
47-
- Change the caption language by clicking on the Captions Language button after captions have started, if translation to a different language is desired.
52+
> [!NOTE]
53+
> Live translated captions in meetings are only available as part of [**Teams Premium**](https://learn.microsoft.com/en-us/> MicrosoftTeams/teams-add-on-licensing/licensing-enhance-teams#meetings), an add-on license that provides additional features to make Teams meetings more personalized, intelligent, and secure. To get access to Teams Premium, contact your IT admin. More details you can find it [here](../calling-sdk/closed-captions-teams-interop-how-to.md).
4854
49-
#### Supported languages
55+
## Supported languages
5056

5157
Azure Communication Services supports a variety of spoken languages for captions. Below is the list of supported language codes that can be used with the `setSpokenLanguage` method to set the desired language for captions:
5258

53-
- Arabic (UAE): `ar-ae`
54-
- Arabic (Saudi Arabia): `ar-sa`
55-
- Danish (Denmark): `da-dk`
56-
- German (Germany): `de-de`
57-
- English (Australia): `en-au`
58-
- English (Canada): `en-ca`
59-
- English (United Kingdom): `en-gb`
60-
- English (India): `en-IN`
61-
- English (New Zealand): `en-nz`
62-
- English (United States): `en-us`
63-
- Spanish (Spain): `es-es`
64-
- Spanish (Mexico): `es-mx`
65-
- Finnish (Finland): `fi-fi`
66-
- French (Canada): `fr-CA`
67-
- French (France): `fr-fr`
68-
- Hindi (India): `hi-in`
69-
- Italian (Italy): `it-it`
70-
- Japanese (Japan): `ja-jp`
71-
- Korean (Korea): `ko-kr`
72-
- Norwegian Bokmål (Norway): `nb-no`
73-
- Dutch (Belgium): `nl-be`
74-
- Dutch (Netherlands): `nl-nl`
75-
- Polish (Poland): `pl-pl`
76-
- Portuguese (Brazil): `pt-br`
77-
- Russian (Russia): `ru-ru`
78-
- Swedish (Sweden): `sv-se`
79-
- Chinese (China): `zh-cn`
80-
- Chinese (Hong Kong): `zh-hk`
59+
| Language | ACS Spoken Code | Teams Spoken Code | Teams Caption Code |
60+
|-----------------------|-----------------|-------------------|--------------------|
61+
| Arabic | ar-ae, ar-sa | ar-ae, ar-sa | ar |
62+
| Danish | da-dk | da-dk | da |
63+
| German | de-de | de-de | de |
64+
| English | en-au, en-ca, en-gb, en-in, en-nz, en-us | en-au, en-ca, en-gb, en-in, en-nz, en-us | en |
65+
| Spanish | es-es, es-mx | es-es, es-mx | es |
66+
| Finnish | fi-fi | fi-fi | fi |
67+
| French | fr-ca, fr-fr | fr-ca, fr-fr | fr, fr-ca |
68+
| Hindi | hi-in | hi-in | hi |
69+
| Italian | it-it | it-it | it |
70+
| Japanese | ja-jp | ja-jp | ja |
71+
| Korean | ko-kr | ko-kr | ko |
72+
| Norwegian | nb-no | nb-no | nb |
73+
| Dutch | nl-be, nl-nl | nl-be, nl-nl | nl |
74+
| Polish | pl-pl | pl-pl | pl |
75+
| Portuguese | pt-br | pt-br, pt-pt | pt, pt-pt |
76+
| Russian | ru-ru | ru-ru | ru |
77+
| Swedish | sv-se | sv-se | sv |
78+
| Chinese | zh-cn, zh-hk | zh-cn, zh-hk | zh-Hans, zh-Hant |
79+
| Czech | — | cs-cz | cs |
80+
| Slovak | — | sk-sk | sk |
81+
| Turkish | — | tr-tr | tr |
82+
| Vietnamese | — | vi-vn | vi |
83+
| Thai | — | th-th | th |
84+
| Hebrew | — | he-il | he |
85+
| Welsh | — | cy-gb | cy |
86+
| Ukrainian | — | uk-ua | uk |
87+
| Greek | — | el-gr | el |
88+
| Hungarian | — | hu-hu | hu |
89+
| Romanian | — | ro-ro | ro |
90+
91+
Ensure the spoken language selected matches the language used in the call to accurately generate captions.
8192

8293
## Prerequisites
8394

‎articles/communication-services/how-tos/ui-library-sdk/includes/closed-captions/android.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ ms.service: azure-communication-services
1313
#### [Kotlin](#tab/kotlin)
1414

1515
```kotlin
16+
val captionsOptions = CallCompositeCaptionsOptions()
17+
captionsOptions.setCaptionsOn(false)
18+
captionsOptions.setSpokenLanguage("en-US")
19+
20+
val localOptions = CallCompositeLocalOptions()
21+
localOptions.setCaptionsOptions(captionsOptions)
1622

1723
```
1824

‎articles/communication-services/how-tos/ui-library-sdk/includes/closed-captions/ios.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,20 @@ ms.service: azure-communication-services
1111
### Enable closed captions
1212

1313
```swift
14+
let captionsOptions = CaptionsOptions(
15+
captionsOn: false,
16+
spokenLanguage: "en-US"
17+
)
18+
19+
let localOptions = LocalOptions(
20+
participantViewData: participantViewData,
21+
setupScreenViewData: setupScreenViewData,
22+
cameraOn: false,
23+
microphoneOn: false,
24+
skipSetupScreen: false,
25+
audioVideoMode: .audioAndVideo,
26+
captionsOptions: captionsOptions
27+
)
1428

1529
```
1630

0 commit comments

Comments
 (0)