API reference

DictationService Class

Implements Meta.WitAi.Dictation.IDictationService, Meta.WitAi.Interfaces.IAudioEventProvider, Meta.WitAi.Interfaces.ITranscriptionEventProvider

Protected Fields

dictationEvents : DictationEvents	summary> Internal events used to report telemetry. These events are reserved for internal use only and should not be used for any other purpose. Signature DictationEvents Meta.WitAi.Dictation.DictationService.dictationEvents
telemetryEvents : TelemetryEvents	Signature TelemetryEvents Meta.WitAi.Dictation.DictationService.telemetryEvents

Fields

AudioEvents : IAudioInputEvents	A subset of events around collection of audio data Signature IAudioInputEvents Meta.WitAi.Dictation.DictationService.AudioEvents
IsRequestActive : bool	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. Signature virtual bool Meta.WitAi.Dictation.DictationService.IsRequestActive
TranscriptionEvents : ITranscriptionEvent	A subset of events around receiving transcriptions Signature ITranscriptionEvent Meta.WitAi.Dictation.DictationService.TranscriptionEvents

Protected Properties

ShouldSendMicData : abstract bool

[Get]

Returns true if the audio input should be read in an activation

Signature

abstract bool Meta.WitAi.Dictation.DictationService.ShouldSendMicData

Properties

DictationEvents : DictationEvents [Get][Set]	Signature virtual DictationEvents Meta.WitAi.Dictation.DictationService.DictationEvents
MicActive : abstract bool [Get]	Returns true if this voice service is currently reading data from the microphone Signature abstract bool Meta.WitAi.Dictation.DictationService.MicActive
TelemetryEvents : TelemetryEvents [Get][Set]	Signature TelemetryEvents Meta.WitAi.Dictation.DictationService.TelemetryEvents
TranscriptionProvider : abstract ITranscriptionProvider [Get][Set]	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 Signature abstract ITranscriptionProvider Meta.WitAi.Dictation.DictationService.TranscriptionProvider

Protected Methods

Awake ()	Signature virtual void Meta.WitAi.Dictation.DictationService.Awake() Returns `void`
GetSpeechEvents ()	If applicable, get all speech events Signature override SpeechEvents Meta.WitAi.Dictation.DictationService.GetSpeechEvents() Returns `override SpeechEvents`

Methods

Activate ()	Activate the microphone and send data for NLU processing. Includes optional additional request parameters like dynamic entities and maximum results. Signature void Meta.WitAi.Dictation.DictationService.Activate() Returns `void`
Activate ( requestOptions )	Activate the microphone and send data for NLU processing. Includes optional additional request parameters like dynamic entities and maximum results. Signature void Meta.WitAi.Dictation.DictationService.Activate(WitRequestOptions requestOptions) Parameters `requestOptions: WitRequestOptions` Additional options such as custom request id Returns `void`
Activate ( requestEvents )	Activate the microphone and send data for NLU processing. Includes optional additional request parameters like dynamic entities and maximum results. Signature VoiceServiceRequest Meta.WitAi.Dictation.DictationService.Activate(VoiceServiceRequestEvents requestEvents) Parameters `requestEvents: VoiceServiceRequestEvents` Returns `VoiceServiceRequest`
Activate ( requestOptions , requestEvents )	Activate the microphone and send data for NLU processing. Includes optional additional request parameters like dynamic entities and maximum results. Signature abstract VoiceServiceRequest Meta.WitAi.Dictation.DictationService.Activate(WitRequestOptions requestOptions, VoiceServiceRequestEvents requestEvents) Parameters `requestOptions: WitRequestOptions` Additional options such as custom request id `requestEvents: VoiceServiceRequestEvents` Events specific to the request's lifecycle Returns `abstract VoiceServiceRequest`
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. Signature void Meta.WitAi.Dictation.DictationService.ActivateImmediately() Returns `void`
ActivateImmediately ( 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. Signature void Meta.WitAi.Dictation.DictationService.ActivateImmediately(WitRequestOptions requestOptions) Parameters `requestOptions: WitRequestOptions` Additional options such as custom request id Returns `void`
ActivateImmediately ( 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. Signature VoiceServiceRequest Meta.WitAi.Dictation.DictationService.ActivateImmediately(VoiceServiceRequestEvents requestEvents) Parameters `requestEvents: VoiceServiceRequestEvents` Returns `VoiceServiceRequest`
ActivateImmediately ( requestOptions , 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. Signature abstract VoiceServiceRequest Meta.WitAi.Dictation.DictationService.ActivateImmediately(WitRequestOptions requestOptions, VoiceServiceRequestEvents requestEvents) Parameters `requestOptions: WitRequestOptions` Additional options such as custom request id `requestEvents: VoiceServiceRequestEvents` Events specific to the request's lifecycle Returns `abstract VoiceServiceRequest`
Cancel ()	Cancels the current transcription. No FullTranscription event will fire. Signature abstract void Meta.WitAi.Dictation.DictationService.Cancel() Returns `abstract void`