API reference

TTSClipData Class

Fields

audioType : AudioType
Signature
AudioType Meta.WitAi.TTS.Data.TTSClipData.audioType
clipID : string
Signature
string Meta.WitAi.TTS.Data.TTSClipData.clipID
completeDuration : float
Amount of time from request begin to complete callback in seconds
Signature
float Meta.WitAi.TTS.Data.TTSClipData.completeDuration
diskCacheSettings : TTSDiskCacheSettings
Signature
TTSDiskCacheSettings Meta.WitAi.TTS.Data.TTSClipData.diskCacheSettings
extension : string
The file extension to be used for this specific file type. Includes the period.
Signature
string Meta.WitAi.TTS.Data.TTSClipData.extension
loadProgress : float
Signature
float Meta.WitAi.TTS.Data.TTSClipData.loadProgress
loadState : TTSClipLoadState
Signature
TTSClipLoadState Meta.WitAi.TTS.Data.TTSClipData.loadState
onDownloadComplete : Action< string >
A callback when clip has downloaded successfully Returns an error if there was an issue
Signature
Action<string> Meta.WitAi.TTS.Data.TTSClipData.onDownloadComplete
onPlaybackBegin : Action< TTSClipData >
Called when a script has began playback with this clip
Signature
Action<TTSClipData> Meta.WitAi.TTS.Data.TTSClipData.onPlaybackBegin
onPlaybackComplete : Action< TTSClipData >
Called when a script has completed playback with this clip
Signature
Action<TTSClipData> Meta.WitAi.TTS.Data.TTSClipData.onPlaybackComplete
onPlaybackQueued : Action< TTSClipData >
Called when a script has queued playback with this clip
Signature
Action<TTSClipData> Meta.WitAi.TTS.Data.TTSClipData.onPlaybackQueued
onPlaybackReady : Action< TTSClipData >
A callback when clip stream is ready Returns an error if there was an issue
Signature
Action<TTSClipData> Meta.WitAi.TTS.Data.TTSClipData.onPlaybackReady
onRequestBegin : Action< TTSClipData >
Called when a script has requested load and playback of this clip
Signature
Action<TTSClipData> Meta.WitAi.TTS.Data.TTSClipData.onRequestBegin
onRequestComplete : Action< TTSClipData >
Called when a script has completed load and playback of this clip
Signature
Action<TTSClipData> Meta.WitAi.TTS.Data.TTSClipData.onRequestComplete
onStateChange : Action< TTSClipData, TTSClipLoadState >
Signature
Action<TTSClipData, TTSClipLoadState> Meta.WitAi.TTS.Data.TTSClipData.onStateChange
queryOperationId : string
Signature
string Meta.WitAi.TTS.Data.TTSClipData.queryOperationId
queryParameters : Dictionary< string, string >
Signature
Dictionary<string, string> Meta.WitAi.TTS.Data.TTSClipData.queryParameters
queryStream : bool
Signature
bool Meta.WitAi.TTS.Data.TTSClipData.queryStream
readyDuration : float
Amount of time from request begin to ready callback in seconds
Signature
float Meta.WitAi.TTS.Data.TTSClipData.readyDuration
textToSpeak : string
Signature
string Meta.WitAi.TTS.Data.TTSClipData.textToSpeak
useEvents : bool
Whether or not this tts clip data is requesting event data with tts stream.
Signature
bool Meta.WitAi.TTS.Data.TTSClipData.useEvents
voiceSettings : TTSVoiceSettings
Signature
TTSVoiceSettings Meta.WitAi.TTS.Data.TTSClipData.voiceSettings

Properties

clip : AudioClip
[Get]
Signature
AudioClip Meta.WitAi.TTS.Data.TTSClipData.clip
clipStream : IAudioClipStream
[Get][Set]
Signature
IAudioClipStream Meta.WitAi.TTS.Data.TTSClipData.clipStream
[Get]
The currently set tts events
Signature
TTSEventContainer Meta.WitAi.TTS.Data.TTSClipData.Events
LoadCompletion : TaskCompletionSource< bool >
[Get]
Task that returns when complete
Signature
TaskCompletionSource<bool> Meta.WitAi.TTS.Data.TTSClipData.LoadCompletion
LoadError : string
[Get][Set]
Any error that occurs during the load process
Signature
string Meta.WitAi.TTS.Data.TTSClipData.LoadError
LoadReady : TaskCompletionSource< bool >
[Get]
Task that returns when ready for playback
Signature
TaskCompletionSource<bool> Meta.WitAi.TTS.Data.TTSClipData.LoadReady
LoadStatusCode : int
[Get][Set]
Any error that occurs during the load process
Signature
int Meta.WitAi.TTS.Data.TTSClipData.LoadStatusCode
queryRequestId : string
[Get]
Unique request id used for tracking & logging
Signature
string Meta.WitAi.TTS.Data.TTSClipData.queryRequestId

Methods

Equals ( obj )
Compare clips if possible
Signature
override bool Meta.WitAi.TTS.Data.TTSClipData.Equals(object obj)
Parameters
obj: object
Returns
override bool
Equals ( other )
Compare clip ids
Signature
bool Meta.WitAi.TTS.Data.TTSClipData.Equals(TTSClipData other)
Parameters
Returns
bool
GetHashCode ()
Get hash code
Signature
override int Meta.WitAi.TTS.Data.TTSClipData.GetHashCode()
Returns
override int
HasClipId ( clipId )
Compare clip ids
Signature
bool Meta.WitAi.TTS.Data.TTSClipData.HasClipId(string clipId)
Parameters
clipId: string
Returns
bool
ToString ()
Obtains all clip data via formatting
Signature
override string Meta.WitAi.TTS.Data.TTSClipData.ToString()
Returns
override string