Navigation
API > API/Plugins > API/Plugins/ScreenReader
A screen reader announcement represents a localized message that a user wants to speak to an end user. This class is used to request announcements to be spoken to an end user via the FScreenReaderUser class. FScreenReaderUser::RequestSpeak() for instructions on how to use the class.
| Name | FScreenReaderAnnouncement |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/ScreenReader/Source/ScreenReader/Public/Announcement/ScreenReaderAnnouncement.h |
| Include Path | #include "Announcement/ScreenReaderAnnouncement.h" |
Syntax
USTRUCT (BlueprintType )
struct FScreenReaderAnnouncement
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Only used to satisfy USTRUCT requirements Please use ctor that takes arguments | Announcement/ScreenReaderAnnouncement.h | ||
FScreenReaderAnnouncement
(
FString InAnnouncementString, |
The constructor that should be used in most cases. | Announcement/ScreenReaderAnnouncement.h |
Structs
| Name | Remarks |
|---|---|
| FDefaultComparator | The default comparator for screen reader announcements. |
| FDefaultInterruptionPolicy | The default interruption policy to determine if announcement A can be interrupted by announcement B. |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AnnouncementInfo | FScreenReaderAnnouncementInfo | The announcement info associated with the announcement which controls how the announcement behaves when a user requests this announcement to be spoken to an end user | Announcement/ScreenReaderAnnouncement.h |
|
| AnnouncementString | FString | A localized string that represents the message to be spoken to a end user | Announcement/ScreenReaderAnnouncement.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FScreenReaderAnnouncementInfo & GetAnnouncementInfo() |
Announcement/ScreenReaderAnnouncement.h | ||
const FString & GetAnnouncementString() |
Announcement/ScreenReaderAnnouncement.h | ||
FString ToString() |
Converts the contents of the announcement to a string for easy printing. Useful for debugging. | Announcement/ScreenReaderAnnouncement.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool CanBeInterruptedBy
(
const FScreenReaderAnnouncement& Interruptee, |
A static function that determines if one announcement can be interrupted by another based on a provided interruption policy.true | Announcement/ScreenReaderAnnouncement.h |