FScreenReaderUser | Unreal Engine 5.5 Documentation

Unreal Engine C++ API Reference > Plugins > ScreenReader > GenericPlatform

Inheritance Hierarchy

FGenericAccessibleUser
FScreenReaderUser

References


Module	ScreenReader
Header	/Engine/Plugins/Experimental/ScreenReader/Source/ScreenReader/Public/GenericPlatform/ScreenReaderUser.h
Include	#include "GenericPlatform/ScreenReaderUser.h"

Syntax

class FScreenReaderUser : public FGenericAccessibleUser

Remarks

A user of the screen reader. Corresponds to a hardware device that users use. This class is a facade that acts as a one stop shop for all screen reading services on a per user basis. Multiple screen reader users can exist simultaneoulsy to facilitate local multiplayer and users can opt in or out of receiving screen reader feedback by registering and unregistering with the screen reader respectively. A screen user is inactive by default when it is first registered through the screen reader. Users must explicitly activate the screen reader user after successful registration with the screen reader to use its services. Responsibilities of the class are:

Text to speech (TTS) requests - Users can request an announcement to be spoken via text to speech to screen reader user

Accessible focus handling - A screen reader user holds information about the accessible widget it is currently focused on

Accessible Navigation - Screen reader users have finer navigation controls around the accessible widget hierarchy as compared to regular tab navigation with keyboard or D-pad controls with a gamepad.

Constructors

	Type	Name	Description
		FScreenReaderUser ( FAccessibleUserIndex InUserIndex )

Destructors

	Type	Name	Description
		~FScreenReaderUser ()

Functions

Type	Name	Description
void	Activate ()	Activates the screen reader user and fulfill requests for accessibility services such as text to speech that clients can make.
void	Deactivate ()	Deactivates the screen reader and disables all announcement and text to speech services making them do nothing.
float	GetSpeechRate ()	Returns the speech rate text to speech is speaking at for this user.
float	GetSpeechVolume ()	Returns the speech volume for text to speech. Value will be between 0.0f and 1.0f.
bool	IsActive ()	Returns true if the screen reader user is active. Else returns false.
bool	IsSpeaking ()	Returns true if an announcement is currently being spoken. Else returns false.
bool	IsSpeechMuted ()	Returns true if the text to speech for this user is muted. Else returns false.
FScreenReaderReply	MuteSpeech ()	Mutes the text to speech for this user so requests to speak strings will be inaudible.
FScreenReaderReply	NavigateToFirstAncestor ()	Shifts focus to the first ancestor of the user's currently focused accessible widget based on the current navigation policy.
FScreenReaderReply	NavigateToFirstChild ()	Shifts focus to the first child from the user's currently focused accessible widget based on the current navigation policy.
FScreenReaderReply	NavigateToNextSibling ()	Shifts focus to the next sibling from the user's currently focused accessible widget based on the current navigation policy.
FScreenReaderReply	NavigateToNextWidgetInHierarchy ()	Shifts focus to the logical next widget in the accessible widget hierarchy from the user's currently focused accessible widget based on the current navigation policy.
FScreenReaderReply	NavigateToPreviousSibling ()	Shifts focus to the previous sibling from the user's currently focused accessible widget based on the current navigation policy.
FScreenReaderReply	NavigateToPreviousWidgetInHierarchy ()	Shifts focus to the logical previous widget in the accessible widget hierarchy from the user's currently focused accessible widget based on the current navigation policy.
void	OnUnregistered ()
FScreenReaderReply	RequestSpeak ( FScreenReaderAnnouncement InAnnouncement )	Requests an announcement to be spoken to the screen reader user.
FScreenReaderReply	RequestSpeakWidget ( const TSharedRef< IAccessibleWidget >& InWidget )	Requests the information about an accessibility widget to be read out to a user.
void	SetNavigationPolicy ( const TSharedRef< IScreenReaderNavigationPolicy >& InNavigationPolicy )	Navigation.
FScreenReaderReply	SetSpeechRate ( float InRate )	Sets the speech rate text to speech will speak at for this user.
FScreenReaderReply	SetSpeechVolume ( float InVolume )	Sets the speech volume for text to speech to speak at.
FScreenReaderReply	StopSpeaking ()	Immediately stops speaking any currently spoken announcement.
FScreenReaderReply	UnmuteSpeech ()	Unmutes the text to speech for this user so that requests to speak strings will be audible again.