waa

web-audio-analyser

A thin wrapper around the Web Audio API that takes an <audio> element and gives you its waveform/frequency data in return.

Showing:

Popularity

Downloads/wk

75

GitHub Stars

201

Maintenance

Last Commit

6yrs ago

Contributors

1

Package

Dependencies

0

Size (min+gzip)

0.6KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

web-audio-analyser experimental

A thin wrapper around the Web Audio API that lets you take some audio and get its waveform/frequency data in return.

Note: If you are streaming from SoundCloud or a similar API, you may need to set up CORS on your Audio source like so:

var audio = new Audio()
audio.crossOrigin = 'Anonymous'
audio.src = url

web-audio-analyser

Usage

analyser = require('web-audio-analyser')(audio[, ctx][, opts])

Takes some form of audio as the first argument. This may be one of the following:

  • An <audio> element.
  • A MediaStream object created by calling getUserMedia.
  • Any kind of AudioSourceNode.

Optionally, you can pass in your own AudioContext instance too. Note there may only be one instance of this per page, and if not supplied one will be created for you.

You can also use the following options:

  • stereo: retrieve separate data from the left and right audio channels.
  • audible: whether or not to play the audio you're analysing. Defaults to true, but set this to false to disable. You can use analyser.output to pass the resulting output elsewhere.

analyser.waveform([ui8array][, channel])

Copies the audio's current time-domain data into a Uint8Array. If you don't pass your own in, one will be created for you: this will be reused, so it's safe to call in an animation loop.

If you've enabled the stereo option, you should pass channel as either 0 or 1 to retrieve output from the left and right channels respectively.

analyser.frequencies([ui8array][, channel])

Much like analyser.waveform, with the exception of copying the audio's currrent frequency data into a Uint8Array.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial