OpenAIRealtimeBase

The transport layer is the layer that handles the connection to the model and the communication with the model.

Extends

• EventEmitterDelegate<OpenAIRealtimeEventTypes>

Extended by

• OpenAIRealtimeWebRTC
• OpenAIRealtimeWebSocket

Implements

• RealtimeTransportLayer

Constructors

Constructor

new OpenAIRealtimeBase(options?): OpenAIRealtimeBase;

Parameters

Parameter	Type
options?	OpenAIRealtimeBaseOptions

Returns

OpenAIRealtimeBase

Overrides

EventEmitterDelegate<OpenAIRealtimeEventTypes>.constructor

Properties

muted

abstract readonly muted: boolean | null;

Whether the input audio track is currently muted null if the muting is not handled by the transport layer

Implementation of

RealtimeTransportLayer.muted

Accessors

_tracingConfig

Set Signature

set _tracingConfig(tracingConfig): void;

Sets the internal tracing config. This is used to track the tracing config that has been set during the session.create event.

Parameters

Parameter	Type
tracingConfig	RealtimeTracingConfig | null

Returns

void

---

currentModel

Get Signature

get currentModel(): OpenAIRealtimeModels;

The current model that is being used by the transport layer.

Returns

OpenAIRealtimeModels

Set Signature

set currentModel(model): void;

The current model that is being used by the transport layer. Note: The model cannot be changed mid conversation.

Parameters

Parameter	Type
model	OpenAIRealtimeModels

Returns

void

---

status

Get Signature

get abstract status(): "connecting" | "connected" | "disconnected" | "disconnecting";

Returns

"connecting" | "connected" | "disconnected" | "disconnecting"

Implementation of

RealtimeTransportLayer.status

Methods

addImage()

addImage(image, options?): void;

Sends an image to the model

Parameters

Parameter	Type	Description
image	string	The image to send
options?	{ triggerResponse?: boolean; }	Additional options
options.triggerResponse?	boolean	Whether to trigger a response from the model

Returns

void

Implementation of

RealtimeTransportLayer.addImage

---

close()

abstract close(): void;

Closes the connection to the model

Returns

void

Implementation of

RealtimeTransportLayer.close

---

connect()

abstract connect(options): Promise<void>;

Establishes the connection to the model and keeps the connection alive

Parameters

Parameter	Type	Description
options	RealtimeTransportLayerConnectOptions	The options for the connection

Returns

Promise<void>

Implementation of

RealtimeTransportLayer.connect

---

emit()

emit<K>(type, ...args): boolean;

Type Parameters

Type Parameter
K extends keyof RealtimeTransportEventTypes

Parameters

Parameter	Type
type	K
…args	OpenAIRealtimeEventTypes[K]

Returns

boolean

Implementation of

RealtimeTransportLayer.emit

Inherited from

EventEmitterDelegate.emit

---

interrupt()

abstract interrupt(): void;

Interrupts the current turn. Used for example when a guardrail is triggered

Returns

void

Implementation of

RealtimeTransportLayer.interrupt

---

mute()

abstract mute(muted): void;

Mutes the input audio track

Parameters

Parameter	Type	Description
muted	boolean	Whether to mute the input audio track

Returns

void

Implementation of

RealtimeTransportLayer.mute

---

off()

off<K>(type, listener): EventEmitter<EventTypes>;

Type Parameters

Type Parameter
K extends keyof RealtimeTransportEventTypes

Parameters

Parameter	Type
type	K
listener	(…args) => void

Returns

EventEmitter<EventTypes>

Implementation of

RealtimeTransportLayer.off

Inherited from

EventEmitterDelegate.off

---

on()

on<K>(type, listener): EventEmitter<EventTypes>;

Type Parameters

Type Parameter
K extends keyof RealtimeTransportEventTypes

Parameters

Parameter	Type
type	K
listener	(…args) => void

Returns

EventEmitter<EventTypes>

Implementation of

RealtimeTransportLayer.on

Inherited from

EventEmitterDelegate.on

---

once()

once<K>(type, listener): EventEmitter<EventTypes>;

Type Parameters

Type Parameter
K extends keyof RealtimeTransportEventTypes

Parameters

Parameter	Type
type	K
listener	(…args) => void

Returns

EventEmitter<EventTypes>

Implementation of

RealtimeTransportLayer.once

Inherited from

EventEmitterDelegate.once

---

resetHistory()

resetHistory(oldHistory, newHistory): void;

Reset the history of the conversation. This will create a diff between the old and new history and send the necessary events to the Realtime API to update the history.

Parameters

Parameter	Type	Description
oldHistory	RealtimeItem[]	The old history of the conversation.
newHistory	RealtimeItem[]	The new history of the conversation.

Returns

void

Implementation of

RealtimeTransportLayer.resetHistory

---

sendAudio()

sendAudio(audio, options?): void;

Send an audio buffer to the Realtime API. If { commit: true } is passed, the audio buffer will be committed and the model will start processing it. This is necessary if you have disabled turn detection / voice activity detection (VAD).

Parameters

Parameter	Type	Description
audio	ArrayBuffer	The audio buffer to send.
options?	{ commit?: boolean; }	The options for the audio buffer.
options.commit?	boolean	‐

Returns

void

Implementation of

RealtimeTransportLayer.sendAudio

---

sendEvent()

abstract sendEvent(event): void;

Sends a raw event to the model

Parameters

Parameter	Type	Description
event	RealtimeClientMessage	The event to send

Returns

void

Implementation of

RealtimeTransportLayer.sendEvent

---

sendFunctionCallOutput()

sendFunctionCallOutput(
   toolCall,
   output,
   startResponse?): void;

Send the output of a function call to the Realtime API.

Parameters

Parameter	Type	Description
toolCall	TransportToolCallEvent	The tool call to send the output for.
output	string	The output of the function call.
startResponse?	boolean	Whether to start a new response after sending the output.

Returns

void

Implementation of

RealtimeTransportLayer.sendFunctionCallOutput

---

sendMcpResponse()

sendMcpResponse(approvalRequest, approved): void;

Sends a response for an MCP tool call

Parameters

Parameter	Type	Description
approvalRequest	{ approved?: boolean | null; arguments: Record<string, any>; itemId: string; name: string; serverLabel: string; type: "mcp_approval_request"; }	The approval request to respond to
approvalRequest.approved?	boolean | null	‐
approvalRequest.arguments	Record<string, any>	‐
approvalRequest.itemId	string	‐
approvalRequest.name	string	‐
approvalRequest.serverLabel	string	‐
approvalRequest.type	"mcp_approval_request"	‐
approved	boolean	Whether the tool call was approved or rejected

Returns

void

Implementation of

RealtimeTransportLayer.sendMcpResponse

---

sendMessage()

sendMessage(
   message,
   otherEventData,
   __namedParameters?): void;

Send a message to the Realtime API. This will create a new item in the conversation and trigger a response.

Parameters

Parameter	Type	Description
message	RealtimeUserInput	The message to send.
otherEventData	Record<string, any>	Additional event data to send.
__namedParameters?	{ triggerResponse?: boolean; }	‐
__namedParameters.triggerResponse?	boolean	‐

Returns

void

Implementation of

RealtimeTransportLayer.sendMessage

---

updateSessionConfig()

updateSessionConfig(config): void;

Updates the session config. This will merge it with the current session config with the default values and send it to the Realtime API.

Parameters

Parameter	Type	Description
config	Partial<RealtimeSessionConfig>	The session config to update.

Returns

void

Implementation of

RealtimeTransportLayer.updateSessionConfig