|
| 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. |
| 5 | +author: ahammer |
| 6 | +ms.date: 12/4/2024 |
| 7 | +ms.author: adamhammer |
| 8 | +ms.topic: conceptual |
| 9 | +ms.service: azure-communication-services |
| 10 | +ms.subservice: calling |
| 11 | +--- |
| 12 | + |
| 13 | +# Real Time Text (RTT) Overview |
| 14 | + |
| 15 | +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 broadcasted instantly. |
| 16 | + |
| 17 | +Here are the main scenarios where Real Time Text (RTT) is useful: |
| 18 | + |
| 19 | +## Common Use Cases |
| 20 | + |
| 21 | +### Building Accessible Experiences |
| 22 | + |
| 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 | + |
| 25 | +### Enhancing Communication Clarity |
| 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 ensures that critical information is communicated without misunderstandings. |
| 28 | + |
| 29 | +## When to Use Real Time Text (RTT) |
| 30 | + |
| 31 | +- **Accessibility Requirements:** When developing applications that need to comply with accessibility standards, enabling RTT ensures that users with speech difficulties can participate effectively. |
| 32 | +- **High-Noise Environments:** In settings where audio quality may be affected by background noise, RTT provides a clear and reliable means of communication. |
| 33 | + |
| 34 | +## RealTimeTextInfo/Details Class |
| 35 | + |
| 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 | + |
| 38 | +### Properties and Fields |
| 39 | + |
| 40 | +- **Sender:** Provides information about the user who sent the RTT message. |
| 41 | +- **SequenceId:** A unique identifier that maintains the order of messages. |
| 42 | +- **Text:** The actual content of the RTT message. |
| 43 | +- **ResultType/Kind:** Indicates whether the message is partial (`ResultType`) or finalized (`Kind`), determining if it can be edited. |
| 44 | +- **ReceivedTime:** Timestamp marking when the message was received. |
| 45 | +- **UpdatedTime:** Timestamp indicating the last update to the message. |
| 46 | +- **IsLocal:** A boolean flag indicating if the message was sent by the local user. |
| 47 | + |
| 48 | +### Usage |
| 49 | + |
| 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. |
| 51 | + |
| 52 | +## Next Steps |
| 53 | + |
| 54 | +- Get started with a [Quickstart Guide](../../quickstarts/RTTQuickstart.md) |
| 55 | +- Learn more about using Real Time Text in [Accessible Communications](../accessible-communications/RTTIntegration.md) |
| 56 | +- Explore the [UI Library](../ui-library/ui-library-overview.md) |
0 commit comments