Meta Developers

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

Data Fields

TTSServiceEvents

Events[Get]

Public Member Functions

string	GetInvalidError ( ) Returns error if invalid
string	GetFinalText ( string textToSpeak, TTSVoiceSettings voiceSettings ) Gets the text to be spoken after applying all relevant voice settings.
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 )
TTSClipData	Load ( string textToSpeak, string clipID, TTSVoiceSettings voiceSettings, TTSDiskCacheSettings diskCacheSettings, Action< TTSClipData, string > onStreamReady ) Perform a request for a audio clip
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
string	GetDiskCachePath ( string textToSpeak, string clipID, TTSVoiceSettings voiceSettings, TTSDiskCacheSettings diskCacheSettings ) Get disk cache
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
TTSVoiceSettings []	GetAllPresetVoiceSettings ( ) Return all preset voice settings
TTSVoiceSettings	GetPresetVoiceSettings ( string presetVoiceId ) Return preset voice settings for a specific id

Object Data

void	Awake ( )
void	Start ( )
void	OnEnable ( )
void	OnDisable ( )
void	AddDelegates ( )
void	RemoveDelegates ( )
void	OnDestroy ( )
void	AppendFinalText ( StringBuilder builder, string textToSpeak, TTSVoiceSettings voiceSettings )
TTSClipData	CreateClipData ( string textToSpeak, string clipID, TTSVoiceSettings voiceSettings, TTSDiskCacheSettings diskCacheSettings ) Creates new clip data or returns existing cached clip
IAudioClipStream	CreateClipStream ( )
AudioType	GetAudioType ( )
bool	GetShouldAudioStream ( AudioType audioType )
bool	ShouldUseEvents ( AudioType audioType )
void	SetClipLoadState ( TTSClipData clipData, TTSClipLoadState loadState )
void	RaiseRequestProgressUpdated ( TTSClipData clipData, float newProgress )
void	OnUnloadBegin ( TTSClipData clipData ) Perform clip unload
void	OnRuntimeClipAdded ( TTSClipData clipData ) Called when runtime cache adds a clip
void	OnRuntimeClipRemoved ( TTSClipData clipData ) Called when runtime cache unloads a clip
void	DownloadToDiskCache ( TTSClipData clipDataParam, Action< TTSClipData, string, string > onDownloadComplete )

Details

Properties

TTSService Meta.WitAi.TTS.TTSService.Instance
No description available.

IAudioSystem Meta.WitAi.TTS.TTSService.AudioSystem
Audio system to be used for streaming & playback

abstract ITTSRuntimeCacheHandler Meta.WitAi.TTS.TTSService.RuntimeCacheHandler
No description available.

abstract ITTSDiskCacheHandler Meta.WitAi.TTS.TTSService.DiskCacheHandler
No description available.

abstract ITTSWebHandler Meta.WitAi.TTS.TTSService.WebHandler
No description available.

abstract ITTSVoiceProvider Meta.WitAi.TTS.TTSService.VoiceProvider
No description available.

Events

Action<TTSService> Meta.WitAi.TTS.TTSService.OnServiceStart ( )
Static event called whenever any TTSService.Awake is called

Action<TTSService> Meta.WitAi.TTS.TTSService.OnServiceDestroy ( )
Static event called whenever any TTSService.OnDestroy is called

Fields

TTSServiceEvents Meta.WitAi.TTS.TTSService.Events
No description available.

Member Functions

virtual string Meta.WitAi.TTS.TTSService.GetInvalidError ( )
Returns error if invalid

string Meta.WitAi.TTS.TTSService.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 Meta.WitAi.TTS.TTSService.GetClipID ( string textToSpeak, TTSVoiceSettings voiceSettings )
Obtain unique id for clip data

TTSClipData Meta.WitAi.TTS.TTSService.Load ( string textToSpeak, Action< TTSClipData, string > onStreamReady )
No description available.

TTSClipData Meta.WitAi.TTS.TTSService.Load ( string textToSpeak, string presetVoiceId, Action< TTSClipData, string > onStreamReady )
No description available.

TTSClipData Meta.WitAi.TTS.TTSService.Load ( string textToSpeak, string presetVoiceId, TTSDiskCacheSettings diskCacheSettings, Action< TTSClipData, string > onStreamReady )
No description available.

TTSClipData Meta.WitAi.TTS.TTSService.Load ( string textToSpeak, TTSVoiceSettings voiceSettings, TTSDiskCacheSettings diskCacheSettings, Action< TTSClipData, string > onStreamReady )
No description available.

