ample is a Javascript library for playing audio clips, designed to take care of selecting the most appropriate audio backend (Web Audio, HTML5 audio or Flash; .mp3 or .ogg) out of what's supported by the current browser, and present a common interface for opening and playing samples regardless of backend.
Because that doesn't let you specify .ogg and .mp3 alternatives for the same clip, meaning that Firefox users without Flash are out of luck.
ample requires SWFObject 2.2 - ensure that this is included in your HTML header along with ample.js:
<script src="/static/js/swfobject.js"></script>
<script src="/static/js/ample.js"></script>
Additionally, it relies on a small .swf file (mp3manager.swf) for the Flash backend; specify the path to this file by setting the variable Ample.swfPath:
<script>
Ample.swfPath = '/static/swf/mp3manager.swf';
</script>
To load an audio clip, call Ample.openSound:
Ample.openSound({
'sources': {'ogg-vorbis':'/static/audio/rickroll.ogg', 'mp3':'/static/audio/rickroll.mp3'},
'volume': 0.5,
'onSuccess': function(sample) { alert('Sample is ready for use'); },
'onFailure': function() { alert('oh no!'); }
});
sources should be a set of URLs to different encoded versions of the same audio clip; recognised types are 'ogg-vorbis' and 'mp3'. The openSound method runs asynchronously (control returns to the code following the openSound call without necessarily having completed its task); on completion, it calls the onSuccess or onFailure callback as appropriate. onFailure indicates that none of the backends were able to load the clip (possibly because the file is broken, or the browser does not support any of the audio output methods.
The onSuccess callback is passed a 'sample' object, with two methods: 'play' (which plays the clip from the beginning) and 'stop' (which immediately stops playback).
Matt Westcott matt@west.co.tt