unreal.SlateScreenReaderEngineSubsystem¶
- class unreal.SlateScreenReaderEngineSubsystem(outer=None, name='None')¶
Bases:
unreal.EngineSubsystemThe 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: USlateScreenReaderEngineSubsystem ::Get().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 USlateScreenReaderEngineSubsystem ::Get().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(HelloWorld.ToString(), FScreenReaderInfo::Important())); See: FScreenReaderBase, FScreenReaderUser, FScreenReaderAnnouncement
C++ Source:
Plugin: SlateScreenReader
Module: SlateScreenReader
File: SlateScreenReaderEngineSubsystem.h
- activate_screen_reader() None¶
Activates the underlying screen reader. Use this to allow screen reader users to register with the screen reader and receive accessible feedback via text to speech and get access to other screen reader services. A basic workflow with activation would be: ActivateScreenReader() -> RegisterScreenReaderUser() -> ActivateScreenReaderUser() See: RegisterScreenReaderUser(), ActivateScreenReaderUser()
- activate_user(user_id) ScreenReaderReply¶
Activates a screen reader user and fulfill requests for accessibility services such as text to speech that clients can make. When screen reader users are first registered with a screen reader, they are deactivated by default. Users must explicitly activate the screen reader user. If the passed in user Id does not correspond to a registered screen reader user, nothing will happen.
- Parameters
user_id (int32) – The user Id of the screen reader user to request activation
- Returns
FScreenReaderReply::Handled() if the screen reader user is successfully activated. Else FScreenReaderReply::Unhandled() is returned.
- Return type
- deactivate_screen_reader() None¶
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. Note: When the screen reader is deactivated, none of the registered screen reader users will be unregistered or cleared. This allows you to deactivate the screen reader to prevent accessible services such as text to speech from triggering and then activate the screen reader again to continue those services.
- deactivate_user(user_id) ScreenReaderReply¶
Deactivates the screen reader and disables all announcement and text to speech services making them do nothing. If the passed in user Id does not correspond to a registered screen reader user, nothing will happen.
- Parameters
user_id (int32) – The user Id of the screen reader user to request deactivation. The Id should correspond to the Slate user id of an input device. If unsure, use Id 0.
- Returns
FScreenReaderReply::Handled() if the screen reader user is successfully deactivated. Else FScreenReaderReply::Unhandled() is returned.
- Return type
- get_speech_rate(user_id) float¶
Returns the rate text to speech will be speaking at for a screen reader user. Value is between 0.0f and 1.0f. If the provided user Id doesn’t exist, 0.0f will be returned.
- Parameters
user_id (int32) – The user Id of the screen reader user to retrieve the text to speech rate for
- Return type
- get_speech_volume(user_id) float¶
Returns the volume text to speech will be speaking at for a screen reader user. Value is between 0.0f and 1.0f. If the provided user Id doesn’t exist, 0.0f will be returned.
- Parameters
user_id (int32) – The user Id of the screen reader user to retrieve the text to speech volume for
- Return type
- is_screen_reader_active() 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. Otherwise, it returns false.
- Return type
- is_speaking(user_id) bool¶
Returns true if the screen reader is speaking text to a particular user. Returns false if no no announcements are being spoken to the user or if the user Id is not registered.
- Parameters
user_id (int32) – The user Id of the screen reader user to check if any announcements are being spoken to.
- Return type
- is_speech_muted(user_id) bool¶
Returns true if text to speech for a screen reader user is muted. Otherwise false is returned. If the provided user Id doesn’t exist, false will be returned.
- Parameters
user_id (int32) – The screen reader user Id to check if text to speech is muted.
- Return type
- is_user_registered(user_id) bool¶
Returns true if the passed in screen reader user Id is already registered. Else false is returned.
- Parameters
user_id (int32) – The user Id to check for registration.
- Return type
- mute_speech(user_id) ScreenReaderReply¶
Mutes the text to speech for a screen reader user. If the provided user Id doesn’t exist, nothing will happen.
- Parameters
user_id (int32) – The user Id of the screen reader user to mute text to speech for.
- Returns
FScreenReaderReply::Handled() is returned if the screen reader user is successfully muted. Otherwise, FScreenReaderReply::Unhandled() is returned.
- Return type
- register_user(user_id) ScreenReaderReply¶
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.
- Parameters
user_id (int32) – 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.
- Returns
FScreenReaderReply::Handled() if the screen reader user is successfully registered. Else FScreenReaderReply::Unhandled() is returned. See: ActivateUser()
- Return type
- request_speak(user_id, announcement) ScreenReaderReply¶
Requests an announcement to be spoken to the screen reader user. This is the main mechanism to provide text to speech auditory feedback to end users. Calling this function does not guarantee that the announcement will be spoken via text to speech and be heard by a user. All announcements spoken via text to speech will be asynchronous and will not block the game thread. If the screen reader user is active and no announcements are currently spoken, the announcement will be spoken immediately. If another announcement is currently being spoken, the passed in announcement could be queued or interrupt the currently spoken announcement.
- Parameters
user_id (int32) – The user Id of the screen reader user the announcement is intended for
announcement (ScreenReaderAnnouncement) – The announcement requested to be spoken to the screen reader user
- Returns
FScreenReaderReply::Handled() if the request was successfully processed. Else return FScreenReader::Unhandled() See: FScreenReaderAnnouncement, FScreenReaderAnnouncementInfo
- Return type
- request_speak_focused_widget(user_id) ScreenReaderReply¶
Requests the information about the accessibility widget a user is focused on to be read out. If nothing is currently being focused on by the screen reader user, nothing will be read out. The same guarantees about the announcement being spoken in RequestSpeak() apply for this function. Nothing will happen if the passed in user Id is not already registered with the screen reader.
- Parameters
user_id (int32) – The user Id to request its accessible focus to be read out
- Returns
FScreenReaderReply::Handled() if the user’s focused widget’s information is successfully spoken. Else FScreenReaderReply::Unhandled() is returned.
- Return type
- set_speech_rate(user_id, rate) ScreenReaderReply¶
Sets the rate text to speech will be speaking at for a screen reader user. If the provided user Id doesn’t exist, nothing will happen.
- Parameters
user_id (int32) – The user Id of the screen reader user to set the text to speech rate for
rate (float) – The rate text to speech will be set at for the provided screen reader user. Value will be clamped between 0.0f and 1.0f.
- Returns
FScreenReaderReply::Handled() is returned if the speech rate is successfully set for the screen reader user. Otherwise, FScreenReaderReply::Unhandled() is returned.
- Return type
- set_speech_volume(user_id, volume) ScreenReaderReply¶
Sets the volume text to speech will be speaking at for a screen reader user. If the provided user Id doesn’t exist, nothing will happen.
- Parameters
user_id (int32) – The user Id of the screen reader user to set the text to speech volume for
volume (float) – The volume text to speech will be set at for the provided screen reader user. Value will be clamped between 0.0f and 1.0f.
- Returns
FScreenReaderReply::Handled() is returned if the speech volume is successfully set for the screen reader user. Otherwise, FScreenReaderReply::Unhandled() is returned.
- Return type
- stop_speaking(user_id) ScreenReaderReply¶
Immediately stops speaking any currently spoken announcement for a particular screen reader user. Does nothing if there is no announcement currently being spoken for the user or if the user Id is not registered with the screen reader.
- Parameters
user_id (int32) – The user Id of the screen reader user to request announcements to be stopped.
- Returns
FScreenReader::Handled() if the request to stop speaking is successfully processed. Else FScreenReaderReply::Unhandled() is returned.
- Return type
- unmute_speech(user_id) ScreenReaderReply¶
Unmutes the text to speech for a screen reader user. If the provided user Id doesn’t exist, nothing will happen.
- Parameters
user_id (int32) – The user Id of the screen reader user to unmute text to speech for.
- Returns
FScreenReaderReply::Handled() is returned if the screen reader user is successfully unmuted. Otherwise, FScreenReaderReply::Unhandled() is returned.
- Return type
- unregister_user(user_id) ScreenReaderReply¶
Unregisters a provided user Id from the screen reader framework and deactivates the user. The unregistered user will no longer receive or respond to accessible events and input. Nothing will happen if the provided user Id has not been registered with the screen reader.
- Parameters
user_id (int32) – The user Id to unregister from the screen reader framework.
- Returns
FScreenReaderReply::Handled() if the screen reader user is successfully unregistered. Else FScreenReaderReply::Unhandled() is returned.
- Return type