Navigation
API > API/Plugins > API/Plugins/SlateScreenReader > API/Plugins/SlateScreenReader/USlateScreenReaderEngineSubsyste-
Description
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. Does nothing if the passed in Id is already registered. Note: A successfully registered screen reader user is deactivated by default and will not respond to accessible events or accessible input. You need to call ActivateUser() to allow the newly registered screen reader user to respond to the accessible events and accessible input.
| Name | RegisterUser |
| Type | function |
| Header File | /Engine/Plugins/Experimental/SlateScreenReader/Source/SlateScreenReader/Public/SlateScreenReaderEngineSubsystem.h |
| Include Path | #include "SlateScreenReaderEngineSubsystem.h" |
| Source | /Engine/Plugins/Experimental/SlateScreenReader/Source/SlateScreenReader/Private/SlateScreenReaderEngineSubsystem.cpp |
UFUNCTION (BlueprintCallable, Category="SlateScreenReader")
FScreenReaderReply RegisterUser
(
int32 InUserId
)
FScreenReaderReply::Handled() if the screen reader user is successfully registered. Else FScreenReaderReply::Unhandled() is returned.
Parameters
| Name | Remarks |
|---|---|
| InUserId | The user Id of the screen reader user to register. The Id should correspond to a valid Slate user Id for an active hardware input device. If unsure, use Id 0. |