FScreenReaderAnnouncementInfo

API > API/Plugins > API/Plugins/ScreenReader

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.


Name	FScreenReaderAnnouncementInfo
Type	struct
Header File	/Engine/Plugins/Experimental/ScreenReader/Source/ScreenReader/Public/Announcement/ScreenReaderAnnouncement.h
Include Path	#include "Announcement/ScreenReaderAnnouncement.h"

Syntax

USTRUCT (BlueprintType )  
struct FScreenReaderAnnouncementInfo

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FScreenReaderAnnouncementInfo ()	Only used to satisfy USTRUCT constraints Please use ctor that takes parameters	Announcement/ScreenReaderAnnouncement.h
FScreenReaderAnnouncementInfo ( bool bInShouldQueue, bool bInInterruptable, EScreenReaderAnnouncementPriority InPriority )		Announcement/ScreenReaderAnnouncement.h

Variables

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
bInterruptable	bool	True if the associazted announcement can be intrrupted by another announcement. Else false.	Announcement/ScreenReaderAnnouncement.h	BlueprintReadWrite Category="ScreenReaderAnnouncementInfo" Meta=(AllowPrivateAccess="true")
bShouldQueue	bool	True if the associated announcement should be queued if it cannot be spoken immediately or is interrupted.	Announcement/ScreenReaderAnnouncement.h	BlueprintReadWrite Category="ScreenReaderAnnouncementInfo" Meta=(AllowPrivateAccess="true")
Priority	EScreenReaderAnnouncementPriority	The priority level of the associated announcement.	Announcement/ScreenReaderAnnouncement.h	BlueprintReadWrite Category="ScreenReaderAnnouncementInfo" Meta=(AllowPrivateAccess="true")
Timestamp	double	@TODOAccessibility: Update timestamp to be recorded when announcements are requested, not when they are constructed.	Announcement/ScreenReaderAnnouncement.h

Functions

Public

Name	Remarks	Include Path
EScreenReaderAnnouncementPriority GetPriority()		Announcement/ScreenReaderAnnouncement.h
double GetTimestamp()		Announcement/ScreenReaderAnnouncement.h
bool IsInterruptable()		Announcement/ScreenReaderAnnouncement.h
bool ShouldQueue()		Announcement/ScreenReaderAnnouncement.h
FString ToString()	Returns a string that represents all of the data reflected in this struct.	Announcement/ScreenReaderAnnouncement.h
FScreenReaderAnnouncementInfo UserFeedback ()	This announcement info is used for announcements to provide feedback for end user actions or inform them of changes.	Announcement/ScreenReaderAnnouncement.h

Static

Name	Remarks	Include Path	Unreal Specifiers
static FScreenReaderAnnouncementInfo DefaultWidgetAnnouncement ()	The announcement info used for announcements concerning widgets and their content.	Announcement/ScreenReaderAnnouncement.h
static FScreenReaderAnnouncementInfo Important ()	An announcement info used for announcements that are of critical importance to the end user.	Announcement/ScreenReaderAnnouncement.h

Navigation