Navigation
API > API/Plugins > API/Plugins/SlateScreenReader > API/Plugins/SlateScreenReader/USlateScreenReaderEngineSubsyste-
Description
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.
| Name | SetSpeechVolume |
| 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 SetSpeechVolume
(
int32 InUserId,
float InVolume
)
FScreenReaderReply::Handled() is returned if the speech volume is successfully set for the screen reader user. Otherwise, FScreenReaderReply::Unhandled() is returned.
Parameters
| Name | Remarks |
|---|---|
| InUserId | The user Id of the screen reader user to set the text to speech volume for |
| InVolume | 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. |