API reference

TTSWit Class

Implements Meta.WitAi.TTS.Interfaces.ITTSVoiceProvider, Meta.WitAi.TTS.Interfaces.ITTSWebHandler, Meta.WitAi.Interfaces.IWitConfigurationProvider, Meta.WitAi.Interfaces.IWitConfigurationSetter

Fields

PresetWitVoiceSettings : TTSWitVoiceSettings []	Signature TTSWitVoiceSettings [] Meta.WitAi.TTS.Integrations.TTSWit.PresetWitVoiceSettings
RequestSettings : TTSWitRequestSettings	Signature TTSWitRequestSettings Meta.WitAi.TTS.Integrations.TTSWit.RequestSettings
VoiceDefaultSettings : TTSVoiceSettings	Signature TTSVoiceSettings Meta.WitAi.TTS.Integrations.TTSWit.VoiceDefaultSettings
VoiceProvider : override ITTSVoiceProvider	The voice provider used for preset voice settings. Uses TTSWit with TTSWitVoiceSettings Signature override ITTSVoiceProvider Meta.WitAi.TTS.Integrations.TTSWit.VoiceProvider
WebHandler : override ITTSWebHandler	This script provides web request handling Signature override ITTSWebHandler Meta.WitAi.TTS.Integrations.TTSWit.WebHandler
WebRequestEvents : TTSWebRequestEvents	Signature TTSWebRequestEvents Meta.WitAi.TTS.Integrations.TTSWit.WebRequestEvents

Properties

Configuration : WitConfiguration [Get][Set]	The configuration to be updated Signature WitConfiguration Meta.WitAi.TTS.Integrations.TTSWit.Configuration
DiskCacheHandler : override ITTSDiskCacheHandler [Get]	Uses the local disk cache if found Signature override ITTSDiskCacheHandler Meta.WitAi.TTS.Integrations.TTSWit.DiskCacheHandler
PresetVoiceSettings : TTSVoiceSettings [] [Get]	Signature TTSVoiceSettings [] Meta.WitAi.TTS.Integrations.TTSWit.PresetVoiceSettings
RuntimeCacheHandler : override ITTSRuntimeCacheHandler [Get]	Generates a runtime cache if one is not found Signature override ITTSRuntimeCacheHandler Meta.WitAi.TTS.Integrations.TTSWit.RuntimeCacheHandler
WebDownloadEvents : TTSDownloadEvents [Get][Set]	Signature TTSDownloadEvents Meta.WitAi.TTS.Integrations.TTSWit.WebDownloadEvents
WebStreamEvents : TTSStreamEvents [Get][Set]	Signature TTSStreamEvents Meta.WitAi.TTS.Integrations.TTSWit.WebStreamEvents

Events

OnConfigurationUpdated : Action< WitConfiguration >

Callback following configuration change

Signature

Action<WitConfiguration> Meta.WitAi.TTS.Integrations.TTSWit.OnConfigurationUpdated

Protected Methods

GetAudioType ()	Signature override AudioType Meta.WitAi.TTS.Integrations.TTSWit.GetAudioType() Returns `override AudioType`
GetShouldAudioStream ( audioType )	Signature override bool Meta.WitAi.TTS.Integrations.TTSWit.GetShouldAudioStream(AudioType audioType) Parameters `audioType: AudioType` Returns `override bool`
OnDisable ()	Ensures web socket adapter disconnects from the client Signature override void Meta.WitAi.TTS.Integrations.TTSWit.OnDisable() Returns `override void`
OnEnable ()	Attempt to instantiate web socket adapter Signature override void Meta.WitAi.TTS.Integrations.TTSWit.OnEnable() Returns `override void`
RefreshWebSocketSettings ()	Refreshes client provider on web socket settings Signature virtual void Meta.WitAi.TTS.Integrations.TTSWit.RefreshWebSocketSettings() Returns `void`
ShouldUseEvents ( audioType )	Signature override bool Meta.WitAi.TTS.Integrations.TTSWit.ShouldUseEvents(AudioType audioType) Parameters `audioType: AudioType` Returns `override bool`

Methods

CancelWebDownload ( clipData , downloadPath )	Method for cancelling a running load request Signature bool Meta.WitAi.TTS.Integrations.TTSWit.CancelWebDownload(TTSClipData clipData, string downloadPath) Parameters `clipData: TTSClipData` Clip request data `downloadPath: string` Returns `bool`
CancelWebStream ( clipData )	Cancel web stream Signature bool Meta.WitAi.TTS.Integrations.TTSWit.CancelWebStream(TTSClipData clipData) Parameters `clipData: TTSClipData` Returns `bool`
GetInvalidError ()	Returns error if invalid Signature override string Meta.WitAi.TTS.Integrations.TTSWit.GetInvalidError() Returns `override string`
GetWebErrors ( clipData )	Method for determining if there are problems that will arise with performing a web request prior to doing so Signature string Meta.WitAi.TTS.Integrations.TTSWit.GetWebErrors(TTSClipData clipData) Parameters `clipData: TTSClipData` The clip data to be used for the request Returns `string` Invalid error(s). It will be empty if there are none
RequestDownloadFromWeb ( clipData , downloadPath )	Method for performing a web load request Signature void Meta.WitAi.TTS.Integrations.TTSWit.RequestDownloadFromWeb(TTSClipData clipData, string downloadPath) Parameters `clipData: TTSClipData` Clip request data `downloadPath: string` Path to save clip Returns `void`
RequestStreamFromWeb ( clipData )	Method for performing a web load request Signature void Meta.WitAi.TTS.Integrations.TTSWit.RequestStreamFromWeb(TTSClipData clipData) Parameters `clipData: TTSClipData` Clip request data Returns `void`