virtual TTSClipData Meta.WitAi.TTS.TTSService.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 Meta.WitAi.TTS.TTSService.UnloadAll ( )
Unload all audio clips from the runtime cache

void Meta.WitAi.TTS.TTSService.Unload ( TTSClipData clipData )
Force a runtime cache unload

TTSClipData Meta.WitAi.TTS.TTSService.GetRuntimeCachedClip ( string clipID )
Obtain a clip from the runtime cache, if applicable

TTSClipData [] Meta.WitAi.TTS.TTSService.GetAllRuntimeCachedClips ( )
Obtain all clips from the runtime cache, if applicable

bool Meta.WitAi.TTS.TTSService.ShouldCacheToDisk ( TTSClipData clipData )
Whether a specific clip should be cached Parameters clipData Clip data Returns True if should be cached

string Meta.WitAi.TTS.TTSService.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 Meta.WitAi.TTS.TTSService.DownloadToDiskCache ( string textToSpeak, Action< TTSClipData, string, string > onDownloadComplete )
No description available.

TTSClipData Meta.WitAi.TTS.TTSService.DownloadToDiskCache ( string textToSpeak, string presetVoiceId, Action< TTSClipData, string, string > onDownloadComplete )
No description available.

TTSClipData Meta.WitAi.TTS.TTSService.DownloadToDiskCache ( string textToSpeak, string presetVoiceId, TTSDiskCacheSettings diskCacheSettings, Action< TTSClipData, string, string > onDownloadComplete )
No description available.

TTSClipData Meta.WitAi.TTS.TTSService.DownloadToDiskCache ( string textToSpeak, TTSVoiceSettings voiceSettings, TTSDiskCacheSettings diskCacheSettings, Action< TTSClipData, string, string > onDownloadComplete )
No description available.

TTSClipData Meta.WitAi.TTS.TTSService.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 [] Meta.WitAi.TTS.TTSService.GetAllPresetVoiceSettings ( )
Return all preset voice settings Returns

TTSVoiceSettings Meta.WitAi.TTS.TTSService.GetPresetVoiceSettings ( string presetVoiceId )
Return preset voice settings for a specific id Parameters presetVoiceId Returns

Object Data

virtual void Meta.WitAi.TTS.TTSService.Awake ( )
No description available.

virtual void Meta.WitAi.TTS.TTSService.Start ( )
No description available.

virtual void Meta.WitAi.TTS.TTSService.OnEnable ( )
No description available.

virtual void Meta.WitAi.TTS.TTSService.OnDisable ( )
No description available.

virtual void Meta.WitAi.TTS.TTSService.AddDelegates ( )
No description available.

virtual void Meta.WitAi.TTS.TTSService.RemoveDelegates ( )
No description available.

virtual void Meta.WitAi.TTS.TTSService.OnDestroy ( )
No description available.

virtual void Meta.WitAi.TTS.TTSService.AppendFinalText ( StringBuilder builder, string textToSpeak, TTSVoiceSettings voiceSettings )
No description available.

virtual TTSClipData Meta.WitAi.TTS.TTSService.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 Meta.WitAi.TTS.TTSService.CreateClipStream ( )
No description available.

virtual AudioType Meta.WitAi.TTS.TTSService.GetAudioType ( )
No description available.

virtual bool Meta.WitAi.TTS.TTSService.GetShouldAudioStream ( AudioType audioType )
No description available.

virtual bool Meta.WitAi.TTS.TTSService.ShouldUseEvents ( AudioType audioType )
No description available.

virtual void Meta.WitAi.TTS.TTSService.SetClipLoadState ( TTSClipData clipData, TTSClipLoadState loadState )
No description available.

virtual void Meta.WitAi.TTS.TTSService.RaiseRequestProgressUpdated ( TTSClipData clipData, float newProgress )
No description available.

virtual void Meta.WitAi.TTS.TTSService.OnUnloadBegin ( TTSClipData clipData )
Perform clip unload Parameters clipID

virtual void Meta.WitAi.TTS.TTSService.OnRuntimeClipAdded ( TTSClipData clipData )
Called when runtime cache adds a clip Parameters clipData

virtual void Meta.WitAi.TTS.TTSService.OnRuntimeClipRemoved ( TTSClipData clipData )
Called when runtime cache unloads a clip Parameters clipData Clip to be unloaded

virtual void Meta.WitAi.TTS.TTSService.DownloadToDiskCache ( TTSClipData clipDataParam, Action< TTSClipData, string, string > onDownloadComplete )
No description available.

Did you find this page helpful?