API reference

WitUnderstandingViewerServiceAPI Class

This class provides a common API for accessing properties and methods of the various *Service classes used in the Understanding Viewer. In order to add support for a new Service type, derive a child class from this one and provide implementations for the getter methods.

Constructors

WitUnderstandingViewerServiceAPI ( serviceComponent )
Constructor.
Signature
Meta.WitAi.Windows.WitUnderstandingViewerServiceAPI.WitUnderstandingViewerServiceAPI(MonoBehaviour serviceComponent)
Parameters
serviceComponent: MonoBehaviour  The Service Component (VoiceService, DictationService, etc. this API will wrap.

Protected Fields

_hasTextActivation : bool
Signature
bool Meta.WitAi.Windows.WitUnderstandingViewerServiceAPI._hasTextActivation
_hasVoiceActivation : bool
Flags to indicate whether or not the component supports voice and/or text activation.
Signature
bool Meta.WitAi.Windows.WitUnderstandingViewerServiceAPI._hasVoiceActivation
_shouldSubmitUtterance : bool
This flag dictates whether or not the service should send a network request as part of its (de)activation handling.
Signature
bool Meta.WitAi.Windows.WitUnderstandingViewerServiceAPI._shouldSubmitUtterance

Properties

Active : abstract bool
[Get]
Signature
abstract bool Meta.WitAi.Windows.WitUnderstandingViewerServiceAPI.Active
HasTextActivation : bool
[Get]
Signature
bool Meta.WitAi.Windows.WitUnderstandingViewerServiceAPI.HasTextActivation
HasVoiceActivation : bool
[Get]
Signature
bool Meta.WitAi.Windows.WitUnderstandingViewerServiceAPI.HasVoiceActivation
IsRequestActive : abstract bool
[Get]
Signature
abstract bool Meta.WitAi.Windows.WitUnderstandingViewerServiceAPI.IsRequestActive
MicActive : abstract bool
[Get]
Signature
abstract bool Meta.WitAi.Windows.WitUnderstandingViewerServiceAPI.MicActive
OnComplete : abstract VoiceServiceRequestEvent
[Get]
Signature
abstract VoiceServiceRequestEvent Meta.WitAi.Windows.WitUnderstandingViewerServiceAPI.OnComplete
OnFullTranscription : abstract WitTranscriptionEvent
[Get]
Signature
abstract WitTranscriptionEvent Meta.WitAi.Windows.WitUnderstandingViewerServiceAPI.OnFullTranscription
OnPartialTranscription : abstract WitTranscriptionEvent
[Get]
Signature
abstract WitTranscriptionEvent Meta.WitAi.Windows.WitUnderstandingViewerServiceAPI.OnPartialTranscription
OnSend : abstract VoiceServiceRequestEvent
[Get]
Signature
abstract VoiceServiceRequestEvent Meta.WitAi.Windows.WitUnderstandingViewerServiceAPI.OnSend
OnStoppedListening : abstract UnityEvent
[Get]
Signature
abstract UnityEvent Meta.WitAi.Windows.WitUnderstandingViewerServiceAPI.OnStoppedListening
ServiceComponent : MonoBehaviour
[Get]
Signature
MonoBehaviour Meta.WitAi.Windows.WitUnderstandingViewerServiceAPI.ServiceComponent
ServiceName : string
[Get]
Most services have a common way of querying their service name. For those that don't, override this method. The name is cached after first query.
Signature
virtual string Meta.WitAi.Windows.WitUnderstandingViewerServiceAPI.ServiceName
ShouldSubmitUtterance : bool
[Get]
Signature
bool Meta.WitAi.Windows.WitUnderstandingViewerServiceAPI.ShouldSubmitUtterance

Methods

Activate ()
Signature
abstract void Meta.WitAi.Windows.WitUnderstandingViewerServiceAPI.Activate()
Returns
abstract void
Activate ( text )
Signature
abstract void Meta.WitAi.Windows.WitUnderstandingViewerServiceAPI.Activate(string text)
Parameters
text: string
Returns
abstract void
Deactivate ()
Signature
abstract void Meta.WitAi.Windows.WitUnderstandingViewerServiceAPI.Deactivate()
Returns
abstract void
DeactivateAndAbortRequest ()
Signature
abstract void Meta.WitAi.Windows.WitUnderstandingViewerServiceAPI.DeactivateAndAbortRequest()
Returns
abstract void