WitService Class

Extends MonoBehaviour

Implements Meta.WitAi.IVoiceEventProvider, Meta.WitAi.IVoiceActivationHandler, Meta.WitAi.ITelemetryEventsProvider, Meta.WitAi.IWitRuntimeConfigProvider, Meta.WitAi.Interfaces.IWitConfigurationProvider

Protected Fields

ShouldSendMicData : bool

Signature

bool Meta.WitAi.WitService.ShouldSendMicData

Fields

Active : bool	Returns true if wit is currently active and listening with the mic Signature bool Meta.WitAi.WitService.Active
Configuration : WitConfiguration	Signature WitConfiguration Meta.WitAi.WitService.Configuration
MicActive : bool	Signature bool Meta.WitAi.WitService.MicActive
RuntimeConfiguration : WitRuntimeConfiguration	Signature WitRuntimeConfiguration Meta.WitAi.WitService.RuntimeConfiguration
TelemetryEvents : TelemetryEvents	Signature TelemetryEvents Meta.WitAi.WitService.TelemetryEvents
VoiceEvents : VoiceEvents	Signature VoiceEvents Meta.WitAi.WitService.VoiceEvents

Properties

_log : IVLogger [Get]	Signature IVLogger Meta.WitAi.WitService._log
ConfigurationProvider : IWitRuntimeConfigProvider [Get][Set]	Signature IWitRuntimeConfigProvider Meta.WitAi.WitService.ConfigurationProvider
IsRequestActive : bool [Get]	Active if recording, transmitting, or queued up Signature bool Meta.WitAi.WitService.IsRequestActive
PubSub : IPubSubAdapter [Get]	Access pub sub Signature IPubSubAdapter Meta.WitAi.WitService.PubSub
RequestProvider : IVoiceServiceRequestProvider [Get][Set]	Generic voice service request provider Signature IVoiceServiceRequestProvider Meta.WitAi.WitService.RequestProvider
TelemetryEventsProvider : ITelemetryEventsProvider [Get][Set]	Signature ITelemetryEventsProvider Meta.WitAi.WitService.TelemetryEventsProvider
TranscriptionProvider : 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 ITranscriptionProvider Meta.WitAi.WitService.TranscriptionProvider
VoiceEventProvider : IVoiceEventProvider [Get][Set]	Signature IVoiceEventProvider Meta.WitAi.WitService.VoiceEventProvider

Protected Methods

Awake ()	Signature void Meta.WitAi.WitService.Awake() Returns `void`
OnDisable ()	Signature void Meta.WitAi.WitService.OnDisable() Returns `void`
OnEnable ()	Signature void Meta.WitAi.WitService.OnEnable() Returns `void`
OnSceneLoaded ( scene , mode )	Signature virtual void Meta.WitAi.WitService.OnSceneLoaded(Scene scene, LoadSceneMode mode) Parameters `scene: Scene` `mode: LoadSceneMode` Returns `void`
RefreshConfigurationSettings ()	Method called whenever the OnConfigurationUpdated action is invoked to re-init all runtime configuration based setup. Signature virtual void Meta.WitAi.WitService.RefreshConfigurationSettings() Returns `void`
SendRecordingRequest ()	Sends recording request if possible Signature virtual void Meta.WitAi.WitService.SendRecordingRequest() Returns `void`
SetMicDelegates ( add )	Signature void Meta.WitAi.WitService.SetMicDelegates(bool add) Parameters `add: bool` Returns `void`
SetupRequest ( newRequest )	Setup recording request Signature void Meta.WitAi.WitService.SetupRequest(VoiceServiceRequest newRequest) Parameters `newRequest: VoiceServiceRequest` Returns `void`

Methods

Activate ()	Activate the microphone and send data to Wit for NLU processing. Signature void Meta.WitAi.WitService.Activate() Returns `void`
Activate ( requestOptions )	Signature void Meta.WitAi.WitService.Activate(WitRequestOptions requestOptions) Parameters `requestOptions: WitRequestOptions` Returns `void`
Activate ( requestOptions , requestEvents )	Activate the microphone and wait for threshold and then send data Signature VoiceServiceRequest Meta.WitAi.WitService.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`
Activate ( text )	Activate the microphone and send data to Wit for NLU processing. Signature void Meta.WitAi.WitService.Activate(string text) Parameters `text: string` Returns `void`
Activate ( text , requestOptions )	Signature void Meta.WitAi.WitService.Activate(string text, WitRequestOptions requestOptions) Parameters `text: string` `requestOptions: WitRequestOptions` Returns `void`
Activate ( text , requestOptions , requestEvents )	Send text data for NLU processing with custom request options & events. Signature Task<VoiceServiceRequest> Meta.WitAi.WitService.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 >`
ActivateImmediately ()	Activate the microphone and immediately send data to Wit for NLU processing. Signature void Meta.WitAi.WitService.ActivateImmediately() Returns `void`
ActivateImmediately ( requestOptions )	Signature void Meta.WitAi.WitService.ActivateImmediately(WitRequestOptions requestOptions) Parameters `requestOptions: WitRequestOptions` Returns `void`
ActivateImmediately ( requestOptions , requestEvents )	Activate the microphone and send data for NLU processing with custom request options. Signature VoiceServiceRequest Meta.WitAi.WitService.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 to wit for processing. Signature void Meta.WitAi.WitService.Deactivate() Returns `void`
DeactivateAndAbortRequest ( request )	Stop listening and cancel a specific report Signature void Meta.WitAi.WitService.DeactivateAndAbortRequest(VoiceServiceRequest request) Parameters `request: VoiceServiceRequest` Returns `void`
DeactivateAndAbortRequest ()	Stop listening and abort any requests that may be active without waiting for a response. Signature void Meta.WitAi.WitService.DeactivateAndAbortRequest() Returns `void`
ExecuteRequest ( newRequest )	Execute a wit request immediately Signature void Meta.WitAi.WitService.ExecuteRequest(VoiceServiceRequest newRequest) Parameters `newRequest: VoiceServiceRequest` Returns `void`
HandleWebSocketRequestGeneration ( webSocketRequest )	Handle web socket request if possible Signature void Meta.WitAi.WitService.HandleWebSocketRequestGeneration(IWitWebSocketRequest webSocketRequest) Parameters `webSocketRequest: IWitWebSocketRequest` Returns `void`
IsConfigurationValid ()	Check configuration, client access token & app id Signature virtual bool Meta.WitAi.WitService.IsConfigurationValid() Returns `bool`