RealtimeProviderAdapter
Defined in: packages/realtime/src/lib/realtime-session/provider-adapter.types.ts:198
A transport with the implemented Maelstrom tool and grounding integration.
Extends
Section titled “Extends”Extended by
Section titled “Extended by”Properties
Section titled “Properties”generatedOpening?
Section titled “generatedOpening?”
readonlyoptionalgeneratedOpening?:AdapterGeneratedOpening
Defined in: packages/realtime/src/lib/realtime-session/provider-adapter.types.ts:207
Optional natural-opening request; it does not satisfy the fixed-text greeting contract.
observations
Section titled “observations”
readonlyobservations:AdapterVoiceObservations
Defined in: packages/realtime/src/lib/realtime-session/provider-adapter.types.ts:205
Continuous transcript and media evidence, separate from the legacy
exhaustive event union. Every adapter defines the feed; each event kind
within it is optional, and media an adapter never reports stays unknown.
Providers without media timestamps can use TranscriptObservationFeed.
Overrides
Section titled “Overrides”RealtimeTransportAdapter.observations
recovery?
Section titled “recovery?”
readonlyoptionalrecovery?:object
Defined in: packages/realtime/src/lib/realtime-session/provider-adapter.types.ts:209
Optional quiet recovery update for application outcomes that settle after reconnect. Never replays tools.
update
Section titled “update”
readonlyupdate: (snapshot) =>void
Parameters
Section titled “Parameters”snapshot
Section titled “snapshot”Returns
Section titled “Returns”void
turnControl?
Section titled “turnControl?”
readonlyoptionalturnControl?:AdapterTurnControl
Defined in: packages/realtime/src/lib/realtime-session/provider-adapter.types.ts:240
Manual control for the current connection generation. It may appear, change, or disappear as the adapter establishes or leaves manual mode; speech-native adapters omit it.
Invariant: RealtimeSession never invokes this. It delegates the current
value to binding/UI code only while retained turnMode is manual.
Methods
Section titled “Methods”connect()
Section titled “connect()”connect(
opts):Promise<void>
Defined in: packages/realtime/src/lib/realtime-session/provider-adapter.types.ts:217
Opens the provider connection. The adapter mints its own ephemeral
credential internally on connect — RealtimeSession never passes one
in.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”RealtimeTransportAdapter.connect
disconnect()
Section titled “disconnect()”disconnect():
Promise<void>
Defined in: packages/realtime/src/lib/realtime-session/provider-adapter.types.ts:218
Releases local participation and bounds provider finalization.
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”RealtimeTransportAdapter.disconnect
getAudioStreams()
Section titled “getAudioStreams()”getAudioStreams():
AdapterAudioStreams
Defined in: packages/realtime/src/lib/realtime-session/provider-adapter.types.ts:220
Streams for UI metering. Never throws; absent streams are undefined.
Returns
Section titled “Returns”Overrides
Section titled “Overrides”RealtimeTransportAdapter.getAudioStreams
injectGrounding()
Section titled “injectGrounding()”injectGrounding(
text):void
Defined in: packages/realtime/src/lib/realtime-session/provider-adapter.types.ts:230
Pushes a terse grounding string into the model’s context. The adapter
owns whatever latest-wins mechanics apply at the wire/session level
(e.g. overwriting session instructions rather than queuing utterances);
RealtimeSession additionally debounces calls into this method so the
adapter is never asked to collapse a rapid burst on its own.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
on(
handler):Unsubscribe
Defined in: packages/realtime/src/lib/realtime-session/provider-adapter.types.ts:231
Subscribes to lifecycle events.
Parameters
Section titled “Parameters”handler
Section titled “handler”(event) => void
Returns
Section titled “Returns”Unsubscribe
Overrides
Section titled “Overrides”sendToolResult()
Section titled “sendToolResult()”sendToolResult(
callId,output):Promise<void>
Defined in: packages/realtime/src/lib/realtime-session/provider-adapter.types.ts:222
Sends a tool call’s result back to the model.
Parameters
Section titled “Parameters”callId
Section titled “callId”ToolCallId
output
Section titled “output”Returns
Section titled “Returns”Promise<void>