1. Epic GamesDeveloper
  3. USlateScreenReaderEngineSubsystem

USlateScreenReaderEngineSubsystem

The engine subsystem for the Slate screen reader.

API > API/Plugins > API/Plugins/SlateScreenReader

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;&41;  
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 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()));

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category *see  
Public function UFunction BlueprintCallable, Category FScreenReaderReply

ActivateUser ( UPARAM(DisplayName="Screen Reader User Id") int32 InUserId
)

 Activates a screen reader user and fulfill requests for accessibility services such as text to speech that clients can make.
Public function UFunction BlueprintCallable, Category void 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.
Public function UFunction BlueprintCallable, Category FScreenReaderReply

DeactivateUser ( UPARAM(DisplayName="Screen Reader User Id") int32 InUserId
)

 Deactivates the screen reader and disables all announcement and text to speech services making them do nothing.
Public function Static USlateScreenReaderEngineSubsystem &

Get ()

 Convenience method to retrieve the screen reader engine subsystem.
Public function Const TSharedRef< FScreenReaderBase > Returns the underlying screen reader
Public function Const UFunction BlueprintCallable, Category float

GetSpeechRate ( UPARAM(DisplayName="Screen Reader User Id") int32 InUserId
)

 Returns the rate text to speech will be speaking at for a screen reader user.
Public function Const UFunction BlueprintCallable, Category float

GetSpeechVolume ( UPARAM(DisplayName="Screen Reader User Id") int32 InUserId
)

 Returns the volume text to speech will be speaking at for a screen reader user.
Public function Const UFunction BlueprintCallable, Category bool 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.
Public function Const UFunction BlueprintCallable, Category bool

IsSpeaking ( UPARAM(DisplayName="Screen Reader User Id") int32 InUserId
)

 Returns true if the screen reader is speaking text to a particular user.
Public function Const UFunction BlueprintCallable, Category bool

IsSpeechMuted ( UPARAM(DisplayName="Screen Reader User Id") int32 InUserId
)

 Returns true if text to speech for a screen reader user is muted.
Public function Const UFunction BlueprintCallable, Category bool

IsUserRegistered ( UPARAM(DisplayName="Screen Reader User Id") int32 InUserId
)

 Returns true if the passed in screen reader user Id is already registered. Else false is returned.
Public function UFunction BlueprintCallable, Category FScreenReaderReply

MuteSpeech ( UPARAM(DisplayName="Screen Reader User Id") int32 InUserId
)

 Mutes the text to speech for a screen reader user.
Public function UFunction BlueprintCallable, Category *see Activates the underlying screen reader.
Public function UFunction BlueprintCallable, Category FScreenReaderReply

RegisterUser ( UPARAM(DisplayName="Screen Reader User Id") 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.
Public function UFunction BlueprintCallable, Category FScreenReaderReply

RequestSpeak ( UPARAM(DisplayName="Screen Reader User Id") int32 InUserId,
UPARAM(DisplayName="Announcement") FScreenReaderAnnouncement InAnnouncement
)

 Requests an announcement to be spoken to the screen reader user.
Public function UFunction BlueprintCallable, Category FScreenReaderReply

RequestSpeakFocusedWidget ( UPARAM(DisplayName="Screen Reader User Id") int32 InUserId
)

 Requests the information about the accessibility widget a user is focused on to be read out.
Public function UFunction BlueprintCallable, Category FScreenReaderReply

SetSpeechRate ( UPARAM(DisplayName="Screen Reader User Id") int32 InUserId,
UPARAM(DisplayName="Rate") float InRate
)

 Sets the rate text to speech will be speaking at for a screen reader user.
Public function UFunction BlueprintCallable, Category FScreenReaderReply

SetSpeechVolume ( UPARAM(DisplayName="Screen Reader User Id") int32 InUserId,
UPARAM(DisplayName="Volume") float InVolume
)

 Sets the volume text to speech will be speaking at for a screen reader user.
Public function UFunction BlueprintCallable, Category FScreenReaderReply

StopSpeaking ( UPARAM(DisplayName="Screen Reader User Id") int32 InUserId
)

 Immediately stops speaking any currently spoken announcement for a particular screen reader user.
Public function UFunction BlueprintCallable, Category FScreenReaderReply

UnmuteSpeech ( UPARAM(DisplayName="Screen Reader User Id") int32 InUserId
)

 Unmutes the text to speech for a screen reader user.
Public function UFunction BlueprintCallable, Category FScreenReaderReply

UnregisterUser ( UPARAM(DisplayName="Screen Reader User Id") int32 InUserId
)

 Unregisters a provided user Id from the screen reader framework and deactivates the user.

Overridden from USubsystem

  Type Name Description
Public function Virtual void Implement this for deinitialization of instances of the system
Public function Virtual void UEngineSubsystem.
Public function Virtual Const bool Override to control if the Subsystem should be created at all.

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