Complete reference for every public class, component, and node in the Estuary Unreal Engine SDK plugin.
The SDK is Blueprint-first: every class below is reachable from both C++ and Blueprint. Blueprint display names are shown alongside the C++ names.
Core Classes
Connection, the placeable character, settings, and static helpers.
| Class | Base | Description | Page |
|---|
UEstuarySubsystem | UGameInstanceSubsystem | Owns the connection, session state, event routing | Core Classes |
AEstuaryCharacter | AActor | Placeable AI conversation character | Core Classes |
UEstuaryDeveloperSettings | UDeveloperSettings | Project Settings → Plugins → Estuary | Core Classes |
UEstuaryBlueprintLibrary | UBlueprintFunctionLibrary | Static helpers (auth payloads, base64, message IDs) | Core Classes |
UEstuaryConnectAction | UBlueprintAsyncActionBase | The latent Connect (Latent) node | Core Classes |
UEstuaryPermissionAction | UBlueprintAsyncActionBase | Mobile mic/camera permission nodes | Core Classes |
Character Components
Per-character conversation, voice input, and TTS playback.
| Component | Base | Description | Page |
|---|
UEstuaryCharacterComponent | UActorComponent | Send text, interrupt, per-character events | Character Components |
UEstuaryAudioPlayerComponent | UAudioComponent | Streaming TTS playback | Character Components |
UEstuaryMicrophoneComponent | UActorComponent | Cross-platform microphone capture | Character Components |
Animation Components
MetaHuman lipsync and body animation.
| Component | Base | Description | Page |
|---|
UEstuaryAnimationReceiver | UActorComponent | ARKit-52 face lipsync (via Live Link) | Animation Components |
UEstuaryBodyAnimationReceiver | UActorComponent | Body pose animation (experimental) | Animation Components |
UEstuaryUserPositionComponent | UActorComponent | Streams player floor position for conditioning | Animation Components |
Camera Component
| Component | Base | Description | Page |
|---|
UEstuaryCameraComponent | USceneComponent | Scene / webcam capture for vision | Camera Component |
LiveKit Integration
| Topic | Description | Page |
|---|
| WebRTC voice & echo cancellation | Optional desktop voice transport setup | LiveKit Integration |
Data Models
All wire payload structs and enums.
| Type | Description | Page |
|---|
FEstuaryAuthPayload | Connection / authentication payload | Data Models |
FEstuarySessionInfo | Session metadata after connect | Data Models |
FEstuaryBotResponse | A streaming text chunk | Data Models |
FEstuaryBotVoice | A streaming TTS audio chunk | Data Models |
FEstuarySttResponse | Speech-to-text result | Data Models |
FEstuaryBotAnimation | An ARKit-52 lipsync frame | Data Models |
FEstuaryBotPose | A body-pose frame (experimental) | Data Models |
FEstuaryCameraImage / FEstuaryCameraCapture / FEstuaryVisionResponse | Vision payloads | Data Models |
FEstuaryMemoryUpdated / FEstuaryMemoryData | Memory extraction push | Data Models |
FEstuaryError / FEstuaryAuthError / FEstuarySessionRejected / FEstuaryQuotaExceeded | Error payloads | Data Models |
FEstuaryPreferences / FEstuaryInterruptPayload | Preference & interrupt payloads | Data Models |
Enums
| Enum | Values | Page |
|---|
EEstuarySessionState | Disconnected, Connecting, Connected, Reconnecting, Error | Data Models |
EEstuaryVoiceMode | WebSocket, LiveKit | Data Models |
EEstuaryCaptureSource | RenderedScene, Webcam | Data Models |
EEstuaryFingerPolicy | Driven, BindPose, IdleBreath, Statue | Data Models |