AbstractStatic ReadonlyDriverStatic facts about this driver, readable before a session instance exists.
Default is a frozen {} (everything unknown), shared by every driver without an override, so it must never be mutated.
Subclasses declare public static override readonly DriverFacts: Readonly<RealtimeDriverFacts> = { ... }.
Read at runtime via RealtimeDriverFactsOf, not directly, so subclass statics win.
Static Optional ReadonlySupportsWhether this driver subclass supports dynamic, multi-tool sets projected into the realtime session (e.g. direct action invocation on realtime co-agents).
Static capability descriptor read before a session instance exists.
Default: absent / false. Subclasses that support dynamic toolsets declare public static readonly SupportsDynamicToolSet = true;.
ProtectedapiOnly sub-classes can access the API key
Readonly getter returning the model driver's connection duration in seconds.
Static driver default for a single connection's duration in seconds (for example, 600 on
GeminiRealtime and GeminiEnterpriseRealtime, 3600 on OpenAIRealtime and
OpenAILiveRealtime, 7200 on xAIRealtime). Defaults to DriverFacts.ProviderMaxSessionSeconds.
Buffer in seconds before CallDurationSeconds at which the framework initiates a
proactive reconnect. Defaults to DEFAULT_REALTIME_RECONNECT_BUFFER_SECONDS (10s).
Dynamic runtime override hook on the model driver (returns undefined unless overridden by a subclass).
Static fallback list of provider-native voices supported by this driver when metadata personas are not present or sparse.
NOTE: Database metadata (MJ: AI Personas + AI Model Personas) is authoritative where configured.
At runtime, GetRealtimeModelVoices unions metadata personas with this driver fallback list so that
newly uncatalogued provider voices remain selectable while catalogued personas carry curated names/descriptions.
The supported voice ids (id + human label), or [] when none are declared.
Whether this driver can mint an ephemeral, server-scoped client credential for a client-direct realtime session (the browser opens its own provider socket using a short-lived token the server minted).
Defaults to false. Providers that support browser-direct sessions override this to true
and implement CreateClientSession. The server-bridged topology (where the provider
socket lives on the server, via StartSession) is supported by every driver regardless
of this flag.
true if CreateClientSession is supported; false otherwise.
Whether this driver's sessions carry a video track in addition to audio.
false in every MJ driver.
Nothing reads it, and no driver overrides it: it is false for Gemini Live, which takes camera video
and renders avatars. What a session does with video is declared on its IRealtimeSession.Capabilities:
RealtimeSessionCapabilities.SupportedInboundTracks for video in and
RealtimeSessionCapabilities.SupportedOutboundTracks for video out, each track with its encoding. Whether a
model renders a live avatar is SupportsAvatarOutput. A driver declares video there, not here.
Whether this driver supports and trusts the provider's native session resumption on the
active endpoint when a handle is present. Subclasses override as needed (e.g., true on
server-side GeminiRealtime, GeminiEnterpriseRealtime, and xAIRealtime; false on
OpenAIRealtime).
ProtectedClampReturns the smallest candidate that is a positive integer; see ClampSessionSecondsValue. The rule "the caller's bag wins only if smaller" lives there, once: pass the provider cap and the bag cap together.
Resolves whether native resumption is trusted for a client-direct session minted by this driver,
given the transport ('direct' vs 'relay'). Subclasses override when client-direct trust
differs from server-bridged trust (e.g., GeminiRealtime is true on server v1beta keys
but false on browser-direct v1alpha ephemeral tokens).
Mints an ephemeral, server-scoped client credential plus a provider-native session config for a client-direct realtime session.
In the client-direct topology the browser owns the provider socket (e.g. WebRTC), but the
server still controls the prompt and tool set: it mints a short-lived token and hands back
a ClientRealtimeSessionConfig whose SessionConfig the matching client driver applies
when it opens its socket. This keeps prompt/tool authority server-side even though the media
plane is client-direct.
Not every provider supports this (some only expose a server-bridged socket), so this is a
concrete method that throws by default rather than an abstract one — that would force every
existing and future driver to implement it. Providers that support it override
SupportsClientDirect to true and override this method.
The session parameters (system prompt, tools, model, config bag).
A promise resolving to the minted ClientRealtimeSessionConfig.
OptionalExchangeOptional WebRTC SDP exchange seam for drivers that support server-brokered WebRTC topologies.
The local SDP offer generated by the browser.
Optional_sessionConfig: Record<string, unknown>The session configuration to initialize the session with.
The answer SDP, provider session ID, and any prebill accounting.
Internal bridge allowing BaseRealtimeSession to invoke the model driver's protected ReconnectSession.
ProtectedReconnectReconnect hook for server-hosted IRealtimeSession instances created by StartSession.
Called by BaseRealtimeSession's duration timer (CallDurationSeconds - ReconnectBufferSeconds)
or on unexpected transport close when resumable. Concrete provider drivers override this method.
Mints a fresh client credential (ephemeral token or signed URL) for an already-running client-direct session during a mid-call credential refresh or reconnect.
Defaults to delegating to CreateClientSession. Drivers where CreateClientSession
has side effects beyond credential minting (such as ElevenLabsRealtime, which provisions
a managed agent when no agentId is given) override this to mint a credential for the
existing resource in existingSessionConfig without creating duplicate vendor resources.
Optional_existingSessionConfig: JSONObjectResolves the effective single-connection duration in seconds from an open config bag
(connectionMaxSeconds), narrowing this.CallDurationSeconds via ResolveRealtimeTiming.
Optionalconfig: Record<string, unknown>Resolves the effective reconnect buffer in seconds from an open config bag
(reconnectBufferSeconds), falling back to this.ReconnectBufferSeconds.
Optionalconfig: Record<string, unknown>Resolves whether native session resumption is trusted for a session from an open config bag
(trustNativeResumption), falling back to defaultTrust (or this.TrustsNativeResumption).
Optionalconfig: Record<string, unknown>AbstractStartOpens a stateful duplex session with the provider.
The returned IRealtimeSession is the long-lived handle that streams media and transcripts in both directions, surfaces tool calls and usage telemetry, and reports provider-detected interruptions (barge-in). The caller is responsible for closing the session via IRealtimeSession.Close.
Configuration for the session (system prompt, tools, initial context, model, and an open config bag).
A promise resolving to the live session handle.
Whether this driver's sessions can render a live avatar for the model, on the endpoint the driver serves.
Defaults to false: a driver whose models render no avatar says nothing more, and may ignore an avatar request. A
driver that renders one for some models (Gemini Enterprise) overrides it. The client-session service reads it to
tell a call or a meeting that asked for an avatar "this voice model can't show an avatar"
(RealtimeAvatarUnavailableReason 'endpoint'), whichever driver serves it.
The provider's API name for the model.
true when sessions on this model can render a live avatar; false otherwise.
Base AI model class, used for everything else in the MemberJunction AI environment