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

AudioVisualization.md

178 lines3.3 KB

1---
2id: AudioVisualization
3title: AudioVisualization
4---
5​
6# Interface: AudioVisualization
7​
8Defined in: [packages/typescript/ai/src/realtime/types.ts:200](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/realtime/types.ts#L200)
9​
10Interface for accessing audio visualization data
11​
12## Properties
13​
14### getInputFrequencyData()
15​
16```ts
17getInputFrequencyData: () => Uint8Array;
18```
19​
20Defined in: [packages/typescript/ai/src/realtime/types.ts:207](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/realtime/types.ts#L207)
21​
22Get frequency data for input audio visualization
23​
24#### Returns
25​
26`Uint8Array`
27​
28***
29​
30### getInputTimeDomainData()
31​
32```ts
33getInputTimeDomainData: () => Uint8Array;
34```
35​
36Defined in: [packages/typescript/ai/src/realtime/types.ts:212](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/realtime/types.ts#L212)
37​
38Get time domain data for input waveform
39​
40#### Returns
41​
42`Uint8Array`
43​
44***
45​
46### getOutputFrequencyData()
47​
48```ts
49getOutputFrequencyData: () => Uint8Array;
50```
51​
52Defined in: [packages/typescript/ai/src/realtime/types.ts:209](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/realtime/types.ts#L209)
53​
54Get frequency data for output audio visualization
55​
56#### Returns
57​
58`Uint8Array`
59​
60***
61​
62### getOutputTimeDomainData()
63​
64```ts
65getOutputTimeDomainData: () => Uint8Array;
66```
67​
68Defined in: [packages/typescript/ai/src/realtime/types.ts:214](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/realtime/types.ts#L214)
69​
70Get time domain data for output waveform
71​
72#### Returns
73​
74`Uint8Array`
75​
76***
77​
78### inputLevel
79​
80```ts
81readonly inputLevel: number;
82```
83​
84Defined in: [packages/typescript/ai/src/realtime/types.ts:202](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/realtime/types.ts#L202)
85​
86Input volume level (0-1 normalized)
87​
88***
89​
90### inputSampleRate
91​
92```ts
93readonly inputSampleRate: number;
94```
95​
96Defined in: [packages/typescript/ai/src/realtime/types.ts:217](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/realtime/types.ts#L217)
97​
98Input sample rate
99​
100***
101​
102### onInputAudio()?
103​
104```ts
105optional onInputAudio: (callback) => () => void;
106```
107​
108Defined in: [packages/typescript/ai/src/realtime/types.ts:222](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/realtime/types.ts#L222)
109​
110Subscribe to raw input audio samples
111​
112#### Parameters
113​
114##### callback
115​
116(`samples`, `sampleRate`) => `void`
117​
118#### Returns
119​
120```ts
121(): void;
122```
123​
124##### Returns
125​
126`void`
127​
128***
129​
130### onOutputAudio()?
131​
132```ts
133optional onOutputAudio: (callback) => () => void;
134```
135​
136Defined in: [packages/typescript/ai/src/realtime/types.ts:226](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/realtime/types.ts#L226)
137​
138Subscribe to raw output audio samples
139​
140#### Parameters
141​
142##### callback
143​
144(`samples`, `sampleRate`) => `void`
145​
146#### Returns
147​
148```ts
149(): void;
150```
151​
152##### Returns
153​
154`void`
155​
156***
157​
158### outputLevel
159​
160```ts
161readonly outputLevel: number;
162```
163​
164Defined in: [packages/typescript/ai/src/realtime/types.ts:204](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/realtime/types.ts#L204)
165​
166Output volume level (0-1 normalized)
167​
168***
169​
170### outputSampleRate
171​
172```ts
173readonly outputSampleRate: number;
174```
175​
176Defined in: [packages/typescript/ai/src/realtime/types.ts:219](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/realtime/types.ts#L219)
177​
178Output sample rate