0
Fork 0
mirror of https://github.com/TanStack/ai.git synced 2026-11-16 19:38:41 +00:00
ai/docs/reference/interfaces/AudioVisualization.md
github-actions[bot] 5701bf5184
docs: regenerate API documentation (#1141)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-08-18 19:53:35 +02:00

3 KiB

id title
AudioVisualization AudioVisualization

Interface: AudioVisualization

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

Interface for accessing audio visualization data

Properties

getInputFrequencyData

getInputFrequencyData: () => Uint8Array;

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

Get frequency data for input audio visualization

Returns

Uint8Array


getInputTimeDomainData

getInputTimeDomainData: () => Uint8Array;

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

Get time domain data for input waveform

Returns

Uint8Array


getOutputFrequencyData

getOutputFrequencyData: () => Uint8Array;

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

Get frequency data for output audio visualization

Returns

Uint8Array


getOutputTimeDomainData

getOutputTimeDomainData: () => Uint8Array;

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

Get time domain data for output waveform

Returns

Uint8Array


inputLevel

readonly inputLevel: number;

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

Input volume level (0-1 normalized)


inputSampleRate

readonly inputSampleRate: number;

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

Input sample rate


onInputAudio?

optional onInputAudio?: (callback) => () => void;

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

Subscribe to raw input audio samples

Parameters

callback

(samples, sampleRate) => void

Returns

() => void


onOutputAudio?

optional onOutputAudio?: (callback) => () => void;

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

Subscribe to raw output audio samples

Parameters

callback

(samples, sampleRate) => void

Returns

() => void


outputLevel

readonly outputLevel: number;

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

Output volume level (0-1 normalized)


outputSampleRate

readonly outputSampleRate: number;

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

Output sample rate