Wecho is a small module to simplify usage of sounds on the web with several sounds provided within the Wecho (Contributions).
npm install wechoand
import Wecho from 'wecho';or include the file from the dist folder
<script src="./dist/wecho.js"></script>// define options (inlcluded options are default values, so options argument can be omitted)
let options = {
volume: .5, // can be set for each sound separately
finishPlaying: false, // defines whether the sound should restart playing in case it's still being played
customSounds: {}, // add your own sounds (property is the name of sound and value is the URL)
};
// create instance of Wecho
const wecho = new Wecho(options);
// load desired sounds
wecho.load(['tick', 'boop']); // empty arguments loads all the sounds
// and play when needed (on click of any button in this example)
document.querySelectorAll('button').forEach(function(element) {
element.addEventListener('click', function(event) {
wecho.play('tick');
});
});Adds a sound to the predefined list from which the sounds can be loaded.
wecho.add(nameOfSound, URLofSound);Loads sounds with URL from predefined list.
wecho.load(['tick', 'boop']);Sets volume for one or all sounds.
wecho.setVolume(volume, nameOfSound); // volume accepts 0-1, name of sound is optionalPlays sound. Note that sound must be loaded first.
wecho.play(soundName);Any suggestions or contributions are welcome. If you'd like to expand the list of available sounds with your own, create a pull request or open an issue with your files included.