slimsurfer.js v4.0.2

slimsurfer.js

Slim, interactive navigable audio visualization using Web Audio and Canvas based on wavesurfer.js. This version does not handle audio streaming and playback and is designed to fast rendering of waveforms using pre-generated peak data!

See a tutorial and examples on wavesurfer-js.org.

npm install --save slimsurfer.js

Installation for development

Install development dependencies:

npm install

Development tasks automatically rebuild certain parts of the library when files are changed (start – slimsurfer, start:plugins – plugins). Start a dev task and go to localhost:8080/example/ to test the current build.

Start development server for core library:

npm run start

Start development server for plugins:

npm run start:plugins

Build all the files. (generated files are placed in the dist directory.)

npm run build

Running tests only:

npm run test

Build documentation with esdoc (generated files are placed in the doc directory.)

npm run doc

Publishing to NPM

Tagged commits to the master branch are automatically published to NPM. You can tag a commit using the npm cli:

npm version patch -m "Bump version"
git push origin master --follow-tags

Credits

Many thanks to the original authors katspaugh and contributors!

License

This work is licensed under a BSD 3-Clause License as the original project.