RealtimeConnection

Defined in: packages/ai/src/realtime/types.ts:339

Connection interface representing an active realtime session. Handles audio I/O, events, and session management.

Properties#

disconnect#

disconnect: () => Promise<void>;

Defined in: packages/ai/src/realtime/types.ts:342

Disconnect from the realtime session

Returns#

Promise<void>

getAudioVisualization#

getAudioVisualization: () => AudioVisualization;

Defined in: packages/ai/src/realtime/types.ts:379

Get audio visualization data

Returns#

AudioVisualization

interrupt#

interrupt: () => void;

Defined in: packages/ai/src/realtime/types.ts:368

Interrupt the current response

Returns#

void

on#

on: <TEvent>(event, handler) => () => void;

Defined in: packages/ai/src/realtime/types.ts:372

Subscribe to connection events

Type Parameters#

TEvent#

TEvent extends RealtimeEvent

Parameters#

event#

TEvent

handler#

RealtimeEventHandler<TEvent>

Returns#

() => void

sendImage#

sendImage: (imageData, mimeType) => void;

Defined in: packages/ai/src/realtime/types.ts:356

Send an image to the conversation

Parameters#

imageData#

string

mimeType#

string

Returns#

void

sendText#

sendText: (text) => void;

Defined in: packages/ai/src/realtime/types.ts:352

Send a text message (fallback for when voice isn't available)

Parameters#

text#

string

Returns#

void

sendToolResult#

sendToolResult: (callId, result) => void;

Defined in: packages/ai/src/realtime/types.ts:360

Send a tool execution result back to the provider

Parameters#

callId#

string

result#

string

Returns#

void

startAudioCapture#

startAudioCapture: () => Promise<void>;

Defined in: packages/ai/src/realtime/types.ts:346

Start capturing audio from the microphone

Returns#

Promise<void>

stopAudioCapture#

stopAudioCapture: () => void;

Defined in: packages/ai/src/realtime/types.ts:348

Stop capturing audio

Returns#

void

updateSession#

updateSession: (config) => void;

Defined in: packages/ai/src/realtime/types.ts:364

Update session configuration

Parameters#

config#

Partial<RealtimeSessionConfig>

Returns#

void

updateToken?#

optional updateToken?: (token) => void;

Defined in: packages/ai/src/realtime/types.ts:366

Update the ephemeral token (e.g. on refresh); provider may reconnect

Parameters#

token#

RealtimeToken

Returns#

void