React component for audio visualization using Web Audio API. ES6 compatibility.
Example of a live app is inside example directory.
Live demo: DavidLazic.github.io/react-audio-visualizer
To build the examples locally, run:
npm install
npm start
Then open localhost:8000 in a browser.
The easiest way to use react-audio-visualizer is to install it from NPM and include it in your own React build process (using Browserify, Webpack, etc).
You can also use the standalone build by including dist/react-audio-visualizer.js in your page. If you use this, make sure you have already included React, and it is available as a global variable.
npm install react-audio-visualizer --save
Require Visualizer component.
const Visualizer = require('react-audio-visualizer');
<Visualizer model={ <model> } />Base Visualizer properties.
| Name | Type | Required | Description |
|---|---|---|---|
| model | Object | Yes | Model is the only required property. It must have path, author & title properties. |
| options | Object | No | Set custom styling for default rendering functions, properties below. |
| extensions | Object | No | Decorator functions for overriding default rendering functions, properties below. |
| className | String | No | Modifier CSS class that will be set on visualizer's container element. |
| width | String | No | Inline canvas width. |
| height | String | No | Inline canvas height. |
| onChange | Function | No | Callback function when play state changes. |
Model properties
| Name | Type | Required | Description |
|---|---|---|---|
| path | String | Yes | Path to audio file to be requested as an array buffer via AJAX. |
| author | String | Yes | Audio author to be rendered on canvas. |
| title | String | Yes | Audio title to be rendered on canvas. |
Options properties
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| autoplay | Boolean | False | No | Flag if the file should be played automatically. |
| shadowBlur | Integer | 20 | No | Canvas shadow blur. |
| shadowColor | String | #ffffff | No | Canvas shadow color. |
| barColor | String | #cafdff | No | Canvas bar color. |
| barWidth | Integer | 2 | No | Canvas bar width. |
| barHeight | Integer | 2 | No | Canvas bar height. |
| barSpacing | Integer | 7 | No | Canvas bar spacing. |
| font | Array | ['12px', 'Helvetica'] | No | Canvas font family and size. |
Extensions properties
| Name | Type | Required | Description |
|---|---|---|---|
| renderStyle | Function | No | Decorator fn for canvas style rendering. |
| renderText | Function | No | Decorator fn for canvas text rendering. |
| renderTime | Function | No | Decorator fn for canvas time rendering. |
Possible play states
- ENDED
- PLAYING
- PAUSED
- BUFFERING
NOTE: The source code for the component is in src. A transpiled CommonJS version (generated with Babel) is available in lib for use with node.js, browserify and webpack. A UMD bundle is also built to dist, which can be included without the need for any build system.
To build, watch and serve the examples (which will also watch the component source), run npm start. If you just want to watch changes to src and rebuild lib, run npm run watch (this is useful if you are working with npm link).
This project is an upgrade from my original experiment with Web Audio API written in vanilla JS. It's open for contributions, so, if you think something can be improved or you'd like a new feature, please submit a PR or we can discuss it via email also.
MIT License
Copyright (c) 2017 David Lazic
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.