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

AudioVisualization.md

178 lines3.3 KB

Interface: AudioVisualization

Defined in: packages/typescript/ai/src/realtime/types.ts:200

Interface for accessing audio visualization data

Properties

getInputFrequencyData()

getInputFrequencyData: () => Uint8Array;

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

Get frequency data for input audio visualization

Returns

Uint8Array


getInputTimeDomainData()

getInputTimeDomainData: () => Uint8Array;

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

Get time domain data for input waveform

Returns

Uint8Array


getOutputFrequencyData()

getOutputFrequencyData: () => Uint8Array;

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

Get frequency data for output audio visualization

Returns

Uint8Array


getOutputTimeDomainData()

getOutputTimeDomainData: () => Uint8Array;

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

Get time domain data for output waveform

Returns

Uint8Array


inputLevel

readonly inputLevel: number;

Defined in: packages/typescript/ai/src/realtime/types.ts:202

Input volume level (0-1 normalized)


inputSampleRate

readonly inputSampleRate: number;

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

Input sample rate


onInputAudio()?

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

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

Subscribe to raw input audio samples

Parameters

callback

(samples, sampleRate) => void

Returns

(): void;
Returns

void


onOutputAudio()?

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

Defined in: packages/typescript/ai/src/realtime/types.ts:226

Subscribe to raw output audio samples

Parameters

callback

(samples, sampleRate) => void

Returns

(): void;
Returns

void


outputLevel

readonly outputLevel: number;

Defined in: packages/typescript/ai/src/realtime/types.ts:204

Output volume level (0-1 normalized)


outputSampleRate

readonly outputSampleRate: number;

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

Output sample rate