Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 1.53 KB

README.md

File metadata and controls

55 lines (36 loc) · 1.53 KB
Raw

@chordbook/metronome

A web-based metronome.

🥁 View Demo 🪘

Features

  • Consistent clock synchronization - any two devices with synchronized clocks will play in sync for a given tempo
  • Customizable meter (3/4, 4/4, 6/8, etc)
  • Customizable beat patterns (straight, swing, boom-chuck, etc)
  • Configurable audio (volume, mute, etc) and customizable sounds
  • Customizable visualizations

Installation

npm install @chordbook/metronome

Usage

import { createMetronome } from '@chordbook/metronome'

const metronome = createMetronome({
  tempo: 120.0,

  // Callback to visualize the beat
  onBeat: note => console.log('Beat:', note) // 0-15
})

// Request access to the web audio API and begin playing the metronome
metronome.start()

// Stop playing the metronome
metronome.stop()

Contributing

Contributions are welcome!

  1. Clone this repository: git clone https://github.com/chordbook/metronome.git
  2. Install dependencies: npm install
  3. Start the development server: npm run dev
  4. Open http://localhost:5173/ in your browser

Acknowledgements

The code derived from @cwilso's classic A tale of two clocks (repo). Thanks to @mattgraham for the idea to synchronize all metronomes for a given tempo using the wall clock.

License

This project is licensed under the GPLv3.0 license.