Choose your operating system:
Windows
macOS
Linux
Actions
|
Activate All Channels |
Activates all text to speech channels to accept requests for text to speech functionality. Target is Text to Speech Engine Subsystem |
|
Activate Channel |
Activates a text to speech channel to accept requests to perform text to speech functionality. If the provided channel Id does not exist, nothing will happen. Target is Text to Speech Engine Subsystem |
|
Add Custom Channel |
Creates a new text to speech channel where text to speech requests are fulfilled by a user implemented C++ text to speech class. If you have not specified a custom text to speech class to be used, use AddDefaultChannel instead. This will not add a channel if the channel Id is not unique or if the user has not specified a custom text to speech class to be used in ITextToSpeechModule. Newly added channels must be activated to use text to speech functionalities. See: ITextToSpeechModule, AddDefaultChannel, ActivateChannel, ActivateAllChannels Target is Text to Speech Engine Subsystem |
|
Add Default Channel |
Creates a new channel for text to speech requests to be made to a platform C++ text to speech class. This will not create the channel if the provided channel id is not unique. Newly added channels must be activated to use text to speech functionalities. For out-of-the-box text to speech support, this is most likely the channel creation method you want. Target is Text to Speech Engine Subsystem |
|
Deactivate All Channels |
Deactivates all text to speech channels making all requests for text to speech functionality do nothing. Target is Text to Speech Engine Subsystem |
|
Deactivate Channel |
Deactivates a text to speech channel and stops any vocalized strings on that channel. Future Requests for text to speech functionality will do nothing. If the provided channel Id does not exist, nothing will happen. Target is Text to Speech Engine Subsystem |
|
Does Channel Exist |
Returns true if a text to speech channel associated with a channel Id exists. Otherwise, the function returns false. Target is Text to Speech Engine Subsystem |
|
Get Number Of Channels |
Returns the number of text to speech channels that have been added. Target is Text to Speech Engine Subsystem |
|
Get Rate on Channel |
Returns the current speech rate strings are vocalized on a text to speech channel. Value is between 0.0 and 1.0. If the provided channel Id does not exist, 0.0f will be returned. Target is Text to Speech Engine Subsystem |
|
Get Volume on Channel |
Returns the current volume strings are vocalized on a text to speech channel. Value is between 0.0f and 1.0f. If the provided channel Id doesn't exist, 0.0f will be returned. Target is Text to Speech Engine Subsystem |
|
Is Channel Active |
Returns true if the text to speech channel is active, otherwise false. Target is Text to Speech Engine Subsystem |
|
Is Channel Muted |
Returns true if the text to speech channel is muted, otherwise false. Target is Text to Speech Engine Subsystem |
|
Is Speaking on Channel |
Return true when the targeted text to speech channel is vocalising, otherwise false. Target is Text to Speech Engine Subsystem |
|
Mute Channel |
Mutes a text to speech channel so no vocalized strings are audible on that channel. If the requested channel is already muted, nothing will happen. Target is Text to Speech Engine Subsystem |
|
Remove All Channels |
Removes all text to speech channels, preventin future requests for text to speech functionality on all channels. Target is Text to Speech Engine Subsystem |
|
Remove Channel |
Removes a text to speech channel, preventing all further requests for text to speech functionality from the channel. If the provided channel Id does not exist, nothing will happen. Target is Text to Speech Engine Subsystem |
|
Set Rate on Channel |
Sets the current speech rate strings should be vocalized on a text to speech channel. If the provided channel does not exist, nothing will happen. Target is Text to Speech Engine Subsystem |
|
Set Volume on Channel |
Sets the volume for strings vocalized on a text to speech channel. If the provided channel Id does not exist, nothing will happen. Target is Text to Speech Engine Subsystem |
|
Speak on Channel |
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. Target is Text to Speech Engine Subsystem |
|
Stop Speaking on All Channels |
Immediately stops strings from being vocalized on all text to speech channels. Target is Text to Speech Engine Subsystem |
|
Stop Speaking on Channel |
Immediately stops any currently vocalized string on the channel. If the provided channel Id does not exist, nothing will happen. Target is Text to Speech Engine Subsystem |
|
Unmute Channel |
Unmutes a text to speech channel so vocalized strings are audible on the channel. If the requested channel is already unmuted, nothing will happen. Target is Text to Speech Engine Subsystem |