API reference
DictationService Class
Protected Fields
DictationEvents dictationEvents[Get]
summary> Internal events used to report telemetry. These events are reserved for internal use only and should not be used for any other purpose.
TelemetryEvents telemetryEvents[Get]
Fields
bool IsRequestActive[Get]
Returns true if the service is actively communicating with Wit.ai during an Activation. The mic may or may not still be active while this is true.
IAudioInputEvents AudioEvents[Get]
A subset of events around collection of audio data
ITranscriptionEvent TranscriptionEvents[Get]
A subset of events around receiving transcriptions
Properties
abstract 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
abstract bool MicActive[Get]
Returns true if this voice service is currently reading data from the microphone
DictationEvents DictationEvents[Get]
TelemetryEvents TelemetryEvents[Get]
abstract bool ShouldSendMicData[Get]
Returns true if the audio input should be read in an activation
Protected Functions
virtual override SpeechEvents GetSpeechEvents ( )
If applicable, get all speech events
virtual void Awake ( )
Member Functions
void Activate ( )
Activate the microphone and send data for NLU processing. Includes optional additional request parameters like dynamic entities and maximum results.
void Activate
( WitRequestOptions requestOptions )
Activate the microphone and send data for NLU processing. Includes optional additional request parameters like dynamic entities and maximum results.
Parameters
requestOptions
Additional options such as custom request id
VoiceServiceRequest Activate
( VoiceServiceRequestEvents requestEvents )
Activate the microphone and send data for NLU processing. Includes optional additional request parameters like dynamic entities and maximum results.
Parameters
requestOptions
Additional options such as custom request id
abstract VoiceServiceRequest Activate
( WitRequestOptions requestOptions,
VoiceServiceRequestEvents requestEvents )
Activate the microphone and send data for NLU processing. Includes optional additional request parameters like dynamic entities and maximum results.
Parameters
requestOptions
Additional options such as custom request id
requestEvents
Events specific to the request's lifecycle
void ActivateImmediately ( )
Activate the microphone and send data for NLU processing immediately without waiting for sound/speech from the user to begin. Includes optional additional request parameters like dynamic entities and maximum results.
void ActivateImmediately
( WitRequestOptions requestOptions )
Activate the microphone and send data for NLU processing immediately without waiting for sound/speech from the user to begin. Includes optional additional request parameters like dynamic entities and maximum results.
Parameters
requestOptions
Additional options such as custom request id
VoiceServiceRequest ActivateImmediately
( VoiceServiceRequestEvents requestEvents )
Activate the microphone and send data for NLU processing immediately without waiting for sound/speech from the user to begin. Includes optional additional request parameters like dynamic entities and maximum results.
Parameters
requestOptions
Additional options such as custom request id
abstract VoiceServiceRequest ActivateImmediately
( WitRequestOptions requestOptions,
VoiceServiceRequestEvents requestEvents )
Activate the microphone and send data for NLU processing immediately without waiting for sound/speech from the user to begin. Includes optional additional request parameters like dynamic entities and maximum results.
Parameters
requestOptions
Additional options such as custom request id
requestEvents
Events specific to the request's lifecycle
abstract void Cancel ( )
Cancels the current transcription. No FullTranscription event will fire.
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