1.1.3 • Published 10 months ago

react-audio-visualize v1.1.3

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

react-audio-visualize

An audio visualizer for React. Provides separate components to visualize both live audio and audio blobs.

Installation

npm install react-audio-visualize

AudioVisualizer Component (Example)

screenshot

import React, { useState } from 'react';
import { AudioVisualizer } from 'react-audio-visualize';

const Visualizer = () => {
  const [blob, setBlob] = useState<Blob>();
  const visualizerRef = useRef<HTMLCanvasElement>(null)

  // set blob somewhere in code

  return (
    <div>
      {blob && (
        <AudioVisualizer
          ref={visualizerRef}
          blob={blob}
          width={500}
          height={75}
          barWidth={1}
          gap={0}
          barColor={'#f76565'}
        />
      )}
    </div>
  )
}
PropsDescriptionDefaultOptional
blobAudio blob to visualizeN/ANo
widthWidth of the visualizerN/ANo
heightHeight of the visualizerN/ANo
barWidthWidth of each individual bar in the visualization2Yes
gapGap between each bar in the visualization1Yes
backgroundColorBackgroundColor for the visualizationtransparentYes
barColorColor for the bars that have not yet been played"rgb(184, 184, 184)""Yes
barPlayedColorColor for the bars that have been played"rgb(160, 198, 255)""Yes
currentTimeCurrent time stamp till which the audio blob has been played. Visualized bars that fall before the current time will have barPlayerColor, while that ones that fall after will have barColorN/AYes
styleCustom styles that can be passed to the visualization canvasN/AYes
refA ForwardedRef for the HTMLCanvasElementN/AYes

LiveAudioVisualizer Component (Example)

livevisualizergif

import React, { useState } from 'react';
import { LiveAudioVisualizer } from 'react-audio-visualize';

const Visualizer = () => {
  const [mediaRecorder, setMediaRecorder] = useState<MediaRecorder>();

  // set media recorder somewhere in code

  return (
    <div>
      {mediaRecorder && (
        <LiveAudioVisualizer
          mediaRecorder={mediaRecorder}
          width={200}
          height={75}
        />
      )}
    </div>
  )
}
PropsDescriptionDefaultOptional
mediaRecorderMedia recorder who's stream needs to visualizedN/ANo
widthWidth of the visualizer100%Yes
heightHeight of the visualizer100%Yes
barWidthWidth of each individual bar in the visualization2Yes
gapGap between each bar in the visualization1Yes
backgroundColorBackgroundColor for the visualizationtransparentYes
barColorColor for the bars that have not yet been played"rgb(160, 198, 255)"Yes
fftSizeAn unsigned integer, representing the window size of the FFT, given in number of samples. For more details1024Yes
maxDecibelsA double, representing the maximum decibel value for scaling the FFT analysis data. For more details-10Yes
minDecibelsA double, representing the minimum decibel value for scaling the FFT analysis data, where 0 dB is the loudest possible sound. For more details-90Yes
smoothingTimeConstantA double within the range 0 to 1 (0 meaning no time averaging). For more details0.4Yes