OpenAILiveAdapterOptions
Defined in: packages/realtime-openai-live/src/live-adapter.ts:34
Managed tool integration settings. Transport factories and exchange remain host-owned.
Extends
Section titled “Extends”Properties
Section titled “Properties”batchTimeoutMs?
Section titled “batchTimeoutMs?”
readonlyoptionalbatchTimeoutMs?: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.
closeTimeoutMs?
Section titled “closeTimeoutMs?”
readonlyoptionalcloseTimeoutMs?:number
Defined in: packages/realtime-openai-live/src/live-transport.ts:27
Final-event drain bound after disconnect; default 15 seconds.
Inherited from
Section titled “Inherited from”LiveTransportOptions.closeTimeoutMs
contextTimeoutMs?
Section titled “contextTimeoutMs?”
readonlyoptionalcontextTimeoutMs?: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.
createAudio?
Section titled “createAudio?”
readonlyoptionalcreateAudio?: () =>HTMLAudioElement
Defined in: packages/realtime-openai-live/src/live-transport.ts:33
Owned audio player factory; playback can be retried through activateAudio.
Returns
Section titled “Returns”HTMLAudioElement
Inherited from
Section titled “Inherited from”LiveTransportOptions.createAudio
createPeer?
Section titled “createPeer?”
readonlyoptionalcreatePeer?: () =>RTCPeerConnection
Defined in: packages/realtime-openai-live/src/live-transport.ts:29
Trusted peer factory, useful for RTC configuration and isolated browser tests.
Returns
Section titled “Returns”RTCPeerConnection
Inherited from
Section titled “Inherited from”LiveTransportOptions.createPeer
exchange
Section titled “exchange”
readonlyexchange:LiveSessionExchange
Defined in: packages/realtime-openai-live/src/live-transport.ts:23
Host-owned SDP exchange, usually an authenticated application route.
Inherited from
Section titled “Inherited from”getMicrophone?
Section titled “getMicrophone?”
readonlyoptionalgetMicrophone?: () =>Promise<MediaStream>
Defined in: packages/realtime-openai-live/src/live-transport.ts:31
Owned microphone acquisition, invoked synchronously by connect in the user gesture.
Returns
Section titled “Returns”Promise<MediaStream>
Inherited from
Section titled “Inherited from”LiveTransportOptions.getMicrophone
handshakeTimeoutMs?
Section titled “handshakeTimeoutMs?”
readonlyoptionalhandshakeTimeoutMs?: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.
Inherited from
Section titled “Inherited from”LiveTransportOptions.handshakeTimeoutMs
maxCalls?
Section titled “maxCalls?”
readonlyoptionalmaxCalls?: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.
maxResponses?
Section titled “maxResponses?”
readonlyoptionalmaxResponses?: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.
readonlymodel:string
Defined in: packages/realtime-openai-live/src/live-adapter.ts:36
Voice model selected at startup.
responses
Section titled “responses”
readonlyresponses: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.
voice?
Section titled “voice?”
readonlyoptionalvoice?:string
Defined in: packages/realtime-openai-live/src/live-adapter.ts:40
Voice selected before media starts; omission uses the provider default.