Pentatonic v1.1.0
Turn any array of integers into a fun little melody.
There are one star-gazers on GitHub and it was downloaded 135 times in the last month on npm.
A snippet of a C Major Pentatonic scale.
Hey, psst!… You can jump straight down to the examples!
What? permalink
Pentatonic is a small JavaScript file that will play music generated from an array of integers from anywhere in your DOM.
Why? permalink
Why not? No, but really though, there’s no serious reason for this. It’s just fun.
Installation permalink
npm install @chrisburnell/pentatonic --save-dev
You can also just download it directly from GitHub:
https://github.com/chrisburnell/pentatonic/archive/master.zip
Usage permalink
pentatonic.js gives you a function, pentatonic() to use, like so:
document.querySelectorAll(".pentatonic").forEach(target => {
target.addEventListener("click", () => {
pentatonic(target.dataset.values.split(","));
});
});The function takes six parameters:
| Values | Description | |
|---|---|---|
notes(required) |
See below. | an array of positive integers |
duration |
4000 (default) | the length of time to play the audio for, represented in milliseconds |
volume |
0.5 (default) | controls the *gain* of the audio, represented by a 0–1 range |
keyStart |
29 / C♯3 / D♭3 (default) | the zero-index of the key on a standard keyboard from which the scale should start |
keyIntervals |
[2, 2, 3, 2, 3] (default) | an array of integers which represent half-steps in a loop which composes the desired scale |
keyLimit |
12 (default) | represents the highest index in the desired scale by which notes are bound by |
Examples permalink
Interactive Demo permalink
Check out my new interactive demo at spark-line!