OpenAILiveTransport
Defined in: packages/realtime-openai-live/src/live-transport.ts:122
Explicit WebRTC transport with L1 continuous observations. Managed function execution and Maelstrom grounding belong to a separate integration. Finish required Responses function outputs before calling disconnect: session.close rejects later commands. This transport never reconnects or replays commands.
Implements
Section titled “Implements”RealtimeTransportAdapter<LiveSessionConfig>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new OpenAILiveTransport(
options):OpenAILiveTransport
Defined in: packages/realtime-openai-live/src/live-transport.ts:155
Creates an inert transport. No media or billed session starts until connect.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”OpenAILiveTransport
Properties
Section titled “Properties”observations
Section titled “observations”
readonlyobservations:AdapterVoiceObservations
Defined in: packages/realtime-openai-live/src/live-transport.ts:145
Optional continuous evidence channel; transcript fragments never imply final turns.
Implementation of
Section titled “Implementation of”RealtimeTransportAdapter.observations
Methods
Section titled “Methods”activateAudio()
Section titled “activateAudio()”activateAudio():
Promise<void>
Defined in: packages/realtime-openai-live/src/live-transport.ts:241
Retries output playback within a user action. Resolution means play acceptance, not audible delivery.
Returns
Section titled “Returns”Promise<void>
connect()
Section titled “connect()”connect(
session):Promise<void>
Defined in: packages/realtime-openai-live/src/live-transport.ts:201
Starts microphone acquisition within the caller’s user activation; concurrent starts share one attempt.
Parameters
Section titled “Parameters”session
Section titled “session”LiveSessionConfig
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”RealtimeTransportAdapter.connect
disconnect()
Section titled “disconnect()”disconnect():
Promise<void>
Defined in: packages/realtime-openai-live/src/live-transport.ts:279
Stops participation promptly, then drains session.closed for a bounded interval. Never waits for host tool work.
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”RealtimeTransportAdapter.disconnect
getAudioStreams()
Section titled “getAudioStreams()”getAudioStreams():
AdapterAudioStreams
Defined in: packages/realtime-openai-live/src/live-transport.ts:195
Returns current streams for metering; local participation disappears immediately on stop.
Returns
Section titled “Returns”AdapterAudioStreams
Implementation of
Section titled “Implementation of”RealtimeTransportAdapter.getAudioStreams
getSnapshot()
Section titled “getSnapshot()”getSnapshot():
LiveTransportSnapshot
Defined in: packages/realtime-openai-live/src/live-transport.ts:168
Returns detached lifecycle and final provider evidence; native fields cannot mutate transport state.
Returns
Section titled “Returns”on(
handler): () =>void
Defined in: packages/realtime-openai-live/src/live-transport.ts:179
Subscribes to legacy lifecycle events without fabricating turn activity.
Parameters
Section titled “Parameters”handler
Section titled “handler”(event) => void
Returns
Section titled “Returns”() => void
Implementation of
Section titled “Implementation of”RealtimeTransportAdapter.on
onServerEvent()
Section titled “onServerEvent()”onServerEvent(
handler): () =>void
Defined in: packages/realtime-openai-live/src/live-transport.ts:186
Subscribes to validated native envelopes. Nested Responses payloads require consumer validation.
Parameters
Section titled “Parameters”handler
Section titled “handler”(event, generation) => void
Returns
Section titled “Returns”() => void
send()
Section titled “send()”send(
command,generation):void
Defined in: packages/realtime-openai-live/src/live-transport.ts:251
Submits one command only to the supplied generation. There is no queue, retry, or success acknowledgment.
Parameters
Section titled “Parameters”command
Section titled “command”LiveCommand
generation
Section titled “generation”number
Returns
Section titled “Returns”void
subscribe()
Section titled “subscribe()”subscribe(
handler): () =>void
Defined in: packages/realtime-openai-live/src/live-transport.ts:172
Observes metadata changes, including autoplay recovery and finalization.
Parameters
Section titled “Parameters”handler
Section titled “handler”() => void
Returns
Section titled “Returns”() => void