Skip to content

OpenAILiveAdapterOptions

Defined in: packages/realtime-openai-live/src/live-adapter.ts:34

Managed tool integration settings. Transport factories and exchange remain host-owned.

readonly optional batchTimeoutMs?: number

Defined in: packages/realtime-openai-live/src/live-adapter.ts:46

Bound for one backend batch, including application results, default 120 seconds. Timeout ends voice; submitted UI work continues.


readonly optional closeTimeoutMs?: number

Defined in: packages/realtime-openai-live/src/live-transport.ts:27

Final-event drain bound after disconnect; default 15 seconds.

LiveTransportOptions.closeTimeoutMs


readonly optional contextTimeoutMs?: number

Defined in: packages/realtime-openai-live/src/live-adapter.ts:48

Bound for each opening, recovery, or grounding acknowledgment, default 30 seconds. Expiry reports unknown delivery, never speech completion.


readonly optional createAudio?: () => HTMLAudioElement

Defined in: packages/realtime-openai-live/src/live-transport.ts:33

Owned audio player factory; playback can be retried through activateAudio.

HTMLAudioElement

LiveTransportOptions.createAudio


readonly optional createPeer?: () => RTCPeerConnection

Defined in: packages/realtime-openai-live/src/live-transport.ts:29

Trusted peer factory, useful for RTC configuration and isolated browser tests.

RTCPeerConnection

LiveTransportOptions.createPeer


readonly exchange: LiveSessionExchange

Defined in: packages/realtime-openai-live/src/live-transport.ts:23

Host-owned SDP exchange, usually an authenticated application route.

LiveTransportOptions.exchange


readonly optional getMicrophone?: () => Promise<MediaStream>

Defined in: packages/realtime-openai-live/src/live-transport.ts:31

Owned microphone acquisition, invoked synchronously by connect in the user gesture.

Promise<MediaStream>

LiveTransportOptions.getMicrophone


readonly optional handshakeTimeoutMs?: number

Defined in: packages/realtime-openai-live/src/live-transport.ts:25

Total startup bound including permission, ICE, HTTP, answer, and session.started; default 45 seconds.

LiveTransportOptions.handshakeTimeoutMs


readonly optional maxCalls?: number

Defined in: packages/realtime-openai-live/src/live-adapter.ts:44

Maximum retained function identities per connection, default 1024. Exhaustion ends voice without replaying work.


readonly optional maxResponses?: number

Defined in: packages/realtime-openai-live/src/live-adapter.ts:42

Maximum retained responses per connection, default 256. Exhaustion ends voice rather than evicting replay protection.


readonly model: string

Defined in: packages/realtime-openai-live/src/live-adapter.ts:36

Voice model selected at startup.


readonly responses: Omit<LiveResponsesConfig, "instructions" | "tools">

Defined in: packages/realtime-openai-live/src/live-adapter.ts:38

Backend model and supported generation settings. The session supplies instructions and tools.


readonly optional voice?: string

Defined in: packages/realtime-openai-live/src/live-adapter.ts:40

Voice selected before media starts; omission uses the provider default.