Slate Screen Reader

Slate Screen Reader

Choose your operating system:

Windows

macOS

Linux

On this page

Actions

Activate Screen Reader

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()

Target is Slate Screen Reader Engine Subsystem

Activate User

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.

Target is Slate Screen Reader Engine Subsystem

Deactivate Screen Reader

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.

Target is Slate Screen Reader Engine Subsystem

Deactivate User

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.

Target is Slate Screen Reader Engine Subsystem

Get Speech Rate

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.

Target is Slate Screen Reader Engine Subsystem

Get Speech Volume

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.

Target is Slate Screen Reader Engine Subsystem

Is Screen Reader Active

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.

Target is Slate Screen Reader Engine Subsystem

Is Speaking

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.

Target is Slate Screen Reader Engine Subsystem

Is Speech Muted

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.

Target is Slate Screen Reader Engine Subsystem

Is User Registered

Returns true if the passed in screen reader user Id is already registered. Else false is returned.

Target is Slate Screen Reader Engine Subsystem

Mute Speech

Mutes the text to speech for a screen reader user. If the provided user Id doesn't exist, nothing will happen.

Target is Slate Screen Reader Engine Subsystem

Register User

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.

Target is Slate Screen Reader Engine Subsystem

Request Speak

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.

Target is Slate Screen Reader Engine Subsystem

Request Speak Focused Widget

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.

Target is Slate Screen Reader Engine Subsystem

Set Speech Rate

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.

Target is Slate Screen Reader Engine Subsystem

Set Speech Volume

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.

Target is Slate Screen Reader Engine Subsystem

Stop Speaking

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.

Target is Slate Screen Reader Engine Subsystem

Unmute Speech

Unmutes the text to speech for a screen reader user. If the provided user Id doesn't exist, nothing will happen.

Target is Slate Screen Reader Engine Subsystem

Unregister User

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.

Target is Slate Screen Reader Engine Subsystem