JSPM – waud.js@0.6.9

Package Exports

waud.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (waud.js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Web Audio Library with HTML5 audio fallback.

Installation

For haxe users:

haxelib install waud

API Documentation

Example

Example:

var snd = new WaudSound("assets/loop.mp3", { autoplay: false, loop: true, volume: 0.5, onload: playBgSound });

Base64 Data URI

Waud supports base64 decoding across all browsers including IE 9 and I recommend using this solution instead of audio sprite.

Use waudbase64 to generate base64 encoded JSON file.

var base64pack = new WaudBase64Pack("assets/sounds.json", _onLoad);

function _onLoad(snds) {
  snds.get("assets/beep.mp3").play();
}

Waud also supports passing data URI string to WaudSound.

//Note that the data URI used below is a sample string and not a valid sound
var base64Snd = new WaudSound("data:audio/mpeg;base64,//uQxAAAAAAAAAAAAASW5mbwAAAA8AAABEAABwpgADBwsLDxISF");

Audio Sprite

Use waudsprite to generate audio sprite.

var audSprite = new WaudSound("assets/sprite.json");
audSprite.play("glass");

Support

Browser & Mobile Device Testing provided by:


Latest ✓	Latest ✓	Latest ✓	Latest ✓	Latest ✓

Issues

Found any bug? Please create a new issue.

Demo

Usage

Waud.init();
Waud.enableTouchUnlock(touchUnlock);
Waud.autoMute();

var bgSnd = new WaudSound("assets/loop.mp3", {
    "autoplay": false, "loop":true, "volume": 0.5, "onload": playBgSound
});

var snd2 = new WaudSound("assets/sound1.wav", {
    "autoplay": false,
    "loop":true,
    "onload": function (snd) { snd.play(); },
    "onend": function (snd) { console.log("ended"); },
    "onerror": function (snd) { console.log("error"); }
});

//Touch unlock event for iOS devices
function touchUnlock() {
    if (!bgSnd.isPlaying()) bgSnd.play();
}

function playBgSound(snd) {
    if (!snd.isPlaying()) snd.play();
}

Tips

It is recommended to use same sample rate for all the audio files. Playing different sample rate files can cause issues on some devices.
By default, Waud uses 44100 sample rate. If your audio files have a different sample rate then specify it using Waud.preferredSampleRate property.

Licensing Information

This content is released under the MIT License.

Contributor Code of Conduct

Code of Conduct is adapted from Contributor Covenant, version 1.4