API reference

TTSService Class

Extends MonoBehaviour

Fields

Events : TTSServiceEvents

Signature

TTSServiceEvents Meta.WitAi.TTS.TTSService.Events

Properties

AudioSystem : IAudioSystem [Get][Set]	Audio system to be used for streaming & playback Signature IAudioSystem Meta.WitAi.TTS.TTSService.AudioSystem
DiskCacheHandler : abstract ITTSDiskCacheHandler [Get]	Signature abstract ITTSDiskCacheHandler Meta.WitAi.TTS.TTSService.DiskCacheHandler
Instance : TTSService [Get]	Signature TTSService Meta.WitAi.TTS.TTSService.Instance
RuntimeCacheHandler : abstract ITTSRuntimeCacheHandler [Get]	Signature abstract ITTSRuntimeCacheHandler Meta.WitAi.TTS.TTSService.RuntimeCacheHandler
VoiceProvider : abstract ITTSVoiceProvider [Get]	Signature abstract ITTSVoiceProvider Meta.WitAi.TTS.TTSService.VoiceProvider
WebHandler : abstract ITTSWebHandler [Get]	Signature abstract ITTSWebHandler Meta.WitAi.TTS.TTSService.WebHandler

Events

OnServiceDestroy : Action< TTSService >	Static event called whenever any TTSService.OnDestroy is called Signature Action<TTSService> Meta.WitAi.TTS.TTSService.OnServiceDestroy
OnServiceStart : Action< TTSService >	Static event called whenever any TTSService.Awake is called Signature Action<TTSService> Meta.WitAi.TTS.TTSService.OnServiceStart

Protected Methods

AddDelegates ()	Signature virtual void Meta.WitAi.TTS.TTSService.AddDelegates() Returns `void`
AppendFinalText ( builder , textToSpeak , voiceSettings )	Signature virtual void Meta.WitAi.TTS.TTSService.AppendFinalText(StringBuilder builder, string textToSpeak, TTSVoiceSettings voiceSettings) Parameters `builder: StringBuilder` `textToSpeak: string` `voiceSettings: TTSVoiceSettings` Returns `void`
Awake ()	Signature virtual void Meta.WitAi.TTS.TTSService.Awake() Returns `void`
CreateClipData ( textToSpeak , clipID , voiceSettings , diskCacheSettings )	Creates new clip data or returns existing cached clip Signature virtual TTSClipData Meta.WitAi.TTS.TTSService.CreateClipData(string textToSpeak, string clipID, TTSVoiceSettings voiceSettings, TTSDiskCacheSettings diskCacheSettings) Parameters `textToSpeak: string` Text to speak `clipID: string` Unique clip id `voiceSettings: TTSVoiceSettings` Voice settings `diskCacheSettings: TTSDiskCacheSettings` Disk Cache settings Returns `TTSClipData` Clip data structure
CreateClipStream ()	Signature virtual IAudioClipStream Meta.WitAi.TTS.TTSService.CreateClipStream() Returns `IAudioClipStream`
DownloadToDiskCache ( clipDataParam , onDownloadComplete )	Signature virtual void Meta.WitAi.TTS.TTSService.DownloadToDiskCache(TTSClipData clipDataParam, Action< TTSClipData, string, string > onDownloadComplete) Parameters `clipDataParam: TTSClipData` `onDownloadComplete: Action< TTSClipData, string, string >` Returns `void`
GetAudioType ()	Signature virtual AudioType Meta.WitAi.TTS.TTSService.GetAudioType() Returns `AudioType`
GetShouldAudioStream ( audioType )	Signature virtual bool Meta.WitAi.TTS.TTSService.GetShouldAudioStream(AudioType audioType) Parameters `audioType: AudioType` Returns `bool`
OnDestroy ()	Signature virtual void Meta.WitAi.TTS.TTSService.OnDestroy() Returns `void`
OnDisable ()	Signature virtual void Meta.WitAi.TTS.TTSService.OnDisable() Returns `void`
OnEnable ()	Signature virtual void Meta.WitAi.TTS.TTSService.OnEnable() Returns `void`
OnRuntimeClipAdded ( clipData )	Called when runtime cache adds a clip Signature virtual void Meta.WitAi.TTS.TTSService.OnRuntimeClipAdded(TTSClipData clipData) Parameters `clipData: TTSClipData` Returns `void`
OnRuntimeClipRemoved ( clipData )	Called when runtime cache unloads a clip Signature virtual void Meta.WitAi.TTS.TTSService.OnRuntimeClipRemoved(TTSClipData clipData) Parameters `clipData: TTSClipData` Clip to be unloaded Returns `void`
OnUnloadBegin ( clipData )	Perform clip unload Signature virtual void Meta.WitAi.TTS.TTSService.OnUnloadBegin(TTSClipData clipData) Parameters `clipData: TTSClipData` Returns `void`
RaiseRequestProgressUpdated ( clipData , newProgress )	Signature virtual void Meta.WitAi.TTS.TTSService.RaiseRequestProgressUpdated(TTSClipData clipData, float newProgress) Parameters `clipData: TTSClipData` `newProgress: float` Returns `void`
RemoveDelegates ()	Signature virtual void Meta.WitAi.TTS.TTSService.RemoveDelegates() Returns `void`
SetClipLoadState ( clipData , loadState )	Signature virtual void Meta.WitAi.TTS.TTSService.SetClipLoadState(TTSClipData clipData, TTSClipLoadState loadState) Parameters `clipData: TTSClipData` `loadState: TTSClipLoadState` Returns `void`
ShouldUseEvents ( audioType )	Signature virtual bool Meta.WitAi.TTS.TTSService.ShouldUseEvents(AudioType audioType) Parameters `audioType: AudioType` Returns `bool`
Start ()	Signature virtual void Meta.WitAi.TTS.TTSService.Start() Returns `void`

