API reference
TTSService Class
Extends MonoBehaviour
Properties
static TTSService Instance[Get]
IAudioSystem AudioSystem[Get]
Audio system to be used for streaming & playback
abstract ITTSRuntimeCacheHandler RuntimeCacheHandler[Get]
abstract ITTSDiskCacheHandler DiskCacheHandler[Get]
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
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
virtual string GetClipID
( string textToSpeak,
TTSVoiceSettings voiceSettings )
Obtain unique id for clip data
TTSClipData Load
( string textToSpeak,
Action< TTSClipData, string > onStreamReady )
TTSClipData Load
( string textToSpeak,
string presetVoiceId,
Action< TTSClipData, string > onStreamReady )
TTSClipData Load
( string textToSpeak,
string presetVoiceId,
TTSDiskCacheSettings diskCacheSettings,
Action< TTSClipData, string > onStreamReady )
TTSClipData Load
( string textToSpeak,
TTSVoiceSettings voiceSettings,
TTSDiskCacheSettings diskCacheSettings,
Action< TTSClipData, string > onStreamReady )
virtual TTSClipData Load
( string textToSpeak,
string clipID,
TTSVoiceSettings voiceSettings,
TTSDiskCacheSettings diskCacheSettings,
Action< TTSClipData, string > onStreamReady )
Perform a request for a audio clip
Parameters
textToSpeak
Text to be spoken in clip
clipID
Unique clip id
voiceSettings
Custom voice settings
diskCacheSettings
Custom cache settings
Returns
Generated clip data
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,
Action< TTSClipData, string, string > onDownloadComplete )
TTSClipData DownloadToDiskCache
( string textToSpeak,
string presetVoiceId,
Action< TTSClipData, string, string > onDownloadComplete )
TTSClipData DownloadToDiskCache
( string textToSpeak,
string presetVoiceId,
TTSDiskCacheSettings diskCacheSettings,
Action< TTSClipData, string, string > onDownloadComplete )
TTSClipData DownloadToDiskCache
( string textToSpeak,
TTSVoiceSettings voiceSettings,
TTSDiskCacheSettings diskCacheSettings,
Action< TTSClipData, string, string > onDownloadComplete )
TTSClipData DownloadToDiskCache
( string textToSpeak,
string clipID,
TTSVoiceSettings voiceSettings,
TTSDiskCacheSettings diskCacheSettings,
Action< TTSClipData, string, string > onDownloadComplete )
Perform a download for a audio clip
Parameters
textToSpeak
Text to be spoken in clip
clipID
Unique clip id
voiceSettings
Custom voice settings
diskCacheSettings
Custom disk cache settings
onDownloadComplete
Callback when file has finished downloading
Returns
Generated clip data
TTSVoiceSettings [] GetAllPresetVoiceSettings ( )
Return all preset voice settings
Returns
TTSVoiceSettings GetPresetVoiceSettings
( string presetVoiceId )
Return preset voice settings for a specific id
Parameters
presetVoiceId
Returns
Protected Functions
virtual void Awake ( )
virtual void Start ( )
virtual void OnEnable ( )
virtual void OnDisable ( )
virtual void AddDelegates ( )
virtual void RemoveDelegates ( )
virtual void OnDestroy ( )
virtual void AppendFinalText
( StringBuilder builder,
string textToSpeak,
TTSVoiceSettings voiceSettings )
virtual TTSClipData CreateClipData
( string textToSpeak,
string clipID,
TTSVoiceSettings voiceSettings,
TTSDiskCacheSettings diskCacheSettings )
Creates new clip data or returns existing cached clip
Parameters
textToSpeak
Text to speak
clipID
Unique clip id
voiceSettings
Voice settings
diskCacheSettings
Disk Cache settings
Returns
Clip data structure
virtual IAudioClipStream CreateClipStream ( )
virtual AudioType GetAudioType ( )
virtual bool GetShouldAudioStream
( AudioType audioType )
virtual bool ShouldUseEvents
( AudioType audioType )
virtual void SetClipLoadState
( TTSClipData clipData,
TTSClipLoadState loadState )
virtual void RaiseRequestProgressUpdated
( TTSClipData clipData,
float newProgress )
virtual void OnUnloadBegin
( TTSClipData clipData )
Perform clip unload
Parameters
clipID
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
virtual void DownloadToDiskCache
( TTSClipData clipDataParam,
Action< TTSClipData, string, string > onDownloadComplete )
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