Navigation
API > API/Plugins > API/Plugins/ScreenReader > API/Plugins/ScreenReader/Announcement
References
| Module | ScreenReader |
| Header | /Engine/Plugins/Experimental/ScreenReader/Source/ScreenReader/Public/Announcement/ScreenReaderAnnouncement.h |
| Include | #include "Announcement/ScreenReaderAnnouncement.h" |
Syntax
USTRUCT&40;BlueprintType&41;
struct FScreenReaderAnnouncementInfo
Remarks
A struct that contains information about how a screen reader announcement should behave when the announcement is requested to be spoken. This struct holds information to determine an announcement's priority in relation to other announcements and determines if an announcement can be interrupted by other announcements and if an announcement should be queued if it cannot be made immendiately. For C++ users, please use the static methods provided to create instances of FScreenReaderInfo with pre-defined defaults that will satisfy 80% of your use cases. Please see FScreenReaderUser::RequestSpeak() for examples of how to use this struct.
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Only used to satisfy USTRUCT constraints Please use ctor that takes parameters | ||
 |
FScreenReaderAnnouncementInfo
(
bool bInShouldQueue, |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
FScreenReaderAnnouncementInfo | The announcement info used for announcements concerning widgets and their content. | |
  |
EScreenReaderAnnouncementPriority | GetPriority () |
|
  |
double | GetTimestamp () |
|
  |
FScreenReaderAnnouncementInfo | Important () |
An announcement info used for announcements that are of critical importance to the end user. |
  |
bool | ||
  |
bool | ShouldQueue () |
|
  |
FString | ToString () |
Returns a string that represents all of the data reflected in this struct. |
 |
FScreenReaderAnnouncementInfo | UserFeedback () |
This announcement info is used for announcements to provide feedback for end user actions or inform them of changes. |