TranscriptionRequest Class

Extends Meta::Voice::VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >

Abstract class for all transcription requests

Constructors

TranscriptionRequest ( newOptions , newEvents )

Constructor class for transcription requests

Signature

Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.TranscriptionRequest(TOptions newOptions, TEvents newEvents)

Parameters

newOptions: TOptions The request parameters to be used

newEvents: TEvents The request events to be called throughout it's lifecycle

Fields

CanActivateAudio : bool	Determine whether audio can be activated based on activation error existing Signature bool Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.CanActivateAudio
CanDeactivateAudio : bool	Determine whether audio can be activated based on activation error existing Signature bool Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.CanDeactivateAudio
IsAudioInputActivated : bool	Whether or not audio is currently activated Signature bool Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.IsAudioInputActivated
IsListening : bool	Whether or not audio is currently being listened to Signature bool Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.IsListening

Properties

AudioInputState : VoiceAudioInputState

[Get]

The current audio input state

Signature

VoiceAudioInputState Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.AudioInputState

FinalTranscriptions : string []

[Get]

An array of all finalized transcriptions

Signature

string [] Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.FinalTranscriptions

Transcription : string

[Get]

Transcription data

Signature

string Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.Transcription

Protected Methods

ApplyTranscription ( transcription , full )	Applies a transcription to the current results Signature virtual void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.ApplyTranscription(string transcription, bool full) Parameters `transcription: string` The transcription returned `full: bool` If true the transcription is final, otherwise still being analyzed. Returns `void`
GetActivateAudioError ()	Implementations need to provide errors when audio input is not found Signature abstract string Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.GetActivateAudioError() Returns `abstract string`
HandleAudioActivation ()	Child class audio activation handler needs to call SetAudioInputState when complete Signature abstract void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.HandleAudioActivation() Returns `abstract void`
HandleAudioDeactivation ()	Child class audio deactivation handler needs to call SetAudioInputState when complete Signature abstract void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.HandleAudioDeactivation() Returns `abstract void`
HasSentAudio ()	Check to determine if audio has been sent Signature virtual bool Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.HasSentAudio() Returns `bool`
Log ( log , logLevel )	Recreates log with specified info Signature override void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.Log(string log, VLoggerVerbosity logLevel=VLoggerVerbosity.Info) Parameters `log: string` `logLevel: VLoggerVerbosity` Returns `override void`
OnAudioActivation ()	Called when audio activation begins Signature virtual void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.OnAudioActivation() Returns `void`
OnAudioDeactivation ()	Called when audio deactivation begins Signature virtual void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.OnAudioDeactivation() Returns `void`
OnCanActivate ()	Signature virtual void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.OnCanActivate() Returns `void`
OnFullTranscription ()	Called when a full transcription has been set Signature virtual void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.OnFullTranscription() Returns `void`
OnPartialTranscription ()	Called when a partial transcription has been set Signature virtual void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.OnPartialTranscription() Returns `void`
OnStartListening ()	Called when audio activation is in effect and input is being listened to Signature virtual void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.OnStartListening() Returns `void`
OnStopListening ()	Called when audio input state is no longer being listened to Signature virtual void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.OnStopListening() Returns `void`
SetAudioInputState ( newAudioInputState )	Set audio input state Signature virtual void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.SetAudioInputState(VoiceAudioInputState newAudioInputState) Parameters `newAudioInputState: VoiceAudioInputState` Returns `void`

Methods

ActivateAudio ()	Public request to activate audio input Signature virtual void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.ActivateAudio() Returns `void`
Cancel ( reason )	Ensure audio is deactivated prior to cancellation Signature override void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.Cancel(string reason=WitConstants.CANCEL_MESSAGE_DEFAULT) Parameters `reason: string` Returns `override void`
DeactivateAudio ()	Public request to deactivate audio input Signature virtual void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.DeactivateAudio() Returns `void`
Send ()	Ensure audio is activated prior to sending Signature override void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.Send() Returns `override void`