TTSWit Class

Implements Meta.WitAi.TTS.Interfaces.ITTSVoiceProvider, Meta.WitAi.TTS.Interfaces.ITTSWebHandler, Meta.WitAi.Interfaces.IWitConfigurationProvider, Meta.WitAi.Interfaces.IWitConfigurationSetter, Lib.Wit.Runtime.Utilities.Logging.ILogSource

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

Properties

Configuration : WitConfiguration [Get][Set]	The configuration to be updated Signature WitConfiguration Meta.WitAi.TTS.Integrations.TTSWit.Configuration
PresetVoiceSettings : TTSVoiceSettings [] [Get]	Signature TTSVoiceSettings [] Meta.WitAi.TTS.Integrations.TTSWit.PresetVoiceSettings

Events

OnConfigurationUpdated : Action< WitConfiguration >

Callback following configuration change

Signature

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

Protected Methods

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 and setup audio system 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`

Methods

CancelRequests ( clipData )	Cancels any running requests Signature bool Meta.WitAi.TTS.Integrations.TTSWit.CancelRequests(TTSClipData clipData) Parameters `clipData: TTSClipData` Returns `bool`
CreateClipData ( clipId , textToSpeak , voiceSettings , diskCacheSettings )	Method for creating a new TTSClipData Signature TTSClipData Meta.WitAi.TTS.Integrations.TTSWit.CreateClipData(string clipId, string textToSpeak, TTSVoiceSettings voiceSettings, TTSDiskCacheSettings diskCacheSettings) Parameters `clipId: string` Unique clip identifier `textToSpeak: string` Text to be spoken `voiceSettings: TTSVoiceSettings` Settings for how the clip should sound during playback. `diskCacheSettings: TTSDiskCacheSettings` If and how this clip should be cached. Returns `TTSClipData`
DecodeTtsFromJson ( responseNode , textToSpeak , voiceSettings )	Decode a response node into text to be spoken or a specific voice setting Example Data: { "q": "Text to be spoken" "voice": "Charlie } Signature bool Meta.WitAi.TTS.Integrations.TTSWit.DecodeTtsFromJson(WitResponseNode responseNode, out string textToSpeak, out TTSVoiceSettings voiceSettings) Parameters `responseNode: WitResponseNode` Parsed data that includes text to be spoken and voice settings `textToSpeak: out string` The text to be spoken output `voiceSettings: out TTSVoiceSettings` The output for voice settings Returns `bool` True if decode was successful
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
IsDownloadedToDisk ( diskPath )	Checks if file exists on disk Signature async Task<string> Meta.WitAi.TTS.Integrations.TTSWit.IsDownloadedToDisk(string diskPath) Parameters `diskPath: string` Returns `async Task< string >`
RequestDownloadFromWeb ( clipData , diskPath )	Method for performing a web download request Signature Task<string> Meta.WitAi.TTS.Integrations.TTSWit.RequestDownloadFromWeb(TTSClipData clipData, string diskPath) Parameters `clipData: TTSClipData` Clip request data `diskPath: string` The specific disk path the file should be downloaded to Returns `Task< string >`
RequestStreamFromDisk ( clipData , diskPath , onReady )	Streams from disk Signature async Task<string> Meta.WitAi.TTS.Integrations.TTSWit.RequestStreamFromDisk(TTSClipData clipData, string diskPath, Action< TTSClipData > onReady) Parameters `clipData: TTSClipData` `diskPath: string` `onReady: Action< TTSClipData >` Returns `async Task< string >`
RequestStreamFromWeb ( clipData , onReady )	Method for streaming audio from a back-end service. Signature async Task<string> Meta.WitAi.TTS.Integrations.TTSWit.RequestStreamFromWeb(TTSClipData clipData, Action< TTSClipData > onReady) Parameters `clipData: TTSClipData` Information about the clip being requested. `onReady: Action< TTSClipData >` Callback on request is ready for playback. Returns `async Task< string >`