API reference
API reference
Select your platform
No SDKs available
No versions available

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.

Protected Fields

Flags to indicate whether or not the component supports voice and/or text activation.
bool _hasTextActivation[Get]
This flag dictates whether or not the service should send a network request as part of its (de)activation handling.

Properties

MonoBehaviour ServiceComponent[Get]
bool HasVoiceActivation[Get]
bool HasTextActivation[Get]
bool ShouldSubmitUtterance[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.
abstract bool Active[Get]
abstract bool MicActive[Get]
abstract bool IsRequestActive[Get]
abstract VoiceServiceRequestEvent OnSend[Get]
abstract WitTranscriptionEvent OnPartialTranscription[Get]
abstract WitTranscriptionEvent OnFullTranscription[Get]
abstract UnityEvent OnStoppedListening[Get]
abstract VoiceServiceRequestEvent OnComplete[Get]

Member Functions

Constructor.
Parameters
serviceComponent
The Service Component (VoiceService, DictationService, etc. this API will wrap.
abstract void Activate ( )
abstract void Activate
( string text )
abstract void Deactivate ( )
abstract void DeactivateAndAbortRequest ( )
Did you find this page helpful?
Thumbs up icon
Thumbs down icon