API reference
WitService Class
Extends MonoBehaviour, IVoiceEventProvider, IVoiceActivationHandler, ITelemetryEventsProvider, IWitRuntimeConfigProvider, IWitConfigurationProvider
Properties
IVLogger _log[Get]
IPubSubAdapter PubSub[Get]
Access pub sub
bool IsRequestActive[Get]
Active if recording, transmitting, or queued up
IVoiceEventProvider VoiceEventProvider[Get]
ITelemetryEventsProvider TelemetryEventsProvider[Get]
IWitRuntimeConfigProvider ConfigurationProvider[Get]
ITranscriptionProvider TranscriptionProvider[Get]
Gets/Sets a custom transcription provider. This can be used to replace any built in asr with an on device model or other provided source
IVoiceServiceRequestProvider RequestProvider[Get]
Generic voice service request provider
Fields
WitConfiguration Configuration[Get]
bool Active[Get]
Returns true if wit is currently active and listening with the mic
WitRuntimeConfiguration RuntimeConfiguration[Get]
VoiceEvents VoiceEvents[Get]
TelemetryEvents TelemetryEvents[Get]
bool MicActive[Get]
Protected Fields
bool ShouldSendMicData[Get]
Member Functions
virtual bool IsConfigurationValid ( )
Check configuration, client access token & app id
void HandleWebSocketRequestGeneration
( IWitWebSocketRequest webSocketRequest )
Handle web socket request if possible
void Activate ( )
Activate the microphone and send data to Wit for NLU processing.
void Activate
( WitRequestOptions requestOptions )
VoiceServiceRequest Activate
( WitRequestOptions requestOptions,
VoiceServiceRequestEvents requestEvents )
Activate the microphone and wait for threshold and then send data
Parameters
requestOptions
Additional options such as dynamic entities
requestEvents
Events specific to the request's lifecycle
void ActivateImmediately ( )
Activate the microphone and immediately send data to Wit for NLU processing.
void ActivateImmediately
( WitRequestOptions requestOptions )
VoiceServiceRequest ActivateImmediately
( WitRequestOptions requestOptions,
VoiceServiceRequestEvents requestEvents )
Activate the microphone and send data for NLU processing with custom request options.
Parameters
requestOptions
Additional options such as dynamic entities
requestEvents
Events specific to the request's lifecycle
void ExecuteRequest
( VoiceServiceRequest newRequest )
Execute a wit request immediately
Parameters
recordingRequest
void Activate
( string text )
Activate the microphone and send data to Wit for NLU processing.
void Activate
( string text,
WitRequestOptions requestOptions )
Task< VoiceServiceRequest > Activate
( string text,
WitRequestOptions requestOptions,
VoiceServiceRequestEvents requestEvents )
Send text data for NLU processing with custom request options & events.
Parameters
text
Text to be used for NLU processing
requestOptions
Additional options such as dynamic entities
requestEvents
Events specific to the request's lifecycle
void Deactivate ( )
Stop listening and submit the collected microphone data to wit for processing.
void DeactivateAndAbortRequest
( VoiceServiceRequest request )
Stop listening and cancel a specific report
void DeactivateAndAbortRequest ( )
Stop listening and abort any requests that may be active without waiting for a response.
Protected Functions
void Awake ( )
void OnEnable ( )
void OnDisable ( )
virtual void RefreshConfigurationSettings ( )
Method called whenever the OnConfigurationUpdated action is invoked to re-init all runtime configuration based setup.
virtual void OnSceneLoaded
( Scene scene,
LoadSceneMode mode )
void SetMicDelegates
( bool add )
virtual void SendRecordingRequest ( )
Sends recording request if possible
void SetupRequest
( VoiceServiceRequest newRequest )
Setup recording request
Parameters
recordingRequest
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2026 Meta