react-audio-spectrum3

React Audio Spectrum

An audio spectrum visualizer for react, made in Typescript.

This is a fork of Mitch Mason's react-av package

Getting Started

<audio id="audio-element"
  src="path/to/song.mp3"
  controls
>
</audio>
<AudioSpectrum
  id="audio-canvas"
  height={200}
  width={300}
  audioId={'audio-element'}
  capColor={'red'}
  capHeight={2}
  meterWidth={2}
  meterCount={512}
  meterColor={[
    {stop: 0, color: '#4CAF40'},
    {stop: 0.5, color: '#0CD7FD'},
    {stop: 1, color: '#000'}
  ]}
  gap={4}
/>

you can also pass the audio element itself to the component

this.audioEle = new Audio('path/to/your/song.mp3')
<AudioSpectrum
  id="audio-canvas"
  height={200}
  width={300}
  audioEle={this.audioEle}
/>

if you use both audioId and audioEle props, the component will ignore audioEle.

Props

property	description	type	default
id	canvas id	number/string	a random string
width	canvas width	number	300
height	canvas height	number	200
audioId	id of the target audio element	number/string	-
audioEle	target audio element	audio object	-
capColor	color of caps	string	#FFF
capHeight	height of caps	string	2
disableCap	shows or hides caps	boolean	false
meterWidth	width of meters	number	2
meterColor	color of meters	string/array	[{stop: 0, color: '#f00'},{stop: 0.5, color: '#0CD7FD'},{stop: 1, color: 'red'}]
gap	gap between meters	number	10
fftSize	window size in samples	number	2048 (must be between 32-32768 & a power of 2)
smoothingTimeConstant	averaging constant with the last analysis frame	number	0.8 (must be between 0-1)
audioContext	optional AudioContext to use (or will create its own instance)	AudioContext	undefined

As well as any props available for the <canvas> element.

Main differences between this fork and Mytch Mason version:

• Removed the "Hyper-hacky way to reinit" part as it prevents to pause the Audio element
• Updated dependencies
• Refactored a few things
• Changed some functions to useCallbacks as they had some dependencies