VoiceService Class

Extends Meta.WitAi.BaseSpeechService, Meta.Conduit.IInstanceResolver

Implements Meta.WitAi.IVoiceService, Meta.WitAi.Interfaces.IAudioEventProvider

Constructors

VoiceService ()

Constructs a VoiceService

Signature

Meta.WitAi.VoiceService.VoiceService()

Protected Fields

_waitingForFirstPartialAudio : bool	Signature bool Meta.WitAi.VoiceService._waitingForFirstPartialAudio
events : VoiceEvents	This field should not be accessed outside the Wit-Unity library. If you need access to events you should be using the VoiceService.VoiceEvents property instead. 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 VoiceEvents Meta.WitAi.VoiceService.events
telemetryEvents : TelemetryEvents	Signature TelemetryEvents Meta.WitAi.VoiceService.telemetryEvents

Fields

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

Protected Properties

ShouldSendMicData : abstract bool

[Get]

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

Signature

abstract bool Meta.WitAi.VoiceService.ShouldSendMicData

Properties

ConduitDispatcher : IConduitDispatcher [Get][Set]	The Conduit-based dispatcher that dispatches incoming invocations based on a manifest. Signature IConduitDispatcher Meta.WitAi.VoiceService.ConduitDispatcher
MicActive : abstract bool [Get]	Returns true if this voice service is currently reading data from the microphone Signature abstract bool Meta.WitAi.VoiceService.MicActive
TelemetryEvents : TelemetryEvents [Get][Set]	Signature virtual TelemetryEvents Meta.WitAi.VoiceService.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.VoiceService.TranscriptionProvider
UsePlatformIntegrations : bool [Get][Set]	When set to true, the service will use platform integration. Signature virtual bool Meta.WitAi.VoiceService.UsePlatformIntegrations
VoiceEvents : VoiceEvents [Get][Set]	Signature virtual VoiceEvents Meta.WitAi.VoiceService.VoiceEvents
WitConfiguration : WitConfiguration [Get][Set]	Wit configuration accessor via IWitConfigurationProvider Signature WitConfiguration Meta.WitAi.VoiceService.WitConfiguration

Protected Methods

Awake ()	Signature virtual void Meta.WitAi.VoiceService.Awake() Returns `void`
GetSpeechEvents ()	If applicable, get all speech events Signature override SpeechEvents Meta.WitAi.VoiceService.GetSpeechEvents() Returns `override SpeechEvents`
HandleResponse ( response )	Signature virtual void Meta.WitAi.VoiceService.HandleResponse(WitResponseNode response) Parameters `response: WitResponseNode` Returns `void`
OnDisable ()	On enable, stop watching for request initialized callbacks Signature override void Meta.WitAi.VoiceService.OnDisable() Returns `override void`
OnEnable ()	On enable, begin watching for request initialized callbacks Signature override void Meta.WitAi.VoiceService.OnEnable() Returns `override void`
OnFinalTranscription ( transcription )	Activate message if transcription provider returns a final transcription Signature virtual void Meta.WitAi.VoiceService.OnFinalTranscription(string transcription) Parameters `transcription: string` Returns `void`
OnRequestPartialResponse ( request , responseNode )	Signature override void Meta.WitAi.VoiceService.OnRequestPartialResponse(VoiceServiceRequest request, WitResponseNode responseNode) Parameters `request: VoiceServiceRequest` `responseNode: WitResponseNode` Returns `override void`
OnRequestSend ( request )	Signature override void Meta.WitAi.VoiceService.OnRequestSend(VoiceServiceRequest request) Parameters `request: VoiceServiceRequest` Returns `override void`
OnValidateEarly ( request , responseNode )	Signature virtual void Meta.WitAi.VoiceService.OnValidateEarly(VoiceServiceRequest request, WitResponseNode responseNode) Parameters `request: VoiceServiceRequest` `responseNode: WitResponseNode` Returns `void`

