API reference
API reference
Select your platform
No SDKs available
No versions available
BaseSpeechService Class
A simple base class for wrapping VoiceServiceRequest event callbacks
Meta::WitAi::BaseSpeechService extends MonoBehaviour.
Overview
Data Fields
bool | ShouldWrap[Get] Whether this script should wrap all request event setups |
bool | ShouldLog[Get] Whether this script should log |
bool | Active[Get] Returns true if this voice service is currently active, listening with the mic or performing a networked request |
Properties
HashSet< VoiceServiceRequest > | Requests[Get] All currently running requests |
bool | IsAudioInputActive[Get] Returns true if this voice service is currently active, listening with the mic or performing a networked request |
Object Data
GetSpeechEvents ( ) If applicable, get all speech events | |
GetAudioRequest ( ) Get the first running audio request | |
void | OnEnable ( ) On enable, begin watching for request initialized callbacks |
void | OnDisable ( ) On enable, stop watching for request initialized callbacks |
void | |
void | OnRequestInit ( VoiceServiceRequest request ) |
void | OnRequestStartListening ( VoiceServiceRequest request ) |
void | OnRequestStopListening ( VoiceServiceRequest request ) |
void | OnRequestSend ( VoiceServiceRequest request ) |
void | |
void | OnRequestPartialTranscription ( VoiceServiceRequest request ) |
void | OnRequestFullTranscription ( VoiceServiceRequest request ) |
void | OnRequestPartialResponse ( VoiceServiceRequest request ) |
void | OnRequestCancel ( VoiceServiceRequest request ) |
void | OnRequestFailed ( VoiceServiceRequest request ) |
void | OnRequestSuccess ( VoiceServiceRequest request ) |
void | OnRequestComplete ( VoiceServiceRequest request ) |
void | Adds or removes event listeners for every request event callback |
Public Member Functions
string | Check for error that will occur if attempting to activate audio |
bool | CanActivateAudio ( ) Whether an audio request can be started or not |
string | GetSendError ( ) Check for error that will occur if attempting to send data |
bool | CanSend ( ) Whether a voice service request can be sent or not |
void | Deactivate ( ) Deactivate all requests |
void | Deactivate ( VoiceServiceRequest request ) Deactivate a specific request |
void | Deactivate and abort all requests |
void | DeactivateAndAbortRequest ( VoiceServiceRequest request ) Deactivate and abort a specific requests |
void | Method to setup request events with provided base events |
bool | WrapRequest ( VoiceServiceRequest request ) Accepts a generated voice service request, wraps all request events & returns local methods for each |
Details
Fields
| bool Meta.WitAi.BaseSpeechService.ShouldWrap |
|---|
Whether this script should wrap all request event setups |
| bool Meta.WitAi.BaseSpeechService.ShouldLog |
|---|
Whether this script should log |
| virtual bool Meta.WitAi.BaseSpeechService.Active |
|---|
Returns true if this voice service is currently active, listening with the mic or performing a networked request |
Properties
| HashSet<VoiceServiceRequest> Meta.WitAi.BaseSpeechService.Requests |
|---|
All currently running requests |
| virtual bool Meta.WitAi.BaseSpeechService.IsAudioInputActive |
|---|
Returns true if this voice service is currently active, listening with the mic or performing a networked request |
Object Data
| virtual SpeechEvents Meta.WitAi.BaseSpeechService.GetSpeechEvents ( ) |
|---|
If applicable, get all speech events |
| virtual VoiceServiceRequest Meta.WitAi.BaseSpeechService.GetAudioRequest ( ) |
|---|
Get the first running audio request |
| virtual void Meta.WitAi.BaseSpeechService.OnEnable ( ) |
|---|
On enable, begin watching for request initialized callbacks |
| virtual void Meta.WitAi.BaseSpeechService.OnDisable ( ) |
|---|
On enable, stop watching for request initialized callbacks |
| virtual void Meta.WitAi.BaseSpeechService.Log ( VoiceServiceRequest request, string log, bool warn ) |
|---|
No description available.
|
| virtual void Meta.WitAi.BaseSpeechService.OnRequestInit ( VoiceServiceRequest request ) |
|---|
No description available.
|
| virtual void Meta.WitAi.BaseSpeechService.OnRequestStartListening ( VoiceServiceRequest request ) |
|---|
No description available.
|
| virtual void Meta.WitAi.BaseSpeechService.OnRequestStopListening ( VoiceServiceRequest request ) |
|---|
No description available.
|
| virtual void Meta.WitAi.BaseSpeechService.OnRequestSend ( VoiceServiceRequest request ) |
|---|
No description available.
|
| virtual void Meta.WitAi.BaseSpeechService.OnRequestRawResponse ( VoiceServiceRequest request, string rawResponse ) |
|---|
No description available.
|
| virtual void Meta.WitAi.BaseSpeechService.OnRequestPartialTranscription ( VoiceServiceRequest request ) |
|---|
No description available.
|
| virtual void Meta.WitAi.BaseSpeechService.OnRequestFullTranscription ( VoiceServiceRequest request ) |
|---|
No description available.
|
| virtual void Meta.WitAi.BaseSpeechService.OnRequestPartialResponse ( VoiceServiceRequest request ) |
|---|
No description available.
|
| virtual void Meta.WitAi.BaseSpeechService.OnRequestCancel ( VoiceServiceRequest request ) |
|---|
No description available.
|
| virtual void Meta.WitAi.BaseSpeechService.OnRequestFailed ( VoiceServiceRequest request ) |
|---|
No description available.
|
| virtual void Meta.WitAi.BaseSpeechService.OnRequestSuccess ( VoiceServiceRequest request ) |
|---|
No description available.
|
| virtual void Meta.WitAi.BaseSpeechService.OnRequestComplete ( VoiceServiceRequest request ) |
|---|
No description available.
|
| virtual void Meta.WitAi.BaseSpeechService.SetEventListeners ( VoiceServiceRequest request, bool addListeners ) |
|---|
Adds or removes event listeners for every request event callback Parameters request The request to begin or stop listening to addListenersIf true, adds listeners and if false, removes listeners. |
Member Functions
| virtual string Meta.WitAi.BaseSpeechService.GetActivateAudioError ( ) |
|---|
Check for error that will occur if attempting to activate audio Returns Returns an error audio activation should not be allowed. |
| virtual bool Meta.WitAi.BaseSpeechService.CanActivateAudio ( ) |
|---|
Whether an audio request can be started or not |
| virtual string Meta.WitAi.BaseSpeechService.GetSendError ( ) |
|---|
Check for error that will occur if attempting to send data Returns Returns an error if send will not be allowed. |
| virtual bool Meta.WitAi.BaseSpeechService.CanSend ( ) |
|---|
Whether a voice service request can be sent or not |
| virtual void Meta.WitAi.BaseSpeechService.Deactivate ( ) |
|---|
Deactivate all requests |
| virtual void Meta.WitAi.BaseSpeechService.Deactivate ( VoiceServiceRequest request ) |
|---|
Deactivate a specific request |
| virtual void Meta.WitAi.BaseSpeechService.DeactivateAndAbortRequest ( ) |
|---|
Deactivate and abort all requests |
| virtual void Meta.WitAi.BaseSpeechService.DeactivateAndAbortRequest ( VoiceServiceRequest request ) |
|---|
Deactivate and abort a specific requests |
| virtual void Meta.WitAi.BaseSpeechService.SetupRequestParameters ( ref WitRequestOptions options, ref VoiceServiceRequestEvents events ) |
|---|
Method to setup request events with provided base events Parameters events Generate request events if empty |
| virtual bool Meta.WitAi.BaseSpeechService.WrapRequest ( VoiceServiceRequest request ) |
|---|
Accepts a generated voice service request, wraps all request events & returns local methods for each Parameters request The provided VoiceServiceRequest to be tracked Returns Returns false if wrap fails |
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