aframe-metronome-component
A component for A-Frame that fires events at a specified rhythm, to facilitate building loop-based musical VR applications.
Properties
Property | Description | Default Value |
---|---|---|
bpm | Beats Per Minute. The overall speed of the loop. | 80 |
beatsPerBar | The number of beats contained in each bar of the loop. | 4 |
barsPerLoop | The number of bars in each loop. | 4 |
startTime | How long to wait (in milliseconds) after the page loads before the metronome starts. Can be reassigned to effectively jump to any point in the loop. | performance.now() + 500 |
Events
Event | Description |
---|---|
beat | Fires on every beat of the loop, according to the component's bpm property. Contains information about the current beat relative to the current bar, current loop, total beats, etc. |
tick | Contains roughly the same information as the beat event, but fires more frequently. Each beat is divided into 12 tick s. |
Installation
Browser Installation
A Musical A-Frame Scene
NPM Installation
Install via NPM:
npm install aframe-metronome-component
Usage
var clock = document clock