API Reference

Complete reference documentation for all Estuary SDK components, interfaces, and types.

Overview

The Estuary SDK is organized into several layers:

Layer	Symbols	Description
Core	EstuaryClient, EstuaryHttpClient, EstuaryConfig, ConnectionState, EventEmitter, setInternetModule, getInternetModule, setRemoteServiceModule, getRemoteServiceModule, mergeWithDefaults, validateConfig, isConfigValid, createDevConfig, DEFAULT_CONFIG	Low-level WebSocket/REST client, event plumbing, and config helpers
Components	EstuaryManager, EstuaryCharacter, EstuaryCredentials, EstuaryMicrophone, IEstuaryCharacterHandler, IEstuaryMicrophoneController, IEstuaryCredentials, MicrophoneRecorder, getCredentialsFromSceneObject, createMicrophone	High-level Lens Studio components and supporting interfaces
Actions	EstuaryActionManager, EstuaryActionManagerComponent, EstuaryActions, ParsedAction, RegisteredAction	Action parsing, dispatch, and the BaseScriptComponent wrapper
Camera	EstuaryCamera (example), CameraCaptureRequest, CameraCaptureRequestHandler	Server-driven vision and image capture types
Models	SessionInfo, BotResponse, BotVoice, SttResponse, InterruptData, AgentResponse, ModelStatusResponse, CharacterListResponse	Wire-format data shapes
Model parsers	parseSessionInfo, parseBotResponse, parseBotVoice, parseSttResponse, parseInterruptData, parseAgentResponse, parseModelStatusResponse, parseCharacterListResponse	JSON → typed model converters
Model formatters	sessionInfoToString, botResponseToString, botVoiceToString, sttResponseToString, interruptDataToString, agentResponseToString, modelStatusResponseToString	Debug toString helpers
Model status helpers	isModelInProgress, isModelCompleted, isModelFailed, isModelTextureFailed	Convenience checks against ModelStatusResponse.status
Utilities	AudioConverter, floatToPCM16, DEFAULT_RECORD_SAMPLE_RATE	PCM encoding helpers and sample-rate constants

Quick Navigation

• Core Components - Low-level client and configuration
• Component Layer - High-level components for Lens Studio
• Action System - Action parsing and events
• Camera Module - Vision and image capture
• Data Models - Response and session types
• Utilities - Audio conversion and module setup
• HTTP Client - REST API for character management and 3D models

Import Pattern

All SDK exports can be imported from the main module:

import {
    // Core
    EstuaryClient,
    EstuaryHttpClient,
    EstuaryConfig,
    ConnectionState,
    EventEmitter,
    setInternetModule,
    mergeWithDefaults,
    validateConfig,
    isConfigValid,
    createDevConfig,

    // Components
    EstuaryManager,
    EstuaryCharacter,
    EstuaryCredentials,
    EstuaryMicrophone,
    IEstuaryCharacterHandler,
    MicrophoneRecorder,
    getCredentialsFromSceneObject,

    // Actions
    EstuaryActionManager,
    EstuaryActionManagerComponent,
    EstuaryActions,
    ParsedAction,

    // Camera
    CameraCaptureRequest,

    // Models
    SessionInfo,
    BotResponse,
    BotVoice,
    SttResponse,
    InterruptData,
    AgentResponse,
    ModelStatusResponse,
    CharacterListResponse,

    // Parsers / formatters
    parseSessionInfo,
    parseBotResponse,
    parseBotVoice,
    parseSttResponse,
    parseInterruptData,
    parseAgentResponse,
    parseModelStatusResponse,
    parseCharacterListResponse,
    sessionInfoToString,
    botResponseToString,
    botVoiceToString,
    sttResponseToString,
    interruptDataToString,
    agentResponseToString,
    modelStatusResponseToString,

    // Model status helpers
    isModelInProgress,
    isModelCompleted,
    isModelFailed,
    isModelTextureFailed,

    // Utilities
    floatToPCM16,
    DEFAULT_RECORD_SAMPLE_RATE,
} from 'estuary-lens-studio-sdk';