Member Junction
    Preparing search index...

    Live IRealtimeSession handle speaking the OpenAI Live wire protocol (wss://api.openai.com/v1/live/sessions).

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    AudioFormat?:
        | "negotiated"
        | { Codec: "pcm16"
        | "g711_ulaw"
        | "g711_alaw"; SampleRate: number }

    Audio encoding and sample rate format supported or negotiated for this session.

    callsFromBeforeReseed: Set<string>

    Capability introspection. A small, static description of what THIS live session can do, so the container can ask "is it safe to call X?" instead of invoking optional methods that silently no-op (or can't be supported) on some providers — the same role IBridgeProviderFeatures plays for bridges and BaseRealtimeModel.SupportsClientDirect plays for minting. Optional: a driver that hasn't declared its capabilities is treated conservatively (everything unsupported). As models gain abilities, drivers just flip a flag — no container changes.

    closedByConsumer: boolean
    configuredCallDurationSeconds: number
    configuredReconnectBufferSeconds: number
    configuredSessionMaxSeconds: number
    configuredTrustNativeResumption: boolean
    configuredZeroDataRetention: boolean
    conversationMemory: RealtimeConversationMemory
    InputSampleRate: number

    The PCM sample rate (Hz) this model consumes on IRealtimeSession.SendInput — its audio INPUT format. Optional; consumers default to 24000 (OpenAI Realtime). Gemini Live = 16000. A server-bridged host (LiveKit/Zoom/Teams) MUST resample inbound room audio to this rate or the model receives mis-rated audio it can't parse (the symptom: the agent never responds on the bridge while the same model works client-direct, where the browser negotiates the rate itself).

    OutputSampleRate: number

    The PCM sample rate (Hz) this model emits on IRealtimeSession.OnOutput — its audio OUTPUT format. Optional; consumers default to 24000 (both OpenAI and Gemini Live emit 24 kHz today).

    pendingToolCallNames: Map<string, string>
    reconnectController: RealtimeReconnectController
    turnOpen: boolean

    Accessors

    • get CallDurationSeconds(): number

      Effective single-connection duration in seconds, resolved via ClampSessionSecondsValue so metadata (configuredCallDurationSeconds) narrows the driver's provider ceiling (DefaultCallDurationSeconds) and any state-dependent RuntimeCallDurationSeconds, never widening it.

      Returns number

    • get ConversationMemory(): RealtimeConversationMemory

      Accessor for the session's provider-neutral conversation memory ledger.

      Returns RealtimeConversationMemory

    • get DefaultTrustsNativeResumption(): boolean

      Driver default for whether native resumption handles are trusted when metadata does not override.

      Returns boolean

    • get IsClosedByConsumer(): boolean

      True once the consumer has closed the session.

      Returns boolean

    • get IsReconnecting(): boolean

      True while an in-place reconnect is currently running.

      Returns boolean

    • get ReconnectBufferSeconds(): number

      Buffer in seconds before CallDurationSeconds at which the framework initiates a reconnect.

      Returns number

    • get RequiresPostTurnResumptionHandle(): boolean

      Whether this session's provider emits a fresh resumable handle shortly after each turnComplete (e.g. Gemini / Vertex AI Live), so a planned move (goAway or soft window) during a turn waits for that post-turn handle (bounded by the deadline timer) rather than resuming from a pre-turn handle.

      Returns boolean

    • get ResumptionHandle(): string

      Latest recorded provider resumption handle, or null if none.

      Returns string

    • get RuntimeCallDurationSeconds(): number

      Dynamic state-dependent duration cap in seconds (for example, returning 120 when uncompressed video is active on Gemini Live, and undefined otherwise). Clamped with configuredCallDurationSeconds via ClampSessionSecondsValue so neither a seeded 600s catalog value nor a tighter custom metadata value (e.g., 45s) is shadowed.

      Returns number

    • get SessionMaxSeconds(): number

      Configured credential/session lifetime in seconds, when distinct from CallDurationSeconds.

      Returns number

    • get TrustsNativeResumption(): boolean

      Whether native resumption is trusted on this session (always false under ZeroDataRetention).

      Returns boolean

    Methods

    • Extracts timing and native-resumption overrides from a session configuration bag.

      Parameters

      • config: Record<string, unknown>

      Returns void

    • Arms (or re-arms) the proactive connection-duration timer for the current connection.

      Returns void

    • Cancels all reconnect and duration timers and abandons any in-flight attempt when closed by the consumer. Tool results held for the attempt are dropped: no new connection will carry them.

      Returns void

    • Holds a tool result that arrives while a reconnect is moving the session, and returns true when it did. Sent then, the result would reach the connection being replaced after the attempt's seed was built, so the new connection would have the call and never its result. A driver calls this first in SendToolResult and returns when it is true. Once the move lands the result goes through SendToolResult again, after callsFromBeforeReseed is rebuilt, so a reseeded connection gets it as a late-result note; a failed reconnect or a close drops it with a warning. Outside a reconnect it returns false and changes nothing.

      Parameters

      • callID: string
      • output: string
      • OptionaltaskRevision: number

      Returns boolean

    • Clears the recorded resumption handle so subsequent reconnects fall back to history seeding.

      Returns void

    • Handles a provider-initiated connection-ending advisory (goAway / session.going_away). Reconnects immediately if idle and ready, or waits for the turn/handle boundary up to the scaled deadline.

      Parameters

      • OptionaltimeLeftMs: number

      Returns void

    • Notifies the reconnect controller when pending tool calls drain on SendToolResult. When expectsReply is true (default), a queued soft-window or ConnectionEnding move waits for the model's post-tool turn (or a fresh trusted native handle) rather than reconnecting in the gap between SendToolResult and the first model output frame.

      Parameters

      • OptionalexpectsReply: boolean

      Returns void

    • Marks a turn as ended and triggers a queued soft-window or ConnectionEnding reconnect if ready.

      Parameters

      • OptionalkeepPostToolTurnWait: boolean

      Returns void

    • Marks a turn as open so soft-window reconnects wait for the turn boundary.

      Returns void

    • Optional capability — registers a handler invoked when the underlying provider connection closes WITHOUT the consumer having called IRealtimeSession.Close (provider-side hangup, network drop). Not fired for a consumer-initiated Close() — the caller already knows about that one.

      Optional because not every provider surface exposes a close signal cheaply; callers must feature-detect (if (session.OnClose) { ... }). An unexpected close is typically ALSO surfaced as a Fatal IRealtimeSession.OnError, which is the signal consumers should drive finalization from.

      Parameters

      • handler: () => void

        Invoked when the provider connection closes unexpectedly.

      Returns void

    • Registers a handler for provider-detected interruptions (barge-in).

      True barge-in only: the handler fires ONLY when user speech interrupts ACTIVE model output — NOT on every user utterance. A user simply taking their normal turn while the model is idle is not an interruption, and drivers must not report it as one (e.g. a raw "speech started" frame must be gated on whether a model response is actually in flight).

      Turn detection / VAD is owned by the provider. The agent layer uses this hook to cancel the model's current turn and to fire the cancellationToken of any in-flight delegated agent run — a stale delegated result must never be narrated into a conversation that has moved on.

      Parameters

      • handler: () => void

        Invoked when the provider reports a true barge-in interruption.

      Returns void

    • Hook invoked when a reconnect attempt succeeds.

      Parameters

      • _usedNativeResumption: boolean

      Returns void

    • Records a provider resumption handle or conversation ID.

      Parameters

      • handle: string
      • Optionalresumable: boolean

      Returns void

    • Registers the set of tools the model may call, translating them into the provider's native function-calling format.

      The Core-level RealtimeToolDefinition is intentionally minimal: BaseRealtimeModel lives in the lowest AI layer and cannot depend on the richer tool metadata defined in higher packages (the agent layer) — doing so would create an illegal upward/circular dependency. The agent layer is responsible for mapping its richer tool metadata down to this Core type before calling RegisterTools, and the concrete driver maps this Core type up to the provider's native function-calling schema.

      Note that some providers (e.g. Eleven Labs) bind to a pre-declared tool set on a server-side agent configuration; for those, the driver maps these definitions onto the pre-declared tool names rather than registering arbitrary schemas at session start.

      Idempotency rule: a post-start registration of a set IDENTICAL to the set supplied at connect time (via RealtimeSessionParams.Tools) MUST be a no-op. Providers that bind their tool set at connect time and cannot re-declare schemas on an open session MUST no-op (and may log) rather than degrade the conversation — e.g. by injecting schema text into the conversation as content. A genuinely DIFFERENT post-start set on such a provider is unsupported and should be surfaced as a warning, not silently mangled.

      Parameters

      Returns Promise<void>

    • Optional capability — asks the model to voice one brief interim update following the given instructions (e.g. "In one short sentence, tell the user the report agent has finished gathering data and is now drafting"). Used by the agent layer to narrate delegated-run progress while a long-running tool/agent call is still in flight.

      Implementations must not collide with an in-flight model response: providers reject or garble overlapping generation requests. A driver must either queue the request until the current response completes or skip it outright — skipping is explicitly acceptable because interim updates are disposable by contract (a stale "still working…" line has no value once the real result lands; the next update or the final result supersedes it).

      Like IRealtimeSession.SendContextNote, this is optional because it models provider capability: drivers whose provider cannot trigger an instructed, one-off spoken response mid-session omit the member, and callers must feature-detect before invoking.

      Parameters

      • instructions: string

        Instructions for the single spoken update (tone, brevity, content).

      Returns boolean

      true when a response was actually triggered, false when it was skipped (e.g. a response is already in flight). A bridge that claimed the speaking floor for this turn uses this to release the floor immediately on a skip — otherwise a skipped trigger would wedge the room until the safety timer. void/undefined from legacy drivers is treated as "triggered" for backward compatibility.

    • Optional capability — injects background context (e.g. delegated-run progress, freshly retrieved data, or a state change the model should be aware of) into the model's conversation without forcing a spoken reply. The model simply has the note available the next time it speaks.

      This is the server-side counterpart of the client-direct BaseRealtimeClient.SendContextNote capability: in the server-bridged topology, the agent layer (e.g. a session runner observing a delegated agent run) calls this to keep the realtime model informed of long-running work so it can narrate naturally when asked or when it next takes the floor.

      Optionality models capability, not laziness: not every provider supports injecting conversation items into an already-open session (some only accept media frames and tool results mid-session). Drivers that cannot inject mid-session omit the member entirely, and callers must feature-detect (if (session.SendContextNote) { ... }) rather than assume it.

      Parameters

      • text: string

        The context note to append to the conversation (plain text; the caller owns any prefixing/framing policy such as "[progress]" markers).

      • Optionaloptions: RealtimeContextNoteOptions

        Optional retention policy (StateKey, Ephemeral, MemoryText) controlling how the note is recorded in RealtimeConversationMemory across mid-call reconnects.

      Returns void

    • Send the result of an executed tool/function call back to the model so it can continue the turn. output is the JSON-stringified tool result. Called by the agent layer after it handles an IRealtimeSession.OnToolCall.

      Parameters

      • callID: string

        The CallID from the originating RealtimeToolCall, used to correlate the result.

      • output: string

        The tool's result as a JSON-stringified string.

      • OptionaltaskRevision: number

        Optional task revision counter from the tool call. If supplied and mismatched, stale results are discarded.

      Returns Promise<void>

      A promise that resolves once the result has been sent to the provider.