Skip to content

Commit feec1ba

Browse files
Merge branch 'main' into vhuseinova/release-template-link-added
2 parents f3e1bb7 + c20e264 commit feec1ba

File tree

3 files changed

+38
-40
lines changed

3 files changed

+38
-40
lines changed
Loading
-85.5 KB
Binary file not shown.
Lines changed: 38 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
import { Stack } from '@fluentui/react';
21
import { Meta } from '@storybook/addon-docs';
32
import { SingleLineBetaBanner } from '../../BetaBanners/SingleLineBetaBanner';
4-
import { overviewPageImagesStackStyle } from '../../constants';
53

64
<Meta title="Concepts/Real-Time Text" />
75

@@ -25,11 +23,26 @@ Enhancing Clarity: In noisy environments or situations with audio quality issues
2523

2624
Microsoft is dedicated to accessibility, and the incorporation of Real-Time Text (RTT) supports this commitment by adhering to accessibility standards such as The European Accessibility Act (Directive (EU) 2019/882. This directive requires that voice and video services support RTT by June 2025, ensuring inclusive communication throughout Europe. Voice and video services will not be permitted to operate in Europe or have Europe based customers after June 2025 without RTT, making the inclusion of this feature in the UI Library critically important.
2725

28-
## Incorporating RTT in Your Experience
26+
## How RTT Works in a Call Experience
27+
28+
Real-Time Text (RTT) is tightly integrated into both the communication flow and the UI, ensuring that users can engage in dynamic, real-time conversations.
29+
30+
When a call starts, RTT is not enabled by default. Participants can choose to activate it at any time during the call. To enable RTT, users open the call control bar—usually located at the bottom of the screen—and click on the "More" button, represented by an ellipsis (...). From the menu that appears, selecting the "Start Real-Time Text" option activates RTT for everyone in the call. A notification is displayed to inform all participants that RTT has been turned on and cannot be disabled for the rest of the call.
2931

30-
Real-Time Text is supported by default and are automatically included within the CallComposite and CallWithChatComposite experiences.
32+
<img style={{ width: '100%' }} src="images/StartRTT.png" alt="example of component that can be used for starting RTT" />
3133

32-
Real-Time Text is also supported for component only users.
34+
Once RTT is enabled, participants can type messages in a dedicated text window that appears in the captions area. As each character is typed, it is immediately visible to everyone in real time, creating a natural, continuous flow of communication. This allows both the person typing and other participants to engage with the conversation without waiting for complete messages. RTT can also merge seamlessly with live captions to deliver a unified text experience. This allows users to view both real-time messages and captions in one place, ensuring accessibility and minimal UI clutter.
35+
36+
Although RTT exists in the caption window, it can still be enabled without captions being enabled. Similarly, captions can still be enabled without RTT being enabled. When both captions and RTT are enabled, both captions and RTT messages are displayed in the same interface. RTT messages show a "RTT Typing" tag while they are being composed and then integrate into the captions feed once committed. The design prioritizes usability, making it easy for participants to activate and follow conversations without interruptions.
37+
38+
<img
39+
style={{ width: '100%' }}
40+
src="images/CaptionsBannerRTT.png"
41+
alt="example of Captions Banner with Real-Time Text Enabled"
42+
/>
43+
## Incorporating RTT in Your Experience
44+
45+
RTT is automatically available in the UI Library. RTT is integrated by default within the CallComposite, CallWithChatComposite, and is available to be built using the associated Components. These components automatically manage message display states, typing indicators, and user interaction prompts to deliver a fluid, accessible experience. Developers can use these four components to build their own customer RTT experience.
3346

3447
List of components exported for Real-Time Text:
3548

@@ -41,41 +54,6 @@ List of components exported for Real-Time Text:
4154

4255
[CaptionsBanner](./?path=/docs/components-captions-banner--docs) is a component that combines and displays captions and Real-Time Text in one banner. Developers and use 'usePropsFor' to gather all the information required to power this component, including the list of Real-Time Text and captions messages in the call. User can also use this component for captions only or Real-Time Text only.
4356

44-
## How to use Real-Time Text
45-
46-
Real-Time Text is automatically included within the CallComposite and CallWithChatComposite experiences.
47-
48-
To turn on Real-Time Text, users need to navigate to the control bar after call is connected, and click on more button. Inside the menu pop up, click on Real-Time Text, then click on Turn on RTT for this call.
49-
50-
Note that Real-Time Text will be enabled for all participants in the call once the first message is sent. It cannot be turned off.
51-
52-
<Stack tokens={{ childrenGap: '3rem' }} style={overviewPageImagesStackStyle}>
53-
<Stack.Item align="center">
54-
<>Using the more menu to turn on Real-Time Text</>
55-
<img
56-
style={{ width: '100%' }}
57-
src="images/StartRTT.png"
58-
alt="example of component that can be used for starting RTT"
59-
/>
60-
</Stack.Item>
61-
<Stack.Item align="center">
62-
<>Real-Time Text Modal showing the disclaimer warning</>
63-
<img
64-
style={{ width: '100%' }}
65-
src="images/RTTModal.png"
66-
alt="example of component that can be used for showing a disclaimer warning that Real-Time Text is enabled for everyone in the call once turned on"
67-
/>
68-
</Stack.Item>
69-
<Stack.Item align="center">
70-
<>Captions Banner with Real-Time Text Enabled</>
71-
<img
72-
style={{ width: '100%' }}
73-
src="images/CaptionsBannerRTT.png"
74-
alt="example of Captions Banner with Real-Time Text Enabled"
75-
/>
76-
</Stack.Item>
77-
</Stack>
78-
7957
## RTT is available in these scenarios
8058

8159
| Call Type | Supported | Notes |
@@ -89,3 +67,23 @@ Note that Real-Time Text will be enabled for all participants in the call once t
8967

9068
To read more details about the underlying infrastructure, click here:
9169
[Real Time Text (RTT) Overview - An Azure Communication Services concept document | Microsoft Learn](https://learn.microsoft.com/en-us/azure/communication-services/concepts/voice-video-calling/real-time-text)
70+
71+
## FAQ
72+
73+
### How can I enable RTT?
74+
75+
RTT can be enabled during calls via the control bar “more” button.
76+
77+
Enabling RTT opens the RTT window for everyone in the call. When one user enables RTT, other users do not need to enable it for themselves. This window cannot be closed for the duration of the call nor can RTT be disabled.
78+
79+
### When I type a sentence in the RTT window, when does it get sent?
80+
81+
A message is sent when the user explicitly takes an action, such as pressing "Enter," or if no additional text is typed for 3 seconds, at which point the text will automatically commit.
82+
83+
Otherwise, text remains ephemeral as it is being typed, allowing users to see characters appear in real time without immediately committing to a message.
84+
85+
### How does this differ from chat?
86+
87+
Chat is an asynchronous form of messaging that requires a user to type out their whole sentence and commit it before anyone else sees the message. Chat can also be closed or hidden in many calls, giving it a secondary level of prominence.
88+
89+
RTT is a synchronous form of messaging that shows text as it is typed in the main video gallery. The window cannot be hidden or closed, giving it the same level of prominence as speaking would in a call. RTT is also a focused accessibility feature.

0 commit comments

Comments
 (0)