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

TranscriptionRequest Class

Abstract class for all transcription requests
Meta::Voice::TranscriptionRequest extends Meta::Voice::VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.

Overview

Properties

The current audio input state
string
Transcription data
string []
An array of all finalized transcriptions

Data Fields

bool
Whether or not audio is currently activated
bool
Whether or not audio is currently being listened to
bool
Determine whether audio can be activated based on activation error existing
bool
Determine whether audio can be activated based on activation error existing

Object Data

TranscriptionRequest
( TOptions newOptions,
TEvents newEvents )
Constructor class for transcription requests
void
Set audio input state
void
override void
AppendLogData
( StringBuilder log,
VLogLevel logLevel )
Append request specific data to log
void
ApplyTranscription
( string transcription,
bool full )
Applies a transcription to the current results
void
Called when a partial transcription has been set
void
Called when a full transcription has been set
abstract string
Implementations need to provide errors when audio input is not found
void
Called when audio activation begins
abstract void
Child class audio activation handler needs to call SetAudioInputState when complete
void
Called when audio activation is in effect and input is being listened to
void
Called when audio deactivation begins
abstract void
Child class audio deactivation handler needs to call SetAudioInputState when complete
bool
Check to determine if audio has been sent
void
Called when audio input state is no longer being listened to

Public Member Functions

void
Public request to activate audio input
void
Public request to deactivate audio input
override void
Send ( )
Ensure audio is activated prior to sending
override void
Cancel
( string reason )
Ensure audio is deactivated prior to cancellation

Details

Detailed Description

Others
TUnityEvent
The type of event callback performed by TEvents for all event callbacks
TOptions
The type containing all specific options to be passed to the end service.
TEvents
The type containing all events of TSession to be called throughout the lifecycle of the request.
TResults
The type containing all data that can be returned from the end service.

Properties

VoiceAudioInputState Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.AudioInputState
The current audio input state
string Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.Transcription
Transcription data
string [] Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.FinalTranscriptions
An array of all finalized transcriptions

Fields

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

Object Data

Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.TranscriptionRequest
( TOptions newOptions,
TEvents newEvents )
Constructor class for transcription requests
Parameters
newOptions
The request parameters to be used
newEvents
The request events to be called throughout it's lifecycle
virtual void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.SetAudioInputState
( VoiceAudioInputState newAudioInputState )
Set audio input state
virtual void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.OnCanActivate ( )
No description available.
override void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.AppendLogData
( StringBuilder log,
VLogLevel logLevel )
Append request specific data to log
Parameters
log
Building log
virtual void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.ApplyTranscription
( string transcription,
bool full )
Applies a transcription to the current results
Parameters
transcription
The transcription returned
full
If true the transcription is final, otherwise still being analyzed.
virtual void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.OnPartialTranscription ( )
Called when a partial transcription has been set
virtual void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.OnFullTranscription ( )
Called when a full transcription has been set
abstract string Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.GetActivateAudioError ( )
Implementations need to provide errors when audio input is not found
virtual void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.OnAudioActivation ( )
Called when audio activation begins
abstract void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.HandleAudioActivation ( )
Child class audio activation handler needs to call SetAudioInputState when complete
virtual void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.OnStartListening ( )
Called when audio activation is in effect and input is being listened to
virtual void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.OnAudioDeactivation ( )
Called when audio deactivation begins
abstract void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.HandleAudioDeactivation ( )
Child class audio deactivation handler needs to call SetAudioInputState when complete
virtual bool Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.HasSentAudio ( )
Check to determine if audio has been sent
virtual void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.OnStopListening ( )
Called when audio input state is no longer being listened to

Member Functions

virtual void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.ActivateAudio ( )
Public request to activate audio input
virtual void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.DeactivateAudio ( )
Public request to deactivate audio input
override void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.Send ( )
Ensure audio is activated prior to sending
override void Meta.Voice.TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >.Cancel
( string reason )
Ensure audio is deactivated prior to cancellation
Did you find this page helpful?
Thumbs up icon
Thumbs down icon