Navigation
API > API/Plugins > API/Plugins/SlateScreenReader > API/Plugins/SlateScreenReader/USlateScreenReaderEngineSubsyste-
Description
Requests an announcement to be spoken to the screen reader user. This is the main mechanism to provide text to speech auditory feedback to end users. Calling this function does not guarantee that the announcement will be spoken via text to speech and be heard by a user. All announcements spoken via text to speech will be asynchronous and will not block the game thread. If the screen reader user is active and no announcements are currently spoken, the announcement will be spoken immediately. If another announcement is currently being spoken, the passed in announcement could be queued or interrupt the currently spoken announcement.
| Name | RequestSpeak |
| Type | function |
| Header File | /Engine/Plugins/Experimental/SlateScreenReader/Source/SlateScreenReader/Public/SlateScreenReaderEngineSubsystem.h |
| Include Path | #include "SlateScreenReaderEngineSubsystem.h" |
| Source | /Engine/Plugins/Experimental/SlateScreenReader/Source/SlateScreenReader/Private/SlateScreenReaderEngineSubsystem.cpp |
UFUNCTION (BlueprintCallable, Category="SlateScreenReader")
FScreenReaderReply RequestSpeak
(
int32 InUserId,
FScreenReaderAnnouncement InAnnouncement
)
FScreenReaderReply::Handled() if the request was successfully processed. Else return FScreenReader::Unhandled()
Parameters
| Name | Remarks |
|---|---|
| InUserId | The user Id of the screen reader user the announcement is intended for |
| InAnnouncement | The announcement requested to be spoken to the screen reader user |
See Also
-
FScreenReaderAnnouncement
-
FScreenReaderAnnouncementInfo