USlateScreenReaderEngineSubsystem

The engine subsystem for the Slate screen reader.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USubsystem

UDynamicSubsystem

UEngineSubsystem

USlateScreenReaderEngineSubsystem

References

Module	SlateScreenReader
Header	/Engine/Plugins/Experimental/SlateScreenReader/Source/SlateScreenReader/Public/SlateScreenReaderEngineSubsystem.h
Include	#include "SlateScreenReaderEngineSubsystem.h"

Syntax

UCLASS()
class USlateScreenReaderEngineSubsystem : public UEngineSubsystem

Remarks

The engine subsystem for the Slate screen reader. A screen reader is a framework that provides vision accessibility services for screen reader useres. A screen reader user is a single user of the screen reader framework and can be thought of as a user of a hardware device such as keyboard/mouse or a controller. Screen reader users must be registered with the screen reader framework for them to receive feedback from the accessibility services provided by the screen reader framework. This class should be the entryway for C++ programmers and BP useres alike to interact with the screen reader system. The subsystem must be activated before the screen reader services can be used. For C++ users, please retrieve the screen reader and interact with the screen reader users from there. Example: USlateScreenReaderEngineSubsystemGet().ActivateScreenReader(); Registers a screen reader user with Id 0. A screen reader user should correspond to a hardware input device such as a keyboard or controller like FSlateUser USlateScreenReaderEngineSubsystemGet().GetScreenReader()->RegisterUser(0); TSharedRef<FScreenReaderUser> User = USlateScreenReaderEngineSubsystem::Get().GetScreenReader()->GetUserChecked(0); Screen reader users are inactive when they are first registered and need to be explicitly activated. User->Activate(); static const FText HelloWorld = LOCTEXT("HelloWorld", "Hello World"); Requests "Hello World" to be spoken to the screen reader user User->RequestSpeak(FScreenReaderAnnouncement, FScreenReaderInfo::Important()));

Constructors

	Name	Description
	USlateScreenReaderEngineSubsystem()

Destructors

	Name	Description
	~USlateScreenReaderEngineSubsystem()

Functions

	Name	Description
see	ActivateScreenReaderUser()
FScreenReade...	ActivateUser ( UPARAM(DisplayName="Screen Reader U... )	Activates a screen reader user and fulfill requests for accessibility services such as text to speech that clients can make.
void	DeactivateScreenReader()	Deactivates the underlying screen reader and prevents screen reader users from getting any accessible feedback via text to speech or using any other screen reader services.
FScreenReade...	DeactivateUser ( UPARAM(DisplayName="Screen Reader U... )	Deactivates the screen reader and disables all announcement and text to speech services making them do nothing.
USlateScreen...	Get()	Convenience method to retrieve the screen reader engine subsystem.
TSharedRef< ...	GetScreenReader()	Returns the underlying screen reader
float	GetSpeechRate ( UPARAM(DisplayName="Screen Reader U... )	Returns the rate text to speech will be speaking at for a screen reader user.
float	GetSpeechVolume ( UPARAM(DisplayName="Screen Reader U... )	Returns the volume text to speech will be speaking at for a screen reader user.
bool	IsScreenReaderActive()	Returns true if the screen reader is currently active and accessibility services such as text to speech can be used by the screen reader users.
bool	IsSpeaking ( UPARAM(DisplayName="Screen Reader U... )	Returns true if the screen reader is speaking text to a particular user.
bool	IsSpeechMuted ( UPARAM(DisplayName="Screen Reader U... )	Returns true if text to speech for a screen reader user is muted.
bool	IsUserRegistered ( UPARAM(DisplayName="Screen Reader U... )	Returns true if the passed in screen reader user Id is already registered. Else false is returned.
FScreenReade...	MuteSpeech ( UPARAM(DisplayName="Screen Reader U... )	Mutes the text to speech for a screen reader user.
see	RegisterScreenReaderUser()	Activates the underlying screen reader.
FScreenReade...	RegisterUser ( UPARAM(DisplayName="Screen Reader U... )	Registers a provided user Id to the screen reader framework and allows the screen reader user to receive and respond to accessible events and accessible input.
FScreenReade...	RequestSpeak ( UPARAM(DisplayName="Screen Reader U..., UPARAM(DisplayName="Announcement") ... )	Requests an announcement to be spoken to the screen reader user.
FScreenReade...	RequestSpeakFocusedWidget ( UPARAM(DisplayName="Screen Reader U... )	Requests the information about the accessibility widget a user is focused on to be read out.
FScreenReade...	SetSpeechRate ( UPARAM(DisplayName="Screen Reader U..., UPARAM(DisplayName="Rate") float In... )	Sets the rate text to speech will be speaking at for a screen reader user.
FScreenReade...	SetSpeechVolume ( UPARAM(DisplayName="Screen Reader U..., UPARAM(DisplayName="Volume") float ... )	Sets the volume text to speech will be speaking at for a screen reader user.
FScreenReade...	StopSpeaking ( UPARAM(DisplayName="Screen Reader U... )	Immediately stops speaking any currently spoken announcement for a particular screen reader user.
FScreenReade...	UnmuteSpeech ( UPARAM(DisplayName="Screen Reader U... )	Unmutes the text to speech for a screen reader user.
FScreenReade...	UnregisterUser ( UPARAM(DisplayName="Screen Reader U... )	Unregisters a provided user Id from the screen reader framework and deactivates the user.

Overridden from USubsystem

	Name	Description
void	Deinitialize()	Implement this for deinitialization of instances of the system
void	Initialize ( FSubsystemCollectionBase& Collecti... )	UEngineSubsystem.
bool	ShouldCreateSubsystem ( UObject* Outer )	Override to control if the Subsystem should be created at all.