Skip to main content

API Reference

All types use the ERP_ / UERP_ / FERP_ prefix and are Blueprint-accessible.

UERP_STTComponent

The Blueprint-friendly entry point. Add it to an actor (client-side).

MemberKindDescription
Configproperty FERP_STTConfigPer-component STT configuration
bAutoStartListeningproperty boolStart on BeginPlay
bAutoRegisterAudioConsumerproperty boolAuto-register with capture
StartListening()function → boolBegin capture + transcription
StopListening()functionStop and unregister
IsListening()pure → boolCurrently listening?
SetConfig(NewConfig)functionUpdate config at runtime
IsSTTReady()pure → boolBackend loaded and ready?
OnSTTResultevent FERP_STTResultFires for interim and final results
OnTextevent FStringFinal transcript text — for chaining

FERP_STTResult

FieldTypeDescription
TranscribedTextFStringThe recognized text
Confidencefloat0.0–1.0
bIsFinalboolFinal vs. interim result
ProcessingTimeMsfloatInference time

FERP_STTConfig

FieldTypeDescription
LanguageCodeFStringe.g. en-US, fr-FR
bEnableInterimResultsboolEmit partial results
MinConfidenceThresholdfloatDrop results below this

UERP_STTSubsystem

GameInstanceSubsystem owning the shared backend.

MemberDescription
InitializeBackend(Config)boolLoad the model
ShutdownBackend()Unload
IsBackendInitialized()boolReady state
GetModelInfo()FStringLoaded model description

UERP_AudioCaptureSubsystem

Microphone capture, fanned out to consumers. Supports push-to-talk and mute via SetPushToTalkMode, SetPushToTalkActive, SetMuted.

IERP_STTBackend

Implement this to add a custom STT engine (e.g. Vosk, Moonshine), then select Custom as the backend in settings. Whisper is the bundled implementation (UERP_WhisperBackend).