React
Vanilla JS
Solid Soon

Private Beta
- Install the Private Beta
Getting Started
Tutorials
Guides
Understanding
API Reference
- @maelstrom-co/react
- @maelstrom-co/client
- @maelstrom-co/connectors
  - Interfaces
    
    CloseCodeClassification
  - Variables
    
    DEFAULT_HEARTBEAT_INTERVAL_MS
    HEARTBEAT_PING_FRAME
    HEARTBEAT_PONG_FRAME
  - Functions
    
    classifyCloseCode
    isCorrelatableId
    isHeartbeatPingFrame
    isHeartbeatPongFrame
- @maelstrom-co/protocol
- @maelstrom-co/engine
- @maelstrom-co/planner-llm
  - Interfaces
    
    LlmPlannerOptions
    PromptOptions
    PromptResult
    PromptSection
    PromptVars
  - Type Aliases
    
    LlmPlannerInput
    SectionCustomizer
    SectionExtension
    SystemSectionKey
    SystemSectionOverrides
    UserSectionKey
    UserSectionOverrides
  - Variables
    
    SystemSection
    UserSection
  - Functions
    
    buildPrompt
    buildSystemPrompt
    buildUserPrompt
    llmPlanner
- Voice
  - @maelstrom-co/realtime
    
    Classes
    
    ConnectRaceGuard
    GreetingCoordinator
    RealtimeSession
    RealtimeSessionMemory
    RealtimeVoiceError
    TranscriptObservationFeed
    
    Interfaces
    
    AdapterAudioStreams
    AdapterConnectOptions
    AdapterGeneratedOpening
    AdapterTurnControl
    AdapterVoiceObservations
    ConnectAttempt
    ContinuousTranscriptOptions
    GreetingRunContext
    MediaEvent
    OpeningClaimedEvent
    RealtimeGreetingAdapter
    RealtimeInstance
    RealtimeProviderAdapter
    RealtimeSessionOptions
    RealtimeToolSpec
    RealtimeTransportAdapter
    SessionEventSource
    SessionStartedEvent
    SubmitIntentResult
    TimingEvent
    ToolCalledEvent
    ToolLaterOutcomeEvent
    ToolResultEvent
    ToolSubmittedEvent
    TranscriptEntryEvent
    TranscriptFragmentEvent
    TranscriptObservationFeedOptions
    TurnModeEvent
    UpdateUIToolResult
    VoiceRecoveryFragment
    VoiceRecoveryOutcome
    VoiceRecoverySnapshot
    
    Type Aliases
    
    AdapterVoiceObservation
    GreetingCoordinatorLifecycle
    GreetingCoordinatorSnapshot
    GreetingSpeechResult
    GreetingState
    GreetingTerminalReason
    RealtimeAdapterEvent
    RealtimeVoiceErrorCode
    SessionEvent
    SessionEventHandler
    SessionLifecycleEvent
    SummarizeFn
    ToolCallEvent
    ToolLaterOutcomeType
    ToolOutcomeEvent
    ToolResult
    TurnMode
    
    Functions
    
    groundedDebounce
    isRealtimeGreetingAdapter
  - @maelstrom-co/realtime-protocol
    
    packages/realtime-protocol/src
    
    Interfaces
    
    TokenGrant
    
    Type Aliases
    
    MintFailure
    MintFailureReason
    MintFetch
    UnixSeconds
    
    Variables
    
    MINT_FAILURE_REASONS
    UnixSecondsSchema
    
    Functions
    
    mintFailureHttpStatus
    
    packages/realtime-protocol/src/livekit
    
    Interfaces
    
    LiveKitTokenGrant
    TtsCancelMessage
    TtsDoneMessage
    TtsErrorMessage
    TtsReadyMessage
    TtsStartedMessage
    TurnEndMessage
    
    Variables
    
    LiveKitTokenGrantSchema
    SPEAK_TOPIC
    SPEAK_UTTERANCE_ID_ATTR
    TTS_READY_TOPIC
    TTS_TOPIC
    TURN_TOPIC
    USER_PARTICIPANT_IDENTITY
    
    packages/realtime-protocol/src/livekit-wire
    
    References
    
    SPEAK_TOPIC
    SPEAK_UTTERANCE_ID_ATTR
    TTS_READY_TOPIC
    TTS_TOPIC
    TtsCancelMessage
    TtsDoneMessage
    TtsErrorMessage
    TtsReadyMessage
    TtsStartedMessage
    TURN_TOPIC
    TurnEndMessage
    USER_PARTICIPANT_IDENTITY
    
    packages/realtime-protocol/src/openai
    
    Interfaces
    
    OpenAITokenGrant
    OpenAITokenRequest
    
    Type Aliases
    
    OpenAIBuiltInVoice
    
    Variables
    
    OpenAITokenGrantSchema
    OpenAITokenRequestSchema
    
    packages/realtime-protocol/src/openai-live
    
    Classes
    
    LiveTransportError
    
    Interfaces
    
    LiveExchangeRequest
    LiveExchangeResponse
    LiveFunctionTool
    LiveResponsesConfig
    LiveServerEvent
    LiveSessionConfig
    LiveWebRTCDescription
    
    Type Aliases
    
    LiveCommand
    LiveInputMessage
    LiveJson
    LiveSessionExchange
    
    Variables
    
    LiveExchangeRequestSchema
    LiveExchangeResponseSchema
    LiveServerEventSchema
    LiveSessionConfigSchema
  - @maelstrom-co/realtime-openai
    
    Classes
    
    OpenAIAdapter
    
    Interfaces
    
    BrowserVadOptions
    BrowserVadProviderOptions
    OpenAIAdapterOptions
    OpenAITokenGrant
    OpenAITokenRequest
    SynthesizeGreetingArgs
    
    Type Aliases
    
    OpenAIBuiltInVoice
    SynthesizeGreeting
    
    Variables
    
    OpenAITokenGrantSchema
    OpenAITokenRequestSchema
  - @maelstrom-co/realtime-openai-live
    
    Classes
    
    OpenAILiveAdapter
    OpenAILiveTransport
    
    Interfaces
    
    LiveTransportOptions
    LiveTransportSnapshot
    OpenAILiveAdapterOptions
  - @maelstrom-co/realtime-openai-live-server
    
    Interfaces
    
    LiveSessionExchangeOptions
    
    Functions
    
    createLiveSessionExchange
  - @maelstrom-co/react-realtime
    
    Interfaces
    
    LevelMeter
    MaelstromRealtimeBaseOptions
    MaelstromRealtimeFixedOpeningOptions
    MaelstromRealtimeOpeningOptions
    RealtimeSessionContext
    RealtimeSessionInit
    UseVoiceObservationsResult
    UseVoiceResult
    VoiceOrbProps
    
    Type Aliases
    
    CreateAdapterContext
    MaelstromRealtimeOptions
    RealtimeOpening
    
    Functions
    
    createLevelMeter
    maelstromRealtime
  - @maelstrom-co/realtime-openai-server
    
    Interfaces
    
    CreateOpenAIMinterOptions
    
    Type Aliases
    
    MintFailure
    MintFailureReason
    MintResult
    
    Functions
    
    createOpenAIMinter
    mintFailureHttpStatus
  - @maelstrom-co/realtime-livekit
    
    Classes
    
    LiveKitAdapter
    
    Interfaces
    
    BrowserVadOptions
    BrowserVadProviderOptions
    LiveKitAdapterOptions
    LiveKitTokenGrant
    TtsCancelMessage
    TtsDoneMessage
    TtsErrorMessage
    TtsReadyMessage
    TtsStartedMessage
    TurnEndMessage
    
    Variables
    
    LiveKitTokenGrantSchema
    SPEAK_TOPIC
    SPEAK_UTTERANCE_ID_ATTR
    TTS_READY_TOPIC
    TTS_TOPIC
    TURN_TOPIC
    USER_PARTICIPANT_IDENTITY
  - @maelstrom-co/realtime-livekit-server
    
    Interfaces
    
    LiveKitTokenRequest
    
    Type Aliases
    
    LiveKitMintResult
    MintFailure
    MintFailureReason
    
    Variables
    
    LiveKitTokenRequestSchema
    
    Functions
    
    mintFailureHttpStatus
    mintLiveKitToken
  - @maelstrom-co/realtime-livekit-agent
    
    Variables
    
    default
    
    Functions
    
    defineMaelstromVoiceAgent
    runVoiceAgent
  - @maelstrom-co/realtime-vad
    
    packages/realtime-vad/src
    
    Interfaces
    
    BrowserVadOptions
    BrowserVadProviderOptions
    LocalAudioPreRoll
    
    Type Aliases
    
    BrowserVad
    CreateBrowserVadOptions
    ResolvedBrowserVadConfig
    
    Functions
    
    createBrowserVad
    createLocalAudioPreRoll
    resolveBrowserVadConfig
    
    packages/realtime-vad/src/vad-assets
    
    Interfaces
    
    CopyBrowserVadAssetsOptions
    
    Functions
    
    copyBrowserVadAssets
Coding agents
Community

GitHub

On this page

Overview
Variables
Functions

@maelstrom-co/realtime-livekit-agent

Variables

Section titled “Variables”

default

Functions

Section titled “Functions”

defineMaelstromVoiceAgent
runVoiceAgent

Was this page helpful?