API reference

BaseSpeechService Class

Extends MonoBehaviour
A simple base class for wrapping VoiceServiceRequest event callbacks

Fields

Active : bool
Returns true if this voice service is currently active, listening with the mic or performing a networked request
Signature 
virtual bool Meta.WitAi.BaseSpeechService.Active
ShouldLog : bool
Whether this script should log
Signature 
bool Meta.WitAi.BaseSpeechService.ShouldLog
ShouldWrap : bool
Whether this script should wrap all request event setups
Signature 
bool Meta.WitAi.BaseSpeechService.ShouldWrap

Properties

IsAudioInputActive : bool
[Get]
Returns true if this voice service is currently active, listening with the mic or performing a networked request
Signature 
virtual bool Meta.WitAi.BaseSpeechService.IsAudioInputActive
Logger : IVLogger
[Get]
Signature 
IVLogger Meta.WitAi.BaseSpeechService.Logger
Requests : HashSet< VoiceServiceRequest >
[Get]
All currently running requests
Signature 
HashSet<VoiceServiceRequest> Meta.WitAi.BaseSpeechService.Requests

Protected Methods

GetAudioRequest ()
Get the first running audio request
Signature 
virtual VoiceServiceRequest Meta.WitAi.BaseSpeechService.GetAudioRequest()
Returns
VoiceServiceRequest
GetSpeechEvents ()
If applicable, get all speech events
Signature 
virtual SpeechEvents Meta.WitAi.BaseSpeechService.GetSpeechEvents()
Returns
SpeechEvents
Log ( request , log , warn )
Signature 
virtual void Meta.WitAi.BaseSpeechService.Log(VoiceServiceRequest request, string log, bool warn=false)
Parameters
request: VoiceServiceRequest
log: string
warn: bool
Returns
void
OnDisable ()
On enable, stop watching for request initialized callbacks
Signature 
virtual void Meta.WitAi.BaseSpeechService.OnDisable()
Returns
void
OnEnable ()
On enable, begin watching for request initialized callbacks
Signature 
virtual void Meta.WitAi.BaseSpeechService.OnEnable()
Returns
void
OnRequestCancel ( request )
Signature 
virtual void Meta.WitAi.BaseSpeechService.OnRequestCancel(VoiceServiceRequest request)
Parameters
request: VoiceServiceRequest
Returns
void
OnRequestComplete ( request )
Signature 
virtual void Meta.WitAi.BaseSpeechService.OnRequestComplete(VoiceServiceRequest request)
Parameters
request: VoiceServiceRequest
Returns
void
OnRequestFailed ( request )
Signature 
virtual void Meta.WitAi.BaseSpeechService.OnRequestFailed(VoiceServiceRequest request)
Parameters
request: VoiceServiceRequest
Returns
void
OnRequestFullTranscription ( request , transcription )
Signature 
virtual void Meta.WitAi.BaseSpeechService.OnRequestFullTranscription(VoiceServiceRequest request, string transcription)
Parameters
request: VoiceServiceRequest
transcription: string
Returns
void
OnRequestInit ( request )
Signature 
virtual void Meta.WitAi.BaseSpeechService.OnRequestInit(VoiceServiceRequest request)
Parameters
request: VoiceServiceRequest
Returns
void
OnRequestPartialResponse ( request , responseData )
Signature 
virtual void Meta.WitAi.BaseSpeechService.OnRequestPartialResponse(VoiceServiceRequest request, WitResponseNode responseData)
Parameters
request: VoiceServiceRequest
responseData: WitResponseNode
Returns
void
OnRequestPartialTranscription ( request , transcription )
Signature 
virtual void Meta.WitAi.BaseSpeechService.OnRequestPartialTranscription(VoiceServiceRequest request, string transcription)
Parameters
request: VoiceServiceRequest
transcription: string
Returns
void
OnRequestRawResponse ( request , rawResponse )
Signature 
virtual void Meta.WitAi.BaseSpeechService.OnRequestRawResponse(VoiceServiceRequest request, string rawResponse)
Parameters
request: VoiceServiceRequest
rawResponse: string
Returns
void
OnRequestSend ( request )
Signature 
virtual void Meta.WitAi.BaseSpeechService.OnRequestSend(VoiceServiceRequest request)
Parameters
request: VoiceServiceRequest
Returns
void
OnRequestStartListening ( request )
Signature 
virtual void Meta.WitAi.BaseSpeechService.OnRequestStartListening(VoiceServiceRequest request)
Parameters
request: VoiceServiceRequest
Returns
void
OnRequestStopListening ( request )
Signature 
virtual void Meta.WitAi.BaseSpeechService.OnRequestStopListening(VoiceServiceRequest request)
Parameters
request: VoiceServiceRequest
Returns
void
OnRequestSuccess ( request )
Signature 
virtual void Meta.WitAi.BaseSpeechService.OnRequestSuccess(VoiceServiceRequest request)
Parameters
request: VoiceServiceRequest
Returns
void
SetEventListeners ( request , addListeners )
Adds or removes event listeners for every request event callback
Signature 
virtual void Meta.WitAi.BaseSpeechService.SetEventListeners(VoiceServiceRequest request, bool addListeners)
Parameters
request: VoiceServiceRequest  The request to begin or stop listening to
addListeners: bool  If true, adds listeners and if false, removes listeners.
Returns
void

Methods

CanActivateAudio ()
Whether an audio request can be started or not
Signature 
virtual bool Meta.WitAi.BaseSpeechService.CanActivateAudio()
Returns
bool
CanSend ()
Whether a voice service request can be sent or not
Signature 
virtual bool Meta.WitAi.BaseSpeechService.CanSend()
Returns
bool
Deactivate ()
Deactivate all requests
Signature 
virtual void Meta.WitAi.BaseSpeechService.Deactivate()
Returns
void
Deactivate ( request )
Deactivate a specific request
Signature 
virtual void Meta.WitAi.BaseSpeechService.Deactivate(VoiceServiceRequest request)
Parameters
request: VoiceServiceRequest
Returns
void
DeactivateAndAbortRequest ()
Deactivate and abort all locally originated requests
Signature 
virtual void Meta.WitAi.BaseSpeechService.DeactivateAndAbortRequest()
Returns
void
DeactivateAndAbortRequest ( request )
Deactivate and abort a specific requests
Signature 
virtual void Meta.WitAi.BaseSpeechService.DeactivateAndAbortRequest(VoiceServiceRequest request)
Parameters
request: VoiceServiceRequest
Returns
void
GetActivateAudioError ()
Check for error that will occur if attempting to activate audio
Signature 
virtual string Meta.WitAi.BaseSpeechService.GetActivateAudioError()
Returns
string  Returns an error audio activation should not be allowed.
GetSendError ()
Check for error that will occur if attempting to send data
Signature 
virtual string Meta.WitAi.BaseSpeechService.GetSendError()
Returns
string  Returns an error if send will not be allowed.
SetupRequestParameters ( options , events )
Method to setup request events with provided base events
Signature 
virtual void Meta.WitAi.BaseSpeechService.SetupRequestParameters(ref WitRequestOptions options, ref VoiceServiceRequestEvents events)
Parameters
options: ref WitRequestOptions
events: ref VoiceServiceRequestEvents  Generate request events if empty
Returns
void
WrapRequest ( request )
Accepts a generated voice service request, wraps all request events & returns local methods for each
Signature 
virtual bool Meta.WitAi.BaseSpeechService.WrapRequest(VoiceServiceRequest request)
Parameters
request: VoiceServiceRequest  The provided VoiceServiceRequest to be tracked
Returns
bool  Returns false if wrap fails
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta