API reference
API reference
Select your platform
No SDKs available
No versions available
TTSService Class
Extends MonoBehaviour, ILogSource
Abstract script for loading and returning text-to-speech clip streams.
Properties
IVLogger Logger[Get]
static TTSService Instance[Get]
Static singleton to be used when interacting with a single TTSService
IAudioSystem AudioSystem[Get]
Audio system to be used for obtaining audio clip streams
ITTSRuntimeCacheHandler RuntimeCacheHandler[Get]
Runtime cache that assists with the temporary storage of audio clips
ITTSDiskCacheHandler DiskCacheHandler[Get]
Disk cache that assists with the backup and retrieval of audio clips saved to disk.
abstract ITTSWebHandler WebHandler[Get]
abstract ITTSVoiceProvider VoiceProvider[Get]
Events
static Action< TTSService > OnServiceStart
Static event called whenever any TTSService.Awake is called
static Action< TTSService > OnServiceDestroy
Static event called whenever any TTSService.OnDestroy is called
Fields
TTSServiceEvents Events[Get]
Member Functions
virtual string GetInvalidError ( )
Returns error if invalid
virtual string GetFinalText
( string textToSpeak,
TTSVoiceSettings voiceSettings )
Gets the text to be spoken after applying all relevant voice settings.
Parameters
textToSpeak
Text to be spoken by a particular voice
voiceSettings
Voice settings to be used
Returns
Returns a the final text to be spoken
string GetClipID
( string textToSpeak,
TTSVoiceSettings voiceSettings )
Obtain unique id for clip data using provided text
TTSClipData GetClipData
( string textToSpeak,
TTSVoiceSettings voiceSettings,
TTSDiskCacheSettings diskCacheSettings )
Creates new clip data or returns existing cached clip
Parameters
Returns
Clip data structure
bool DecodeTts
( WitResponseNode responseNode,
out string textToSpeak,
out TTSVoiceSettings voiceSettings )
Decode a response node into text to be spoken or a specific voice setting
Parameters
responseNode
Parsed data that includes text to be spoken and voice settings
textToSpeak
The text to be spoken output
voiceSettings
The output for voice settings
Returns
True if decode was successful
TTSClipData Load
( string textToSpeak,
string presetVoiceId,
TTSDiskCacheSettings diskCacheSettings,
Action< TTSClipData > onStreamReady,
Action< TTSClipData, string > onStreamComplete )
Loads a text-to-speech clip using a preset voice id, specified settings and return methods
Parameters
textToSpeak
Text to be spoken in audio
presetVoiceId
Specific id that corresponds to a preset voice setting id
diskCacheSettings
Custom disk cache options
onStreamReady
Callback for stream ready to perform playback
onStreamComplete
Callback for stream complete
Returns
Returns the generated tts clip
TTSClipData Load
( string textToSpeak,
TTSVoiceSettings voiceSettings,
TTSDiskCacheSettings diskCacheSettings,
Action< TTSClipData > onStreamReady,
Action< TTSClipData, string > onStreamComplete )
Loads a text-to-speech clip using specified settings and return methods
Parameters
textToSpeak
Text to be spoken in audio
voiceSettings
Custom voice options
diskCacheSettings
Custom disk cache options
onStreamReady
Callback for stream ready to perform playback
onStreamComplete
Callback for stream complete
Returns
Returns the generated tts clip
async Task< string > LoadAsync
( TTSClipData clipData,
Action< TTSClipData > onStreamReady,
Action< TTSClipData, string > onStreamComplete )
Loads a text-to-speech clip using specified settings and return methods
Parameters
clipData
The clip that will be loaded if needed
onStreamReady
Callback for stream ready to perform playback
onStreamComplete
Callback for stream complete
Returns
Returns an error
void UnloadAll ( )
Unload all audio clips from the runtime cache
void Unload
( TTSClipData clipData )
Force a runtime cache unload
TTSClipData GetRuntimeCachedClip
( string clipID )
Obtain a clip from the runtime cache, if applicable
TTSClipData [] GetAllRuntimeCachedClips ( )
Obtain all clips from the runtime cache, if applicable
bool ShouldCacheToDisk
( TTSClipData clipData )
Whether a specific clip should be cached
Parameters
clipData
Clip data
Returns
True if should be cached
string GetDiskCachePath
( string textToSpeak,
string clipID,
TTSVoiceSettings voiceSettings,
TTSDiskCacheSettings diskCacheSettings )
Get disk cache
Parameters
textToSpeak
Text to be spoken in clip
clipID
Unique clip id
voiceSettings
Custom voice settings
diskCacheSettings
Custom disk cache settings
Returns
TTSClipData DownloadToDiskCache
( string textToSpeak,
string presetVoiceId,
TTSDiskCacheSettings diskCacheSettings,
Action< TTSClipData, string, string > onDownloadComplete )
Perform a download for a audio clip
Parameters
textToSpeak
Text to be spoken in clip
presetVoiceId
Specific voice id
diskCacheSettings
Custom disk cache settings
onDownloadComplete
Callback when file has finished downloading
Returns
Generated clip data
TTSClipData DownloadToDiskCache
( string textToSpeak,
TTSVoiceSettings voiceSettings,
TTSDiskCacheSettings diskCacheSettings,
Action< TTSClipData, string, string > onDownloadComplete )
Perform a download for a audio clip
Parameters
textToSpeak
Text to be spoken in clip
voiceSettings
Custom voice settings
diskCacheSettings
Custom disk cache settings
onDownloadComplete
Callback when file has finished downloading with success or error
Returns
Generated clip data
async Task< string > DownloadAsync
( string textToSpeak,
TTSVoiceSettings voiceSettings,
TTSDiskCacheSettings diskCacheSettings )
Perform a download for a audio clip
Parameters
textToSpeak
Text to be spoken in clip
voiceSettings
Custom voice settings
diskCacheSettings
Custom disk cache settings
Returns
Any errors that occured during the download process
TTSVoiceSettings [] GetAllPresetVoiceSettings ( )
Return all preset voice settings
TTSVoiceSettings GetPresetVoiceSettings
( string presetVoiceId )
Return preset voice settings for a specific id
Protected Functions
virtual void Awake ( )
virtual void Start ( )
virtual void OnEnable ( )
virtual void OnDisable ( )
virtual void SetListeners
( bool add )
Sets listeners to add or remove
TInterface GetInterface< TInterface >
( TInterface current )
Obtains a script implementing a specific interface on this game object
TInterface GetOrCreateInterface< TInterface, TDefault >
( TInterface current )
Obtains a script implementing an interface or generates one if not found.
virtual void OnDestroy ( )
virtual string GetClipIDWithFinalText
( string formattedText,
TTSVoiceSettings voiceSettings )
Obtain unique id for clip data with text that has already been passed through GetFinalText
virtual void SetClipLoadState
( TTSClipData clipData,
TTSClipLoadState loadState )
virtual void OnRuntimeClipAdded
( TTSClipData clipData )
Called when runtime cache adds a clip
Parameters
clipData
virtual void OnRuntimeClipRemoved
( TTSClipData clipData )
Called when runtime cache unloads a clip
Parameters
clipData
Clip to be unloaded
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta