Optionalmodel: BaseRealtimeModelOptionalparams: RealtimeSessionParamsProtectedcallsProtectedclosedProtectedconfiguredProtectedconfiguredProtectedconfiguredProtectedconfiguredProtectedconfiguredProtected ReadonlyconversationProtected Optional ReadonlymodelProtected ReadonlypendingProtected ReadonlyreconnectProtectedturnEffective 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.
Accessor for the session's provider-neutral conversation memory ledger.
ProtectedDefaultStatic driver default connection duration in seconds when metadata does not specify one.
ProtectedDefaultDriver default for whether native resumption handles are trusted when metadata does not override.
True once the consumer has closed the session.
True while an in-place reconnect is currently running.
Buffer in seconds before CallDurationSeconds at which the framework initiates a reconnect.
ProtectedRequiresWhether 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.
Latest recorded provider resumption handle, or null if none.
ProtectedRuntimeDynamic 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.
Configured credential/session lifetime in seconds, when distinct from CallDurationSeconds.
Whether native resumption is trusted on this session (always false under ZeroDataRetention).
Extracts timing and native-resumption overrides from a session configuration bag.
Arms (or re-arms) the proactive connection-duration timer for the current connection.
Binds the underlying socket. Called by the driver once the websocket is open.
Closes the session and releases the underlying provider connection.
A promise that resolves once the session is fully closed.
ProtectedDisposeCancels 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.
ProtectedemitEmits a session error to the consumer's registered OnError handler(s).
ProtectedformatFormats the fatal error message surfaced when all reconnect attempts fail.
Entry point for an inbound websocket frame. Multiplexes on type to focused
per-concern handlers so each translation unit stays small and testable.
OptionalfromSocket: ElevenLabsRealtimeSocketSurfaces an UNEXPECTED socket close as a fatal error (expected closes — the consumer called Close — are silent). ElevenLabs hard-closes at signed-URL expiry and when the agent itself ends the conversation, so this is also how credential / conversation death reaches the consumer.
Optionalcode: numberOptionalreason: stringOptionalfromSocket: ElevenLabsRealtimeSocketSurfaces a websocket-level failure as a FATAL session error — the transport is gone, so the consumer should finalize cleanly instead of idling (driver obligation #6).
OptionalfromSocket: ElevenLabsRealtimeSocketProtectedholdHolds 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.
OptionaltaskRevision: numberClears the recorded resumption handle so subsequent reconnects fall back to history seeding.
Returns true when candidate is the active or currently-handshaking replacement socket.
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.
OptionaltimeLeftMs: numberProtectedNotifyNotifies 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.
OptionalexpectsReply: booleanMarks a turn as ended and triggers a queued soft-window or ConnectionEnding reconnect if ready.
OptionalkeepPostToolTurnWait: booleanMarks a turn as open so soft-window reconnects wait for the turn boundary.
Registers a handler for session errors.
Fatality semantics mirror the client-side BaseRealtimeClient contract:
Fatal: true — the session is unusable (transport/socket failure, credential/token
expiry, unexpected connection loss). The consumer should finalize the session (e.g.
RealtimeSessionRunner calls Stop()) instead of idling forever on a dead socket.Fatal: false — a provider-reported, recoverable error frame; the session stays open
and the consumer should log and continue.Invoked with each RealtimeSessionError.
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.
Invoked when the provider reports a true barge-in interruption.
Registers a handler for model audio output frames (the audio media plane).
Invoked with each output audio frame as an ArrayBuffer.
ProtectedonHook invoked when a reconnect attempt succeeds.
ProtectedonHook invoked when all reconnect attempts fail or the rapid-reconnect circuit breaker trips.
Formats the error message via formatReconnectFailureMessage and emits a fatal
RealtimeSessionError with Code: code via emitSessionError.
Optionalcode: RealtimeReconnectFailureCodeProtectedonRegisters a handler for model tool-call requests.
Consumers execute the requested tool (under the session's context user) and feed the result back to the model.
Invoked with each RealtimeToolCall.
Registers a handler for transcript events (the text stream).
Consumers typically forward these to the control plane and persist them as
ConversationDetail records.
Invoked with each RealtimeTranscript (partial or final).
ProtectedReconnectReconnects the ElevenLabs conversation websocket by minting a fresh signed URL, opening a
replacement socket, sending initiation overrides (with first_message stripped so the
greeting is not repeated), and injecting accumulated conversation history as a
contextual_update once metadata is confirmed — promoting this.socket only after the
replacement handshake completes.
Records a provider resumption handle or conversation ID.
Optionalresumable: booleanRecords a finalized turn or tool entry in conversationMemory.
binds the tool set on the server-side AGENT configuration (the driver's managed-agent ensure flow), not on the open conversation. Per the contract's idempotency rule: an identical post-start set is a silent no-op; a different set is unsupported on an open conversation — it logs a clear warning and does nothing (the NEXT session picks the new set up via the ensure flow's fingerprint check).
Optionaloptions: RealtimeContextNoteOptionsSends the conversation_initiation_client_data frame carrying the session's overrides
(the per-session system prompt, and the voice when one is configured), which the managed
agent's platform settings enable. The override object is built by
ElevenLabsRealtime.BuildSessionOverrides and passed in already wire-shaped, so
this server-bridged path and the client-direct mint cannot drift apart.
initialContext, when provided, is held back and injected as a native
contextual_update once the metadata confirms the session — ElevenLabs has no pre-turn
history-seeding channel, so prior context rides the contextual-update lane.
The wire-shaped conversation_config_override for this session.
OptionalinitialContext: stringOptional prior context to inject once the session is confirmed.
OptionaltargetSocket: ElevenLabsRealtimeSocketOptional socket to send the initiation frame on (used during reconnect handshake).
client_tool_result correlated by tool_call_id. Sent IMMEDIATELY (never queued behind
a reply): the platform requested the result (expects_response: true blocks the conversation on
it) and handles its own continuation, so deferring it could only delay the spoken reply. The one
wait is a reconnect: the result is held and sent on the new socket (holdToolResultDuringReconnect).
The result string rides as given, never parsed.
Records the tool set bound at connect time. Called by ElevenLabsRealtime.StartSession.
Registers the factory used to mint a fresh signed URL and open a replacement conversation socket.
Initiates an in-place reconnect via the unified RealtimeReconnectController.
Resolves once the server's conversation_initiation_metadata arrives (the provider's
confirmation that the session — including the prompt override — is applied); rejects if
the transport dies first. Awaited by ElevenLabsRealtime.StartSession so the
session is never handed to a consumer before it is actually configured.
Concrete IRealtimeSession backed by a raw ElevenLabs Agents conversation websocket.
Owns the inbound translation (snake_case wire events → Core events) and the outbound translation (Core calls → wire frames). Created by ElevenLabsRealtime.StartSession; never instantiated directly by consumers.
Provider-behavior notes (the contract deltas a consumer should know):
user_transcript/agent_responseevents — there are no interim deltas, so every RealtimeTranscript this session emits hasIsFinal: true.agent_response_correctionre-finalizes a truncated turn. After a barge-in the platform sends the corrected (actually-spoken) agent text; the session emits it as a fresh FINAL assistant transcript — consumers persisting transcripts should treat a final assistant transcript arriving immediately after an interruption as the authoritative replacement for the previous one.user_messageturn (ElevenLabs has no per-response-instructions channel), queued behind any in-flight response. Fidelity caveat: the instruction enters the conversation as a user turn, so the agent may occasionally reference it ("you asked me to give an update") — hosts should phrase instructions accordingly. SendContextNote is NATIVE (contextual_update) and never interrupts.