Methods

Activate ( text )	Send text data for NLU processing. Results will return the same way a voice based activation would. Signature void Meta.WitAi.VoiceService.Activate(string text) Parameters `text: string` Text to be used for NLU processing Returns `void`
Activate ( text , requestOptions )	Send text data for NLU processing. Results will return the same way a voice based activation would. Signature Task<VoiceServiceRequest> Meta.WitAi.VoiceService.Activate(string text, WitRequestOptions requestOptions) Parameters `text: string` Text to be used for NLU processing `requestOptions: WitRequestOptions` Additional options such as dynamic entities Returns `Task< VoiceServiceRequest >`
Activate ( text , requestEvents )	Send text data for NLU processing. Results will return the same way a voice based activation would. Signature Task<VoiceServiceRequest> Meta.WitAi.VoiceService.Activate(string text, VoiceServiceRequestEvents requestEvents) Parameters `text: string` Text to be used for NLU processing `requestEvents: VoiceServiceRequestEvents` Events specific to the request's lifecycle Returns `Task< VoiceServiceRequest >`
Activate ( text , requestOptions , requestEvents )	Send text data for NLU processing with custom request options. Signature abstract Task<VoiceServiceRequest> Meta.WitAi.VoiceService.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 `abstract Task< VoiceServiceRequest >`
Activate ()	Start listening for sound or speech from the user and start sending data to Wit.ai once sound or speech has been detected. Signature void Meta.WitAi.VoiceService.Activate() Returns `void`
Activate ( requestOptions )	Start listening for sound or speech from the user and start sending data to Wit.ai once sound or speech has been detected. Signature void Meta.WitAi.VoiceService.Activate(WitRequestOptions requestOptions) Parameters `requestOptions: WitRequestOptions` Additional options such as dynamic entities Returns `void`
Activate ( requestEvents )	Start listening for sound or speech from the user and start sending data to Wit.ai once sound or speech has been detected. Signature VoiceServiceRequest Meta.WitAi.VoiceService.Activate(VoiceServiceRequestEvents requestEvents) Parameters `requestEvents: VoiceServiceRequestEvents` Events specific to the request's lifecycle Returns `VoiceServiceRequest`
Activate ( requestOptions , requestEvents )	Start listening for sound or speech from the user and start sending data to Wit.ai once sound or speech has been detected. Signature abstract VoiceServiceRequest Meta.WitAi.VoiceService.Activate(WitRequestOptions requestOptions, VoiceServiceRequestEvents requestEvents) Parameters `requestOptions: WitRequestOptions` Additional options such as dynamic entities `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. Signature void Meta.WitAi.VoiceService.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. Signature void Meta.WitAi.VoiceService.ActivateImmediately(WitRequestOptions requestOptions) Parameters `requestOptions: WitRequestOptions` Additional options such as dynamic entities Returns `void`
ActivateImmediately ( requestEvents )	Activate the microphone and send data for NLU processing immediately without waiting for sound/speech from the user to begin. Signature VoiceServiceRequest Meta.WitAi.VoiceService.ActivateImmediately(VoiceServiceRequestEvents requestEvents) Parameters `requestEvents: VoiceServiceRequestEvents` Events specific to the request's lifecycle 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. Signature abstract VoiceServiceRequest Meta.WitAi.VoiceService.ActivateImmediately(WitRequestOptions requestOptions, VoiceServiceRequestEvents requestEvents) Parameters `requestOptions: WitRequestOptions` Additional options such as dynamic entities `requestEvents: VoiceServiceRequestEvents` Events specific to the request's lifecycle Returns `abstract VoiceServiceRequest`
GetObjectsOfType ( type )	Returns objects of the specified type. Signature IEnumerable<object> Meta.WitAi.VoiceService.GetObjectsOfType(Type type) Parameters `type: Type` The type. Returns `IEnumerable< object >` Objects of the specified type.