Skip to content
Source
Sign inSign up
TanStack/ai
Open History to see the last commit

RealtimeConnection.md

247 lines3.9 KB

1---
2id: RealtimeConnection
3title: RealtimeConnection
4---
5​
6# Interface: RealtimeConnection
7​
8Defined in: [packages/ai/src/realtime/types.ts:339](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L339)
9​
10Connection interface representing an active realtime session.
11Handles audio I/O, events, and session management.
12​
13## Properties
14​
15### disconnect()
16​
17```ts
18disconnect: () => Promise<void>;
19```
20​
21Defined in: [packages/ai/src/realtime/types.ts:342](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L342)
22​
23Disconnect from the realtime session
24​
25#### Returns
26​
27`Promise`\<`void`\>
28​
29***
30​
31### getAudioVisualization()
32​
33```ts
34getAudioVisualization: () => AudioVisualization;
35```
36​
37Defined in: [packages/ai/src/realtime/types.ts:379](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L379)
38​
39Get audio visualization data
40​
41#### Returns
42​
43[`AudioVisualization`](AudioVisualization.md)
44​
45***
46​
47### interrupt()
48​
49```ts
50interrupt: () => void;
51```
52​
53Defined in: [packages/ai/src/realtime/types.ts:368](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L368)
54​
55Interrupt the current response
56​
57#### Returns
58​
59`void`
60​
61***
62​
63### on()
64​
65```ts
66on: <TEvent>(event, handler) => () => void;
67```
68​
69Defined in: [packages/ai/src/realtime/types.ts:372](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L372)
70​
71Subscribe to connection events
72​
73#### Type Parameters
74​
75##### TEvent
76​
77`TEvent` *extends* [`RealtimeEvent`](../type-aliases/RealtimeEvent.md)
78​
79#### Parameters
80​
81##### event
82​
83`TEvent`
84​
85##### handler
86​
87[`RealtimeEventHandler`](../type-aliases/RealtimeEventHandler.md)\<`TEvent`\>
88​
89#### Returns
90​
91```ts
92(): void;
93```
94​
95##### Returns
96​
97`void`
98​
99***
100​
101### sendImage()
102​
103```ts
104sendImage: (imageData, mimeType) => void;
105```
106​
107Defined in: [packages/ai/src/realtime/types.ts:356](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L356)
108​
109Send an image to the conversation
110​
111#### Parameters
112​
113##### imageData
114​
115`string`
116​
117##### mimeType
118​
119`string`
120​
121#### Returns
122​
123`void`
124​
125***
126​
127### sendText()
128​
129```ts
130sendText: (text) => void;
131```
132​
133Defined in: [packages/ai/src/realtime/types.ts:352](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L352)
134​
135Send a text message (fallback for when voice isn't available)
136​
137#### Parameters
138​
139##### text
140​
141`string`
142​
143#### Returns
144​
145`void`
146​
147***
148​
149### sendToolResult()
150​
151```ts
152sendToolResult: (callId, result) => void;
153```
154​
155Defined in: [packages/ai/src/realtime/types.ts:360](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L360)
156​
157Send a tool execution result back to the provider
158​
159#### Parameters
160​
161##### callId
162​
163`string`
164​
165##### result
166​
167`string`
168​
169#### Returns
170​
171`void`
172​
173***
174​
175### startAudioCapture()
176​
177```ts
178startAudioCapture: () => Promise<void>;
179```
180​
181Defined in: [packages/ai/src/realtime/types.ts:346](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L346)
182​
183Start capturing audio from the microphone
184​
185#### Returns
186​
187`Promise`\<`void`\>
188​
189***
190​
191### stopAudioCapture()
192​
193```ts
194stopAudioCapture: () => void;
195```
196​
197Defined in: [packages/ai/src/realtime/types.ts:348](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L348)
198​
199Stop capturing audio
200​
201#### Returns
202​
203`void`
204​
205***
206​
207### updateSession()
208​
209```ts
210updateSession: (config) => void;
211```
212​
213Defined in: [packages/ai/src/realtime/types.ts:364](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L364)
214​
215Update session configuration
216​
217#### Parameters
218​
219##### config
220​
221`Partial`\<[`RealtimeSessionConfig`](RealtimeSessionConfig.md)\>
222​
223#### Returns
224​
225`void`
226​
227***
228​
229### updateToken()?
230​
231```ts
232optional updateToken: (token) => void;
233```
234​
235Defined in: [packages/ai/src/realtime/types.ts:366](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L366)
236​
237Update the ephemeral token (e.g. on refresh); provider may reconnect
238​
239#### Parameters
240​
241##### token
242​
243[`RealtimeToken`](RealtimeToken.md)
244​
245#### Returns
246​
247`void`