API reference
API reference
Select your platform
No SDKs available
No versions available
TTSWit Class
Meta::WitAi::TTS::Integrations::TTSWit extends Meta.WitAi.TTS.TTSService.
Meta::WitAi::TTS::Integrations::TTSWit extends Meta.WitAi.TTS.Interfaces.ITTSVoiceProvider.
Meta::WitAi::TTS::Integrations::TTSWit extends Meta.WitAi.TTS.Interfaces.ITTSWebHandler.
Meta::WitAi::TTS::Integrations::TTSWit extends Meta.WitAi.Interfaces.IWitConfigurationProvider.
Meta::WitAi::TTS::Integrations::TTSWit extends Meta.WitAi.Interfaces.IWitConfigurationSetter.
Overview
Data Fields
override ITTSVoiceProvider | VoiceProvider[Get] The voice provider used for preset voice settings. Uses TTSWit with TTSWitVoiceSettings |
override ITTSWebHandler | WebHandler[Get] This script provides web request handling |
WebRequestEvents[Get] | |
RequestSettings[Get] | |
VoiceDefaultSettings[Get] |
Properties
override ITTSRuntimeCacheHandler | RuntimeCacheHandler[Get] Generates a runtime cache if one is not found |
override ITTSDiskCacheHandler | DiskCacheHandler[Get] Uses the local disk cache if found |
Configuration[Get] The configuration to be updated | |
WebStreamEvents[Get] | |
WebDownloadEvents[Get] | |
PresetVoiceSettings[Get] |
Events
Action< WitConfiguration > | Callback following configuration change |
Object Data
override AudioType | GetAudioType ( ) |
override bool | GetShouldAudioStream ( AudioType audioType ) |
override bool | ShouldUseEvents ( AudioType audioType ) |
override void | OnEnable ( ) Attempt to instantiate web socket adapter |
void | Refreshes client provider on web socket settings |
override void | OnDisable ( ) Ensures web socket adapter disconnects from the client |
Public Member Functions
override string | GetInvalidError ( ) Returns error if invalid |
string | GetWebErrors ( TTSClipData clipData ) Method for determining if there are problems that will arise with performing a web request prior to doing so |
void | RequestStreamFromWeb ( TTSClipData clipData ) Method for performing a web load request |
bool | CancelWebStream ( TTSClipData clipData ) Cancel web stream |
void | Method for performing a web load request |
bool | Method for cancelling a running load request |
Details
Fields
| override ITTSVoiceProvider Meta.WitAi.TTS.Integrations.TTSWit.VoiceProvider |
|---|
The voice provider used for preset voice settings. Uses TTSWit with TTSWitVoiceSettings |
| override ITTSWebHandler Meta.WitAi.TTS.Integrations.TTSWit.WebHandler |
|---|
This script provides web request handling |
| TTSWebRequestEvents Meta.WitAi.TTS.Integrations.TTSWit.WebRequestEvents |
|---|
No description available.
|
| TTSWitRequestSettings Meta.WitAi.TTS.Integrations.TTSWit.RequestSettings |
|---|
No description available.
|
| TTSWitVoiceSettings [] Meta.WitAi.TTS.Integrations.TTSWit.PresetWitVoiceSettings |
|---|
No description available.
|
| TTSVoiceSettings Meta.WitAi.TTS.Integrations.TTSWit.VoiceDefaultSettings |
|---|
No description available.
|
Properties
| override ITTSRuntimeCacheHandler Meta.WitAi.TTS.Integrations.TTSWit.RuntimeCacheHandler |
|---|
Generates a runtime cache if one is not found |
| override ITTSDiskCacheHandler Meta.WitAi.TTS.Integrations.TTSWit.DiskCacheHandler |
|---|
Uses the local disk cache if found |
| WitConfiguration Meta.WitAi.TTS.Integrations.TTSWit.Configuration |
|---|
The configuration to be updated |
| TTSStreamEvents Meta.WitAi.TTS.Integrations.TTSWit.WebStreamEvents |
|---|
No description available.
|
| TTSDownloadEvents Meta.WitAi.TTS.Integrations.TTSWit.WebDownloadEvents |
|---|
No description available.
|
| TTSVoiceSettings [] Meta.WitAi.TTS.Integrations.TTSWit.PresetVoiceSettings |
|---|
No description available.
|
Events
| Action<WitConfiguration> Meta.WitAi.TTS.Integrations.TTSWit.OnConfigurationUpdated ( ) |
|---|
Callback following configuration change |
Object Data
| override AudioType Meta.WitAi.TTS.Integrations.TTSWit.GetAudioType ( ) |
|---|
No description available.
|
| override bool Meta.WitAi.TTS.Integrations.TTSWit.GetShouldAudioStream ( AudioType audioType ) |
|---|
No description available.
|
| override bool Meta.WitAi.TTS.Integrations.TTSWit.ShouldUseEvents ( AudioType audioType ) |
|---|
No description available.
|
| override void Meta.WitAi.TTS.Integrations.TTSWit.OnEnable ( ) |
|---|
Attempt to instantiate web socket adapter |
| virtual void Meta.WitAi.TTS.Integrations.TTSWit.RefreshWebSocketSettings ( ) |
|---|
Refreshes client provider on web socket settings |
| override void Meta.WitAi.TTS.Integrations.TTSWit.OnDisable ( ) |
|---|
Ensures web socket adapter disconnects from the client |
Member Functions
| override string Meta.WitAi.TTS.Integrations.TTSWit.GetInvalidError ( ) |
|---|
Returns error if invalid |
| string Meta.WitAi.TTS.Integrations.TTSWit.GetWebErrors ( TTSClipData clipData ) |
|---|
Method for determining if there are problems that will arise with performing a web request prior to doing so Parameters clipData The clip data to be used for the request Returns Invalid error(s). It will be empty if there are none |
| void Meta.WitAi.TTS.Integrations.TTSWit.RequestStreamFromWeb ( TTSClipData clipData ) |
|---|
Method for performing a web load request Parameters clipData Clip request data |
| bool Meta.WitAi.TTS.Integrations.TTSWit.CancelWebStream ( TTSClipData clipData ) |
|---|
Cancel web stream Parameters clipID Unique clip id |
| void Meta.WitAi.TTS.Integrations.TTSWit.RequestDownloadFromWeb ( TTSClipData clipData, string downloadPath ) |
|---|
Method for performing a web load request Parameters clipData Clip request data downloadPathPath to save clip |
| bool Meta.WitAi.TTS.Integrations.TTSWit.CancelWebDownload ( TTSClipData clipData, string downloadPath ) |
|---|
Method for cancelling a running load request Parameters clipData Clip request data |
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta