useAudioWaveform
function useAudioWaveform(_trackOrTrackReference?, options?): {
bars: number[];
};Defined in: packages/react/src/hooks/visualizer/useAudioWaveform.ts:40
Note. This feature is experimental and may change or be removed based on developer feedback and real-world usage.
Parameters
| Parameter | Type |
|---|---|
_trackOrTrackReference? | unknown |
options? | UseAudioWaveformOptions |
Returns
{
bars: number[];
}bars
bars: number[];Example
// Basic — compute audio bars for a track.
const { bars } = useAudioWaveform(trackRef, { barCount: 5 });
// Advanced — render a compact custom waveform.
function Waveform({ trackRef }: { trackRef: TrackReferenceOrPlaceholder }) {
const { bars } = useAudioWaveform(trackRef, {
barCount: 12,
updateInterval: 50,
volMultiplier: 2,
});
return <div>{bars.map((height, i) => <span key={i} style={{ height }} />)}</div>;
}