FScreenReaderAnnouncement

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 FScreenReaderAnnouncement

Remarks

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.

Variables

	Type	Name	Description
	FScreenReaderAnnouncementInfo	AnnouncementInfo	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
	FString	AnnouncementString	A localized string that represents the message to be spoken to a end user

Constructors

	Type	Name	Description
		FScreenReaderAnnouncement ()	Only used to satisfy USTRUCT requirements Please use ctor that takes arguments
		FScreenReaderAnnouncement ( FString InAnnouncementString, FScreenReaderAnnouncementInfo )	The constructor that should be used in most cases.

Functions

Type	Name	Description
bool	CanBeInterruptedBy ( const FScreenReaderAnnouncement& Interruptee, const FScreenReaderAnnouncement& Interrupter, const InterruptionPolicy& InInterruptionPolicy )	A static function that determines if one announcement can be interrupted by another based on a provided interruption policy.true
const FScreenReaderAnnouncementInfo &	GetAnnouncementInfo ()
const FString &	GetAnnouncementString ()
FString	ToString ()	Converts the contents of the announcement to a string for easy printing. Useful for debugging.

Classes

	Type	Name	Description
	FDefaultComparator	The default comparator for screen reader announcements.
	FDefaultInterruptionPolicy	The default interruption policy to determine if announcement A can be interrupted by announcement B.

Navigation