UnrealVoxta 0.1.1
 
Loading...
Searching...
No Matches
ServerResponseSpeechTranscription Struct Reference

ServerResponseSpeechTranscription Read-only data struct containing the relevant data of the 'SpeechTranscription' response from the VoxtaServer. More...

#include <ServerResponseSpeechTranscription.h>

Inheritance diagram for ServerResponseSpeechTranscription:
ServerResponseBase

Public Types

enum class  TranscriptionState { Partial , End , Cancelled }
 Contains the possible states of the transcribed speech, as reported by the VoxtaClient. More...
 

Public Member Functions

 ServerResponseSpeechTranscription (FStringView transcribedSpeech, TranscriptionState transcriptionState)
 Construct a speech transcription response.
 
- Public Member Functions inherited from ServerResponseBase
virtual ~ServerResponseBase ()=default
 
 ServerResponseBase (ServerResponseType responseType)
 

Public Attributes

const TranscriptionState TRANSCRIPTION_STATE
 The state of the transcription (partial, end, cancelled).
 
const FString TRANSCRIBED_SPEECH
 The transcribed speech text.
 
- Public Attributes inherited from ServerResponseBase
const ServerResponseType RESPONSE_TYPE
 The type of this server response.
 

Detailed Description

ServerResponseSpeechTranscription Read-only data struct containing the relevant data of the 'SpeechTranscription' response from the VoxtaServer.

Contains the transcribed speech and its state (partial, end, cancelled).

Member Enumeration Documentation

◆ TranscriptionState

Contains the possible states of the transcribed speech, as reported by the VoxtaClient.

Enumerator
Partial 
End 
Cancelled 

Constructor & Destructor Documentation

◆ ServerResponseSpeechTranscription()

ServerResponseSpeechTranscription::ServerResponseSpeechTranscription ( FStringView transcribedSpeech,
TranscriptionState transcriptionState )
inlineexplicit

Construct a speech transcription response.

Parameters
transcribedSpeechThe transcribed speech text.
transcriptionStateThe state of the transcription.

Member Data Documentation

◆ TRANSCRIBED_SPEECH

const FString ServerResponseSpeechTranscription::TRANSCRIBED_SPEECH

The transcribed speech text.

◆ TRANSCRIPTION_STATE

const TranscriptionState ServerResponseSpeechTranscription::TRANSCRIPTION_STATE

The state of the transcription (partial, end, cancelled).


The documentation for this struct was generated from the following file: