Meta Developers

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.

TelemetryEvents telemetryEvents[Get]

Fields

bool IsRequestActive[Get]

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.

IAudioInputEvents AudioEvents[Get]

A subset of events around collection of audio data

ITranscriptionEvent TranscriptionEvents[Get]

A subset of events around receiving transcriptions

Protected Functions

virtual override SpeechEvents GetSpeechEvents ( )

If applicable, get all speech events

VoiceService ( )

Constructs a VoiceService

virtual override void OnRequestPartialResponse

( VoiceServiceRequest request,

WitResponseNode responseNode )

virtual void OnValidateEarly

( VoiceServiceRequest request,

WitResponseNode responseNode )

virtual void Awake ( )

virtual override void OnEnable ( )

On enable, begin watching for request initialized callbacks

virtual override void OnDisable ( )

On enable, stop watching for request initialized callbacks

virtual void OnFinalTranscription

( string transcription )

Activate message if transcription provider returns a final transcription

virtual void HandleResponse

( WitResponseNode response )

Member Functions

void Activate

( string text )

Send text data for NLU processing. Results will return the same way a voice based activation would.

Parameters

text

Text to be used for NLU processing

Task< VoiceServiceRequest > Activate

( string text,

WitRequestOptions requestOptions )

Send text data for NLU processing. Results will return the same way a voice based activation would.

Parameters

text

Text to be used for NLU processing

requestOptions

Additional options such as dynamic entities

Task< VoiceServiceRequest > Activate

( string text,

VoiceServiceRequestEvents requestEvents )

Send text data for NLU processing. Results will return the same way a voice based activation would.

Parameters

text

Text to be used for NLU processing

requestEvents

Events specific to the request's lifecycle

abstract Task< VoiceServiceRequest > Activate

( string text,

WitRequestOptions requestOptions,

VoiceServiceRequestEvents requestEvents )

Send text data for NLU processing with custom request options.

Parameters

text

Text to be used for NLU processing

requestOptions

Additional options such as dynamic entities

requestEvents

Events specific to the request's lifecycle

void Activate ( )

Start listening for sound or speech from the user and start sending data to Wit.ai once sound or speech has been detected.

void Activate

( WitRequestOptions requestOptions )

Start listening for sound or speech from the user and start sending data to Wit.ai once sound or speech has been detected.

Parameters

requestOptions

Additional options such as dynamic entities

VoiceServiceRequest Activate

( VoiceServiceRequestEvents requestEvents )

Start listening for sound or speech from the user and start sending data to Wit.ai once sound or speech has been detected.

Parameters

requestEvents

Events specific to the request's lifecycle

abstract VoiceServiceRequest Activate

( WitRequestOptions requestOptions,

VoiceServiceRequestEvents requestEvents )

Start listening for sound or speech from the user and start sending data to Wit.ai once sound or speech has been detected.

Parameters

requestOptions

Additional options such as dynamic entities

requestEvents

Events specific to the request's lifecycle

void ActivateImmediately ( )

Activate the microphone and send data for NLU processing immediately without waiting for sound/speech from the user to begin.

void ActivateImmediately

( WitRequestOptions requestOptions )

Activate the microphone and send data for NLU processing immediately without waiting for sound/speech from the user to begin.

Parameters

requestOptions

Additional options such as dynamic entities

VoiceServiceRequest ActivateImmediately

( VoiceServiceRequestEvents requestEvents )

Activate the microphone and send data for NLU processing immediately without waiting for sound/speech from the user to begin.

Parameters

requestEvents

Events specific to the request's lifecycle

abstract VoiceServiceRequest ActivateImmediately

( WitRequestOptions requestOptions,

VoiceServiceRequestEvents requestEvents )

Activate the microphone and send data for NLU processing immediately without waiting for sound/speech from the user to begin.

Parameters

requestOptions

Additional options such as dynamic entities

requestEvents

Events specific to the request's lifecycle

IEnumerable< object > GetObjectsOfType

( Type type )

Returns objects of the specified type.

Parameters

type

The type.

Returns

Objects of the specified type.

Did you find this page helpful?