Navigation
API > API/Plugins > API/Plugins/ScreenReader
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.
| Name | FScreenReaderAnnouncementChannel |
| Type | class |
| Header File | /Engine/Plugins/Experimental/ScreenReader/Source/ScreenReader/Public/Announcement/ScreenReaderAnnouncementChannel.h |
| Include Path | #include "Announcement/ScreenReaderAnnouncementChannel.h" |
Syntax
class FScreenReaderAnnouncementChannel
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FScreenReaderAnnouncementChannel
(
const TSharedRef< FTextToSpeechBase >& InTextToSpeech |
Announcement/ScreenReaderAnnouncementChannel.h | ||
FScreenReaderAnnouncementChannel
(
const FScreenReaderAnnouncementChannel& OtherAnnouncementChannel |
Announcement/ScreenReaderAnnouncementChannel.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FScreenReaderAnnouncementChannel() |
Announcement/ScreenReaderAnnouncementChannel.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AnnouncementQueue | TArray< FScreenReaderAnnouncement > | TheA priority queue for all of the queued announcements. | Announcement/ScreenReaderAnnouncementChannel.h | |
| CurrentAnnouncement | FScreenReaderAnnouncement | The current announcement that is being spoken. | Announcement/ScreenReaderAnnouncementChannel.h | |
| TextToSpeech | TSharedRef< FTextToSpeechBase > | Announcement/ScreenReaderAnnouncementChannel.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Activate() |
Announcement/ScreenReaderAnnouncementChannel.h | ||
FScreenReaderReply ClearAllAnnouncements() |
Announcement/ScreenReaderAnnouncementChannel.h | ||
void Deactivate() |
Announcement/ScreenReaderAnnouncementChannel.h | ||
float GetSpeechRate() |
Announcement/ScreenReaderAnnouncementChannel.h | ||
float GetSpeechVolume() |
Announcement/ScreenReaderAnnouncementChannel.h | ||
bool IsSpeaking() |
Announcement/ScreenReaderAnnouncementChannel.h | ||
bool IsSpeechMuted() |
Announcement/ScreenReaderAnnouncementChannel.h | ||
FScreenReaderReply MuteSpeech() |
Announcement/ScreenReaderAnnouncementChannel.h | ||
FScreenReaderReply RequestSpeak
(
FScreenReaderAnnouncement InAnnouncement |
Announcement/ScreenReaderAnnouncementChannel.h | ||
FScreenReaderReply RequestSpeakWidget
(
const TSharedRef< IAccessibleWidget >& InWidget |
Announcement/ScreenReaderAnnouncementChannel.h | ||
FScreenReaderReply SetSpeechRate
(
float InRate |
Announcement/ScreenReaderAnnouncementChannel.h | ||
FScreenReaderReply SetSpeechVolume
(
float InVolume |
Announcement/ScreenReaderAnnouncementChannel.h | ||
FScreenReaderReply StopSpeaking() |
Announcement/ScreenReaderAnnouncementChannel.h | ||
FScreenReaderReply UnmuteSpeech() |
Announcement/ScreenReaderAnnouncementChannel.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FScreenReaderAnnouncementChannel & operator=
(
const FScreenReaderAnnouncementChannel& OtherAnnouncementChannel |
Announcement/ScreenReaderAnnouncementChannel.h |