API reference
TranscriptionRequest Class
Abstract class for all transcription requests
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 AudioInputState[Get]
The current audio input state
string Transcription[Get]
Transcription data
string [] FinalTranscriptions[Get]
An array of all finalized transcriptions
Fields
bool IsAudioInputActivated[Get]
Whether or not audio is currently activated
bool IsListening[Get]
Whether or not audio is currently being listened to
bool CanActivateAudio[Get]
Determine whether audio can be activated based on activation error existing
bool CanDeactivateAudio[Get]
Determine whether audio can be activated based on activation error existing
Protected Functions
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 SetAudioInputState
( VoiceAudioInputState newAudioInputState )
Set audio input state
virtual void OnCanActivate ( )
virtual override void Log
( string log,
VLoggerVerbosity logLevel )
Recreates log with specified info
virtual void 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 OnPartialTranscription ( )
Called when a partial transcription has been set
virtual void OnFullTranscription ( )
Called when a full transcription has been set
abstract string GetActivateAudioError ( )
Implementations need to provide errors when audio input is not found
virtual void OnAudioActivation ( )
Called when audio activation begins
abstract void HandleAudioActivation ( )
Child class audio activation handler needs to call SetAudioInputState when complete
virtual void OnStartListening ( )
Called when audio activation is in effect and input is being listened to
virtual void OnAudioDeactivation ( )
Called when audio deactivation begins
abstract void HandleAudioDeactivation ( )
Child class audio deactivation handler needs to call SetAudioInputState when complete
virtual bool HasSentAudio ( )
Check to determine if audio has been sent
virtual void OnStopListening ( )
Called when audio input state is no longer being listened to
Member Functions
virtual void ActivateAudio ( )
Public request to activate audio input
virtual void DeactivateAudio ( )
Public request to deactivate audio input
virtual override void Send ( )
Ensure audio is activated prior to sending
virtual override void Cancel
( string reason )
Ensure audio is deactivated prior to cancellation
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta