wave-visualizer

1.0.6 • Public • Published

Wave.js

Minimal wave visualizer for javascript from wave.js Visual audio from element or micro phone stream

Wave visulaizer

DOCUMENTATION

LIVE EXAMPLES

Installation

Install with NPM

npm i wave-visualizer

Setup

If your using npm use a default import to include wave.

import Wave from 'wave-visualizer';

Create a new wave object.

var wave = new Wave();

If your working with React, put the wave instance in state.

let [wave] = useState(new Wave());

Usage

Call one of the three main function on the wave object, fromFile, fromStream, fromElement.

wave.fromElement('audio_element_id', 'canvas_id');

Documentation

View the current documentation for Wave.js here.

Example

<html>
  <head></head>
 
  <body>
    <canvas id="output" height="500" width="500"></canvas>
 
    <script src="../dist/bundle.cjs.js"></script> 
    <script>
      let wave = new Wave();
 
      navigator.mediaDevices
        .getUserMedia({
          audio: true,
        })
        .then(function (stream) {
          wave.fromStream(stream, 'output', {
            colors: ['red', 'white', 'blue'],
          });
        })
        .catch(function (err) {
          console.log(err.message);
        });
    </script> 
  </body>
</html>

Contributor Workflow

  1. Fork Wave.js repo.
  2. Clone to your local computer.
  3. Run "npm i" in the root folder to install dependencies.
  4. Run "npm run test" to start the dev server and code watcher.
  5. Open the src folder and make a change to one of the src files.
  6. Save changes and refresh browser window to see changes.
  7. Push to remote branch and create a pull request to the Wave.js master branch.

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 1.0.6
    246
    • latest

Version History

Package Sidebar

Install

npm i wave-visualizer

Weekly Downloads

246

Version

1.0.6

License

MIT

Unpacked Size

14.3 kB

Total Files

4

Last publish

Collaborators

  • samuvel246