API Reference

Complete reference for every public class in the Estuary Unity SDK (com.estuary.sdk).

Components

Components are MonoBehaviour scripts you attach to GameObjects.

Component	Description	Page
EstuaryManager	Singleton that owns the network connection and routes events	Core Components
EstuaryCharacter	Represents one AI character -- holds IDs, accumulates responses, fires per-character events	Character Components
EstuaryAudioSource	Plays streaming TTS audio with ring-buffer playback	Character Components
EstuaryMicrophone	Captures microphone audio in WebSocket or LiveKit mode	Input Components
EstuaryActionManager	Routes action tags from bot responses to handlers	Action Components

Configuration

Class	Description	Page
EstuaryConfig	ScriptableObject holding server URL, API key, voice mode, and audio settings	Core Components

Core (Non-Component)

Class	Description	Page
EstuaryClient	Low-level Socket.IO v4 client (used internally by EstuaryManager)	Core Components
LiveKitVoiceManager	Manages the LiveKit voice room, mic track, and interrupt signalling	LiveKit Integration

Data Models

Class	Description	Page
SessionInfo	Session, conversation, character, and player IDs	Data Models
BotResponse	A single chunk of a streaming text response	Data Models
BotVoice	A single chunk of streaming TTS audio	Data Models
SttResponse	Speech-to-text transcription result	Data Models
AgentAction	A parsed action tag with name and parameters	Data Models
InterruptData	Interrupt confirmation from the server	Data Models
QuotaExceededData	Quota limit information	Data Models

Utilities

Class	Description	Page
ActionParser	Static methods to parse and strip <action> XML tags from text	Action Components

Enums

Enum	Values	Page
ConnectionState	Disconnected, Connecting, Connected, Reconnecting, Error	Data Models
LiveKitConnectionState	Disconnected, RequestingToken, Connecting, WaitingForBot, Ready, Error	Data Models
VoiceMode	WebSocket, LiveKit	Data Models
WebcamStreamMode	LiveKit, WebSocket	Data Models