Methods

DownloadToDiskCache ( textToSpeak , onDownloadComplete )	Signature TTSClipData Meta.WitAi.TTS.TTSService.DownloadToDiskCache(string textToSpeak, Action< TTSClipData, string, string > onDownloadComplete=null) Parameters `textToSpeak: string` `onDownloadComplete: Action< TTSClipData, string, string >` Returns `TTSClipData`
DownloadToDiskCache ( textToSpeak , presetVoiceId , onDownloadComplete )	Signature TTSClipData Meta.WitAi.TTS.TTSService.DownloadToDiskCache(string textToSpeak, string presetVoiceId, Action< TTSClipData, string, string > onDownloadComplete=null) Parameters `textToSpeak: string` `presetVoiceId: string` `onDownloadComplete: Action< TTSClipData, string, string >` Returns `TTSClipData`
DownloadToDiskCache ( textToSpeak , presetVoiceId , diskCacheSettings , onDownloadComplete )	Signature TTSClipData Meta.WitAi.TTS.TTSService.DownloadToDiskCache(string textToSpeak, string presetVoiceId, TTSDiskCacheSettings diskCacheSettings, Action< TTSClipData, string, string > onDownloadComplete=null) Parameters `textToSpeak: string` `presetVoiceId: string` `diskCacheSettings: TTSDiskCacheSettings` `onDownloadComplete: Action< TTSClipData, string, string >` Returns `TTSClipData`
DownloadToDiskCache ( textToSpeak , voiceSettings , diskCacheSettings , onDownloadComplete )	Signature TTSClipData Meta.WitAi.TTS.TTSService.DownloadToDiskCache(string textToSpeak, TTSVoiceSettings voiceSettings, TTSDiskCacheSettings diskCacheSettings, Action< TTSClipData, string, string > onDownloadComplete=null) Parameters `textToSpeak: string` `voiceSettings: TTSVoiceSettings` `diskCacheSettings: TTSDiskCacheSettings` `onDownloadComplete: Action< TTSClipData, string, string >` Returns `TTSClipData`
DownloadToDiskCache ( textToSpeak , clipID , voiceSettings , diskCacheSettings , onDownloadComplete )	Perform a download for a TTS audio clip Signature TTSClipData Meta.WitAi.TTS.TTSService.DownloadToDiskCache(string textToSpeak, string clipID, TTSVoiceSettings voiceSettings, TTSDiskCacheSettings diskCacheSettings, Action< TTSClipData, string, string > onDownloadComplete=null) Parameters `textToSpeak: string` Text to be spoken in clip `clipID: string` Unique clip id `voiceSettings: TTSVoiceSettings` Custom voice settings `diskCacheSettings: TTSDiskCacheSettings` Custom disk cache settings `onDownloadComplete: Action< TTSClipData, string, string >` Callback when file has finished downloading Returns `TTSClipData` Generated TTS clip data
GetAllPresetVoiceSettings ()	Return all preset voice settings Signature TTSVoiceSettings [] Meta.WitAi.TTS.TTSService.GetAllPresetVoiceSettings() Returns `TTSVoiceSettings []`
GetAllRuntimeCachedClips ()	Obtain all clips from the runtime cache, if applicable Signature TTSClipData [] Meta.WitAi.TTS.TTSService.GetAllRuntimeCachedClips() Returns `TTSClipData []`
GetClipID ( textToSpeak , voiceSettings )	Obtain unique id for clip data Signature virtual string Meta.WitAi.TTS.TTSService.GetClipID(string textToSpeak, TTSVoiceSettings voiceSettings) Parameters `textToSpeak: string` `voiceSettings: TTSVoiceSettings` Returns `string`
GetDiskCachePath ( textToSpeak , clipID , voiceSettings , diskCacheSettings )	Get disk cache Signature string Meta.WitAi.TTS.TTSService.GetDiskCachePath(string textToSpeak, string clipID, TTSVoiceSettings voiceSettings, TTSDiskCacheSettings diskCacheSettings) Parameters `textToSpeak: string` Text to be spoken in clip `clipID: string` Unique clip id `voiceSettings: TTSVoiceSettings` Custom voice settings `diskCacheSettings: TTSDiskCacheSettings` Custom disk cache settings Returns `string`
GetFinalText ( textToSpeak , voiceSettings )	Gets the text to be spoken after applying all relevant voice settings. Signature string Meta.WitAi.TTS.TTSService.GetFinalText(string textToSpeak, TTSVoiceSettings voiceSettings) Parameters `textToSpeak: string` Text to be spoken by a particular voice `voiceSettings: TTSVoiceSettings` Voice settings to be used Returns `string` Returns a the final text to be spoken
GetInvalidError ()	Returns error if invalid Signature virtual string Meta.WitAi.TTS.TTSService.GetInvalidError() Returns `string`
GetPresetVoiceSettings ( presetVoiceId )	Return preset voice settings for a specific id Signature TTSVoiceSettings Meta.WitAi.TTS.TTSService.GetPresetVoiceSettings(string presetVoiceId) Parameters `presetVoiceId: string` Returns `TTSVoiceSettings`
GetRuntimeCachedClip ( clipID )	Obtain a clip from the runtime cache, if applicable Signature TTSClipData Meta.WitAi.TTS.TTSService.GetRuntimeCachedClip(string clipID) Parameters `clipID: string` Returns `TTSClipData`
Load ( textToSpeak , onStreamReady )	Signature TTSClipData Meta.WitAi.TTS.TTSService.Load(string textToSpeak, Action< TTSClipData, string > onStreamReady=null) Parameters `textToSpeak: string` `onStreamReady: Action< TTSClipData, string >` Returns `TTSClipData`
Load ( textToSpeak , presetVoiceId , onStreamReady )	Signature TTSClipData Meta.WitAi.TTS.TTSService.Load(string textToSpeak, string presetVoiceId, Action< TTSClipData, string > onStreamReady=null) Parameters `textToSpeak: string` `presetVoiceId: string` `onStreamReady: Action< TTSClipData, string >` Returns `TTSClipData`
Load ( textToSpeak , presetVoiceId , diskCacheSettings , onStreamReady )	Signature TTSClipData Meta.WitAi.TTS.TTSService.Load(string textToSpeak, string presetVoiceId, TTSDiskCacheSettings diskCacheSettings, Action< TTSClipData, string > onStreamReady=null) Parameters `textToSpeak: string` `presetVoiceId: string` `diskCacheSettings: TTSDiskCacheSettings` `onStreamReady: Action< TTSClipData, string >` Returns `TTSClipData`
Load ( textToSpeak , voiceSettings , diskCacheSettings , onStreamReady )	Signature TTSClipData Meta.WitAi.TTS.TTSService.Load(string textToSpeak, TTSVoiceSettings voiceSettings, TTSDiskCacheSettings diskCacheSettings, Action< TTSClipData, string > onStreamReady=null) Parameters `textToSpeak: string` `voiceSettings: TTSVoiceSettings` `diskCacheSettings: TTSDiskCacheSettings` `onStreamReady: Action< TTSClipData, string >` Returns `TTSClipData`
Load ( textToSpeak , clipID , voiceSettings , diskCacheSettings , onStreamReady )	Perform a request for a TTS audio clip Signature virtual TTSClipData Meta.WitAi.TTS.TTSService.Load(string textToSpeak, string clipID, TTSVoiceSettings voiceSettings, TTSDiskCacheSettings diskCacheSettings, Action< TTSClipData, string > onStreamReady) Parameters `textToSpeak: string` Text to be spoken in clip `clipID: string` Unique clip id `voiceSettings: TTSVoiceSettings` Custom voice settings `diskCacheSettings: TTSDiskCacheSettings` Custom cache settings `onStreamReady: Action< TTSClipData, string >` Returns `TTSClipData` Generated TTS clip data
ShouldCacheToDisk ( clipData )	Whether a specific clip should be cached Signature bool Meta.WitAi.TTS.TTSService.ShouldCacheToDisk(TTSClipData clipData) Parameters `clipData: TTSClipData` Clip data Returns `bool` True if should be cached
Unload ( clipData )	Force a runtime cache unload Signature void Meta.WitAi.TTS.TTSService.Unload(TTSClipData clipData) Parameters `clipData: TTSClipData` Returns `void`
UnloadAll ()	Unload all audio clips from the runtime cache Signature void Meta.WitAi.TTS.TTSService.UnloadAll() Returns `void`