Navigation
API > API/Plugins > API/Plugins/TextToSpeech > API/Plugins/TextToSpeech/UTextToSpeechEngineSubsystem
Description
Immediately vocalizes the requested string asynchronously on the requested text to speech channel, interrupting any string that is already being vocalized on the channel. If the provided channel Id does not exist, nothing will be vocalized. Before executing this function, a text to speech channel must be added and activated. To create a platform default text to speech channel, use AddDefaultChannel. To create a custom text to speech channel with a user-implemented C++ text to speech class, use AddCustomChannel. This function is not intended for long strings that span multiple sentences or paragraphs.
| Name | SpeakOnChannel |
| Type | function |
| Header File | /Engine/Plugins/Experimental/TextToSpeech/Source/TextToSpeech/Public/TextToSpeechEngineSubsystem.h |
| Include Path | #include "TextToSpeechEngineSubsystem.h" |
| Source | /Engine/Plugins/Experimental/TextToSpeech/Source/TextToSpeech/Private/TextToSpeechEngineSubsystem.cpp |
UFUNCTION (BlueprintCallable, Category=TextToSpeech)
void SpeakOnChannel
(
UPARAM FName InChannelId,
UPARAM const FString & InStringToSpeak
)
Parameters
| Name | Remarks |
|---|---|
| InChannelId | The Id of the channel to speak on. |
| InStringToSpeak | The string to speak on the requested channel. |
See Also
-
ActivateAllChannels