Navigation
API > API/Plugins > API/Plugins/ScreenReader > API/Plugins/ScreenReader/Announcement
References
| Module | ScreenReader |
| Header | /Engine/Plugins/Experimental/ScreenReader/Source/ScreenReader/Public/Announcement/ScreenReaderAnnouncementChannel.h |
| Include | #include "Announcement/ScreenReaderAnnouncementChannel.h" |
Syntax
class FScreenReaderAnnouncementChannel
Remarks
An announcement channel handles processing of announcements and speaking announcements through text to speech (TTS). Announcements are forwarded here from a screen reader user and the announcements will be spoken immediately, queued or interrupt the currently spoken announcement. See FScreenReaderUser for an explanation of these functions and FScreenReaderAnnouncement for how announcements are used.
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
FScreenReaderAnnouncementChannel
(
const TSharedRef< FTextToSpeechBase >& InTextToSpeech |
||
 |
FScreenReaderAnnouncementChannel
(
const FScreenReaderAnnouncementChannel& OtherAnnouncementChannel |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | Activate () |
|
 |
FScreenReaderReply | ||
 |
void | Deactivate () |
|
  |
float | ||
  |
float | ||
  |
bool | IsSpeaking () |
|
  |
bool | ||
 |
FScreenReaderReply | MuteSpeech () |
|
 |
FScreenReaderReply | RequestSpeak
(
FScreenReaderAnnouncement InAnnouncement |
|
 |
FScreenReaderReply | RequestSpeakWidget
(
const TSharedRef< IAccessibleWidget >& InWidget |
|
 |
FScreenReaderReply | SetSpeechRate
(
float InRate |
|
 |
FScreenReaderReply | SetSpeechVolume
(
float InVolume |
|
 |
FScreenReaderReply | StopSpeaking () |
|
 |
FScreenReaderReply | UnmuteSpeech () |
Operators
| Type | Name | Description | |
|---|---|---|---|
 |
FScreenReaderAnnouncementChannel & | operator=
(
const FScreenReaderAnnouncementChannel& OtherAnnouncementChannel |