RealtimeTransportLayer

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

Extends

• EventEmitter<RealtimeTranportEventTypes>

Properties

muted

readonly muted: null | boolean;

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

---

status

status: "connecting" | "connected" | "disconnected" | "disconnecting";

Methods

close()

close(): void;

Closes the connection to the model

Returns

void

---

connect()

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>

---

emit()

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

Type Parameters

Type Parameter
K extends keyof RealtimeTranportEventTypes

Parameters

Parameter	Type
type	K
…args	RealtimeTranportEventTypes[K]

Returns

boolean

Inherited from

EventEmitter.emit

---

interrupt()

interrupt(): void;

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

Returns

void

---

mute()

mute(muted): void;

Mutes the input audio track

Parameters

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

Returns

void

---

off()

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

Type Parameters

Type Parameter
K extends keyof RealtimeTranportEventTypes

Parameters

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

Returns

EventEmitter<RealtimeTranportEventTypes>

Inherited from

EventEmitter.off

---

on()

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

Type Parameters

Type Parameter
K extends keyof RealtimeTranportEventTypes

Parameters

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

Returns

EventEmitter<RealtimeTranportEventTypes>

Inherited from

EventEmitter.on

---

once()

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

Type Parameters

Type Parameter
K extends keyof RealtimeTranportEventTypes

Parameters

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

Returns

EventEmitter<RealtimeTranportEventTypes>

Inherited from

EventEmitter.once

---

resetHistory()

resetHistory(oldHistory, newHistory): void;

Resets the conversation history / context to a specific state

Parameters

Parameter	Type
oldHistory	RealtimeItem[]
newHistory	RealtimeItem[]

Returns

void

---

sendAudio()

sendAudio(audio, options): void;

Sends a raw audio buffer to the model

Parameters

Parameter	Type	Description
audio	ArrayBuffer	The audio buffer to send
options	{ commit?: boolean; }	Additional options
options.commit?	boolean	Whether to commit the audio buffer to the model. If the model does not do turn detection, this can be used to indicate the turn is completed.

Returns

void

---

sendEvent()

sendEvent(event): void;

Sends a raw event to the model

Parameters

Parameter	Type	Description
event	RealtimeClientMessage	The event to send

Returns

void

---

sendFunctionCallOutput()

sendFunctionCallOutput(
   toolCall,
   output,
   startResponse): void;

Sends a function call output to the model

Parameters

Parameter	Type	Description
toolCall	TransportToolCallEvent	The tool call to send
output	string	The output of the tool call
startResponse	boolean	‐

Returns

void

---

sendMessage()

sendMessage(message, otherEventData): void;

Sends a text message to the model

Parameters

Parameter	Type	Description
message	RealtimeUserInput	The message to send
otherEventData	Record<string, any>	Additional event data, will be merged into the event

Returns

void

---

updateSessionConfig()

updateSessionConfig(config): void;

Sends an updated session configuration to the model. Used to update for example the model instructions during a handoff

Parameters

Parameter	Type	Description
config	Partial<RealtimeSessionConfig>	The new session config

Returns

void