1. Epic GamesDeveloper
  3. USlateScreenReaderEngineSubsystem

USlateScreenReaderEngineSubsystem

The engine subsystem for the Slate screen reader.

API > API/Plugins > API/Plugins/SlateScreenReader

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 FSlateUserUSlateScreenReaderEngineSubsystemGet().GetScreenReader()->RegisterUser(0); TSharedRef 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(HelloWorld.ToString(), FScreenReaderInfo::Important()));

   
Name USlateScreenReaderEngineSubsystem
Type class
Header File /Engine/Plugins/Experimental/SlateScreenReader/Source/SlateScreenReader/Public/SlateScreenReaderEngineSubsystem.h
Include Path #include "SlateScreenReaderEngineSubsystem.h"

Syntax

UCLASS ()  
class USlateScreenReaderEngineSubsystem : public UEngineSubsystem

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

USlateScreenReaderEngineSubsystem()

   SlateScreenReaderEngineSubsystem.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~USlateScreenReaderEngineSubsystem()

   SlateScreenReaderEngineSubsystem.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ScreenReader TSharedPtr< FScreenReaderBase > ~ SlateScreenReaderEngineSubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
Activates the underlying screen reader. SlateScreenReaderEngineSubsystem.h
  • BlueprintCallable
  • Category="SlateScreenReader"

FScreenReaderReply ActivateUser ( int32 InUserId
)

 Activates a screen reader user and fulfill requests for accessibility services such as text to speech that clients can make. SlateScreenReaderEngineSubsystem.h
  • BlueprintCallable
  • Category="SlateScreenReader"
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. SlateScreenReaderEngineSubsystem.h
  • BlueprintCallable
  • Category="SlateScreenReader"

FScreenReaderReply DeactivateUser ( int32 InUserId
)

 Deactivates the screen reader and disables all announcement and text to speech services making them do nothing. SlateScreenReaderEngineSubsystem.h
  • BlueprintCallable
  • Category="SlateScreenReader"

TSharedRef< FScreenReaderBase > GetScreenReader()

 Returns the underlying screen reader SlateScreenReaderEngineSubsystem.h  

float GetSpeechRate ( int32 InUserId
) const

 Returns the rate text to speech will be speaking at for a screen reader user. SlateScreenReaderEngineSubsystem.h
  • BlueprintCallable
  • Category="SlateScreenReader"

float GetSpeechVolume ( int32 InUserId
) const

 Returns the volume text to speech will be speaking at for a screen reader user. SlateScreenReaderEngineSubsystem.h
  • BlueprintCallable
  • Category="SlateScreenReader"
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. SlateScreenReaderEngineSubsystem.h
  • BlueprintCallable
  • Category="SlateScreenReader"

bool IsSpeaking ( int32 InUserId
) const

 Returns true if the screen reader is speaking text to a particular user. SlateScreenReaderEngineSubsystem.h
  • BlueprintCallable
  • Category="SlateScreenReader"

bool IsSpeechMuted ( int32 InUserId
) const

 Returns true if text to speech for a screen reader user is muted. SlateScreenReaderEngineSubsystem.h
  • BlueprintCallable
  • Category="SlateScreenReader"

bool IsUserRegistered ( int32 InUserId
) const

 Returns true if the passed in screen reader user Id is already registered. Else false is returned. SlateScreenReaderEngineSubsystem.h
  • BlueprintCallable
  • Category="SlateScreenReader"

FScreenReaderReply MuteSpeech ( int32 InUserId
)

 Mutes the text to speech for a screen reader user. SlateScreenReaderEngineSubsystem.h
  • BlueprintCallable
  • Category="SlateScreenReader"

FScreenReaderReply RegisterUser ( int32 InUserId
)

 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. SlateScreenReaderEngineSubsystem.h
  • BlueprintCallable
  • Category="SlateScreenReader"

FScreenReaderReply RequestSpeak ( int32 InUserId,
FScreenReaderAnnouncement InAnnouncement
)

 Requests an announcement to be spoken to the screen reader user. SlateScreenReaderEngineSubsystem.h
  • BlueprintCallable
  • Category="SlateScreenReader"

FScreenReaderReply RequestSpeakFocusedWidget ( int32 InUserId
)

 Requests the information about the accessibility widget a user is focused on to be read out. SlateScreenReaderEngineSubsystem.h
  • BlueprintCallable
  • Category="SlateScreenReader"

FScreenReaderReply SetSpeechRate ( int32 InUserId,
float InRate
)

 Sets the rate text to speech will be speaking at for a screen reader user. SlateScreenReaderEngineSubsystem.h
  • BlueprintCallable
  • Category="SlateScreenReader"

FScreenReaderReply SetSpeechVolume ( int32 InUserId,
float InVolume
)

 Sets the volume text to speech will be speaking at for a screen reader user. SlateScreenReaderEngineSubsystem.h
  • BlueprintCallable
  • Category="SlateScreenReader"

FScreenReaderReply StopSpeaking ( int32 InUserId
)

 Immediately stops speaking any currently spoken announcement for a particular screen reader user. SlateScreenReaderEngineSubsystem.h
  • BlueprintCallable
  • Category="SlateScreenReader"

FScreenReaderReply UnmuteSpeech ( int32 InUserId
)

 Unmutes the text to speech for a screen reader user. SlateScreenReaderEngineSubsystem.h
  • BlueprintCallable
  • Category="SlateScreenReader"

FScreenReaderReply UnregisterUser ( int32 InUserId
)

 Unregisters a provided user Id from the screen reader framework and deactivates the user. SlateScreenReaderEngineSubsystem.h
  • BlueprintCallable
  • Category="SlateScreenReader"

Overridden from USubsystem

Name Remarks Include Path Unreal Specifiers

virtual void Deinitialize()

   SlateScreenReaderEngineSubsystem.h  

virtual void Initialize ( FSubsystemCollectionBase& Collection
)

 UEngineSubsystem. SlateScreenReaderEngineSubsystem.h  

virtual bool ShouldCreateSubsystem ( UObject* Outer
) const

   SlateScreenReaderEngineSubsystem.h  

Static

Name Remarks Include Path Unreal Specifiers
Convenience method to retrieve the screen reader engine subsystem. SlateScreenReaderEngineSubsystem.h  

See Also

  • FScreenReaderBase

  • FScreenReaderUser

  • FScreenReaderAnnouncement

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page