UTextToSpeechEngineSubsystem | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/TextToSpeech

Subsystem for interacting with the text to speech system via blueprints. The subsystem consists of a number of text to speech channels associated with a text to speech channel Id. Each text to speech channel provides text to speech functionality such as vocalizing a string, stopping a vocalized string, controlling the audio settings of the channel and muting/unmuting a channel. Most of the functions take a text to speech channel Id which allows you to request text to speech functionality on the requested channel. All newly added text to speech channels start off deactivated and must be activated before any text to speech functionality can be used.


Name	UTextToSpeechEngineSubsystem
Type	class
Header File	/Engine/Plugins/Experimental/TextToSpeech/Source/TextToSpeech/Public/TextToSpeechEngineSubsystem.h
Include Path	#include "TextToSpeechEngineSubsystem.h"

Syntax

UCLASS ()  
class UTextToSpeechEngineSubsystem : public UEngineSubsystem

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → USubsystem → UDynamicSubsystem → UEngineSubsystem → UTextToSpeechEngineSubsystem

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UTextToSpeechEngineSubsystem()		TextToSpeechEngineSubsystem.h

Destructors

Name	Remarks	Include Path	Unreal Specifiers
virtual ~UTextToSpeechEngineSubsystem()		TextToSpeechEngineSubsystem.h

Variables

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
ChannelIdToTextToSpeechMap	TMap< FName, TSharedRef< FTextToSpeechBase > >	~	TextToSpeechEngineSubsystem.h

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
void ActivateAllChannels()	Activates all text to speech channels to accept requests for text to speech functionality.	TextToSpeechEngineSubsystem.h	BlueprintCallable Category=TextToSpeech
void ActivateChannel ( UPARAM(DisplayName="Channel Id") FName InChannelId )	Activates a text to speech channel to accept requests to perform text to speech functionality.	TextToSpeechEngineSubsystem.h	BlueprintCallable Category=TextToSpeech
void AddCustomChannel ( UPARAM(DisplayName="New Channel Id") FName InNewChannelId )	Creates a new text to speech channel where text to speech requests are fulfilled by a user implemented C++ text to speech class.	TextToSpeechEngineSubsystem.h	BlueprintCallable Category=TextToSpeech
void AddDefaultChannel ( UPARAM(DisplayName="New Channel Id") FName InNewChannelId )	Creates a new channel for text to speech requests to be made to a platform C++ text to speech class.	TextToSpeechEngineSubsystem.h	BlueprintCallable Category=TextToSpeech
void DeactivateAllChannels()	Deactivates all text to speech channels making all requests for text to speech functionality do nothing.	TextToSpeechEngineSubsystem.h	BlueprintCallable Category=TextToSpeech
void DeactivateChannel ( UPARAM(DisplayName="Channel Id") FName InChannelId )	Deactivates a text to speech channel and stops any vocalized strings on that channel.	TextToSpeechEngineSubsystem.h	BlueprintCallable Category=TextToSpeech
virtual void Deinitialize()		TextToSpeechEngineSubsystem.h
bool DoesChannelExist ( UPARAM(DisplayName="Channel Id") FName InChannelId ) const	Returns true if a text to speech channel associated with a channel Id exists.	TextToSpeechEngineSubsystem.h	BlueprintCallable Category=TextToSpeech
int32 GetNumChannels()	Returns the number of text to speech channels that have been added.	TextToSpeechEngineSubsystem.h	BlueprintCallable Category=TextToSpeech Meta=(DisplayName="Get Number Of Channels")
float GetRateOnChannel ( UPARAM(DisplayName="Channel Id") FName InChannelId ) const	Returns the current speech rate strings are vocalized on a text to speech channel.	TextToSpeechEngineSubsystem.h	BlueprintCallable Category=TextToSpeech
float GetVolumeOnChannel ( UPARAM(DisplayName="Channel Id") FName InChannelId )	Returns the current volume strings are vocalized on a text to speech channel.	TextToSpeechEngineSubsystem.h	BlueprintCallable Category=TextToSpeech
virtual void Initialize ( FSubsystemCollectionBase& Collection )	UEngineSubsystem.	TextToSpeechEngineSubsystem.h
bool IsChannelActive ( UPARAM(DisplayName="Channel Id") FName InChannelId ) const	Returns true if the text to speech channel is active, otherwise false.	TextToSpeechEngineSubsystem.h	BlueprintCallable Category=TextToSpeech
bool IsChannelMuted ( UPARAM(DisplayName="Channel Id") FName InChannelId ) const	Returns true if the text to speech channel is muted, otherwise false.	TextToSpeechEngineSubsystem.h	BlueprintCallable Category=TextToSpeech
bool IsSpeakingOnChannel ( UPARAM(DisplayName="Channel Id") FName InChannelId ) const	Return true when the targeted text to speech channel is vocalising, otherwise false.	TextToSpeechEngineSubsystem.h	BlueprintCallable Category=TextToSpeech
void MuteChannel ( UPARAM(DisplayName="Channel Id") FName InChannelId )	Mutes a text to speech channel so no vocalized strings are audible on that channel.	TextToSpeechEngineSubsystem.h	BlueprintCallable Category=TextToSpeech
void RemoveAllChannels()	Removes all text to speech channels, preventin future requests for text to speech functionality on all channels.	TextToSpeechEngineSubsystem.h	BlueprintCallable Category=TextToSpeech
void RemoveChannel ( UPARAM(DisplayName="Channel Id") FName InChannelId )	Removes a text to speech channel, preventing all further requests for text to speech functionality from the channel.	TextToSpeechEngineSubsystem.h	BlueprintCallable Category=TextToSpeech
void SetRateOnChannel ( UPARAM(DisplayName="Channel Id") FName InChannelId, UPARAM(DisplayName="Rate") float InRate )	Sets the current speech rate strings should be vocalized on a text to speech channel.	TextToSpeechEngineSubsystem.h	BlueprintCallable Category=TextToSpeech
void SetVolumeOnChannel ( UPARAM(DisplayName="Channel Id") FName InChannelId, UPARAM(DisplayName="Volume") float InVolume )	Sets the volume for strings vocalized on a text to speech channel.	TextToSpeechEngineSubsystem.h	BlueprintCallable Category=TextToSpeech
void SpeakOnChannel ( UPARAM(DisplayName="Channel Id") FName InChannelId, UPARAM(ref, DisplayName="String To Speak") const FString& InStringToSpeak )	Immediately vocalizes the requested string asynchronously on the requested text to speech channel, interrupting any string that is already being vocalized on the channel.	TextToSpeechEngineSubsystem.h	BlueprintCallable Category=TextToSpeech
void StopSpeakingOnAllChannels()	Immediately stops strings from being vocalized on all text to speech channels.	TextToSpeechEngineSubsystem.h	BlueprintCallable Category=TextToSpeech
void StopSpeakingOnChannel ( UPARAM(DisplayName="Channel Id") FName InChannelId )	Immediately stops any currently vocalized string on the channel.	TextToSpeechEngineSubsystem.h	BlueprintCallable Category=TextToSpeech
void UnmuteChannel ( UPARAM(DisplayName="Channel Id") FName InChannelId )	Unmutes a text to speech channel so vocalized strings are audible on the channel.	TextToSpeechEngineSubsystem.h	BlueprintCallable Category=TextToSpeech

Navigation