API reference
API reference
Select your platform
No SDKs available
No versions available

IVoiceActivationHandler Interface

Properties

Active : bool
[Get]
Returns true if this voice service is currently active and listening with the mic
Signature 
bool Meta.WitAi.IVoiceActivationHandler.Active

Methods

Activate ( text , requestOptions , requestEvents )
Send text data for NLU processing with custom request options & events.
Signature 
Task<VoiceServiceRequest> Meta.WitAi.IVoiceActivationHandler.Activate(string text, WitRequestOptions requestOptions, VoiceServiceRequestEvents requestEvents)
Parameters
text: string  Text to be used for NLU processing
requestOptions: WitRequestOptions  Additional options such as dynamic entities
requestEvents: VoiceServiceRequestEvents Events specific to the request's lifecycle
Returns
Task< VoiceServiceRequest >
Activate ( requestOptions , requestEvents )
Activate the microphone and wait for threshold and then send data
Signature 
VoiceServiceRequest Meta.WitAi.IVoiceActivationHandler.Activate(WitRequestOptions requestOptions, VoiceServiceRequestEvents requestEvents)
Parameters
requestOptions: WitRequestOptions  Additional options such as dynamic entities
requestEvents: VoiceServiceRequestEvents Events specific to the request's lifecycle
Returns
VoiceServiceRequest
ActivateImmediately ( requestOptions , requestEvents )
Activate the microphone and send data for NLU processing with custom request options.
Signature 
VoiceServiceRequest Meta.WitAi.IVoiceActivationHandler.ActivateImmediately(WitRequestOptions requestOptions, VoiceServiceRequestEvents requestEvents)
Parameters
requestOptions: WitRequestOptions  Additional options such as dynamic entities
requestEvents: VoiceServiceRequestEvents Events specific to the request's lifecycle
Returns
VoiceServiceRequest
Deactivate ()
Stop listening and submit the collected microphone data for processing.
Signature 
void Meta.WitAi.IVoiceActivationHandler.Deactivate()
Returns
void
DeactivateAndAbortRequest ()
Stop listening and abort any requests that may be active without waiting for a response.
Signature 
void Meta.WitAi.IVoiceActivationHandler.DeactivateAndAbortRequest()
Returns
void
DeactivateAndAbortRequest ( request )
Deactivate mic & abort a specific request
Signature 
void Meta.WitAi.IVoiceActivationHandler.DeactivateAndAbortRequest(VoiceServiceRequest request)
Parameters
request: VoiceServiceRequest
Returns
void
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta