|
1 | 1 | --- |
2 | | -title: Real Time Text (RTT) Overview |
3 | | -titleSuffix: An Azure Communication Services concept document |
4 | | -description: Learn about Real Time Text (RTT) in Azure Communication Services. |
| 2 | +title: Real Time Text (RTT) overview |
| 3 | +titleSuffix: An Azure Communication Services article |
| 4 | +description: This article describes Real Time Text (RTT) in Azure Communication Services. |
5 | 5 | author: ahammer |
6 | | -ms.date: 12/4/2024 |
| 6 | +ms.date: 06/24/2025 |
7 | 7 | ms.author: adamhammer |
8 | 8 | ms.topic: conceptual |
9 | 9 | ms.service: azure-communication-services |
10 | 10 | ms.subservice: calling |
11 | 11 | --- |
12 | | -# Real Time Text (RTT) Overview |
| 12 | +# Real Time Text (RTT) overview |
| 13 | + |
13 | 14 | >[!NOTE] |
14 | | ->RTT is an accessibility compliance requirement for voice and video platforms in the EU starting June 30, 2025. You can find more information about this here: [Directive 2019/882](https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX%3A32019L0882) |
| 15 | +>RTT is an accessibility compliance requirement for voice and video platforms in the EU starting June 30, 2025. For more information, see [Directive 2019/882](https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX%3A32019L0882). |
15 | 16 |
|
16 | 17 | Real Time Text (RTT) provides developers with the ability to transmit text in near real-time during a call. This feature is designed to empower individuals who have difficulty speaking, ensuring their text messages are displayed prominently to other meeting participants, similar to spoken communication. RTT enhances accessibility by allowing participants to communicate effectively through typed messages that are broadcast instantly character by character, without having to press a "send" key. |
17 | 18 |
|
18 | 19 | ## Common Use Cases |
| 20 | + |
19 | 21 | ### Building Accessible Experiences |
| 22 | + |
20 | 23 | RTT aids in creating inclusive communication platforms by enabling users with speech impairments to participate fully in calls. By providing a text-based communication channel that operates in real-time, RTT ensures that all participants can engage equally, regardless of their ability to speak. |
| 24 | + |
21 | 25 | ### Enhancing Communication Clarity |
22 | | -In scenarios where speech clarity is compromised due to background noise or technical limitations, RTT serves as a reliable alternative to convey messages clearly. This ensures that critical information is communicated without misunderstandings. |
| 26 | + |
| 27 | +In scenarios where speech clarity is compromised due to background noise or technical limitations, RTT serves as a reliable alternative to convey messages clearly. This real time display ensures that critical information is communicated without misunderstandings. |
| 28 | + |
23 | 29 | ## When to Use Real Time Text (RTT) |
| 30 | + |
24 | 31 | - **Accessibility Requirements:** When developing applications that need to comply with accessibility standards, enabling RTT ensures that users with speech difficulties can participate effectively. |
25 | | -- **High-Noise Environments:** In settings where audio quality may be affected by background noise, RTT provides a clear and reliable means of communication. |
| 32 | +- **High-Noise Environments:** In settings where background noise affects audio quality, RTT provides a clear and reliable means of communication. |
| 33 | + |
26 | 34 | ## RealTimeTextInfo/Details Class |
| 35 | + |
27 | 36 | The `RealTimeTextInfo` (or `RealTimeTextDetails` on certain platforms) class is pivotal in managing RTT messages. It encapsulates all necessary information about each RTT message, including the sender, content, sequence identifier, result type, timestamps, and whether the message originates locally. |
| 37 | + |
28 | 38 | ### Properties and Fields |
| 39 | + |
29 | 40 | - **Sender:** Provides information about the user who sent the RTT message. |
30 | 41 | - **SequenceId:** A unique identifier that maintains the order of messages. |
31 | 42 | - **Text:** The actual content of the RTT message. |
32 | 43 | - **ResultType/Kind:** Indicates whether the message is partial (`ResultType`) or finalized (`Kind`), determining if it can be edited. |
33 | 44 | - **ReceivedTime:** Timestamp marking when the message was received. |
34 | 45 | - **UpdatedTime:** Timestamp indicating the last update to the message. |
35 | | -- **IsLocal:** A boolean flag indicating if the message was sent by the local user. |
| 46 | +- **IsLocal:** A boolean flag indicating if the local user sent a message. |
| 47 | + |
36 | 48 | ### Usage |
| 49 | + |
37 | 50 | Developers can subscribe to RTT events through a single event subscription, allowing them to manage their own list and ordering of RTT messages. This approach aligns with the Captions API, facilitating easier integration and maintenance. The UI is responsible for binding the data to the screen, managing the display list, and handling text input interactions based on message finalization. |
38 | 51 |
|
39 | 52 | >[!NOTE] |
40 | | ->RTT for PSTN or Teams Interop scenarios is not available at this time. |
| 53 | +>RTT for PSTN or Teams Interop scenarios isn't available at this time. |
41 | 54 |
|
42 | 55 | ### Privacy Concerns |
| 56 | + |
43 | 57 | Real-Time Text (RTT) is only available during the call or meeting. Azure Communication Services doesn't store these text exchanges anywhere. Many countries/regions and states have laws and regulations that apply to the storing of data. It is your responsibility to use RTT in compliance with the law should you choose to store any of the data generated through RTT. You must obtain consent from the parties involved in a manner that complies with the laws applicable to each participant. |
44 | | -Interoperability between Azure Communication Services and Microsoft Teams enables your applications and users to participate in Teams calls, meetings, and chats. It is your responsibility to ensure that the users of your application are notified when RTT is enabled in a Teams call or meeting and being stored. |
45 | | -Microsoft indicates to you via the Azure Communication Services API that recording or RTT 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. |
46 | 58 |
|
47 | | -## Next Steps |
| 59 | +Interoperability between Azure Communication Services and Microsoft Teams enables your applications and users to participate in Teams calls, meetings, and chats. It is your responsibility to ensure that your application users are notified when RTT is enabled in a Teams call or meeting and being stored. |
| 60 | + |
| 61 | +Microsoft indicates to you via the Azure Communication Services API that recording or RTT started, 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. |
| 62 | + |
| 63 | +## Next steps |
48 | 64 |
|
49 | | -- Get started with our [Quickstart Guide](../../quickstarts/voice-video-calling/get-started-with-real-time-text.md) |
50 | | -- Learn more about [Closed captions](../../concepts/voice-video-calling/closed-captions.md) |
51 | | -- Get started with RTT in the [UI Library](../ui-library/ui-library-overview.md) |
| 65 | +- Get started with our [Quickstart Guide](../../quickstarts/voice-video-calling/get-started-with-real-time-text.md). |
| 66 | +- Learn more about [Closed captions](../../concepts/voice-video-calling/closed-captions.md). |
| 67 | +- Get started with RTT in the [UI Library](../ui-library/ui-library-overview.md). |
0 commit comments