wavplayer
v1.0.0
Published
A simple JavaScript sound player : it's allows to play .wav file in a lot of browsers with a same interface (Chrome, Firefox, IE8+). The original purpose is to fix IE9+ .wav playing with HTML5 audio tag that is not supported.
Downloads
1
Maintainers
Readme
WavePlayer JavaScript library
A simple JavaScript sound player : it's allows to play .wav file in a lot of browsers with a same interface (Chrome, Firefox, IE7+). The original purpose is to fix IE9+ .wav playing with HTML5 audio tag that is not supported.
- For IE9+ browsers : use bgsound tag
- For modern browsers : use HTML5 audio feature (http://www.w3schools.com/tags/ref_av_dom.asp)
- Others : use embed tag
Supports
Tested formats and browsers :
| Format | IE7+ | Firefox | Chrome | Chrome Android | |:--------:|:----:|:-------:|:------:|:--------------:| | WAV | ✓ | ✓ | ✓ | ✓ | | MP3 | ✓ | ✓ | ✓ | ✓ |
Downloads
Installation with Bower is available :
bower install waveplayer
UI usage
You can use the jquery approach which generates a HTML interface :
<link href="../dist/waveplayer.min.css" type="text/css" rel="stylesheet" />
<script src="../dist/waveplayer.min.js"></script>
<script>
$(document).ready(function() {
$('.wave-player').wavePlayer();
});
</script>
<div class="wave-player"
data-src="sound.wav"
data-label="Play">
</div>
Data attributes
- data-src : File URI to play
- data-label : label to show in player
Programmatically usage
To use the programmatically approach :
var wavePlayer = new WavePlayer();
wavePlayer.play('sound.wav');
wavePlayer.stop();
With preload :
var wavePlayer = new WavePlayer({src : 'sound.wav'});
wavePlayer.play();
wavePlayer.stop();
Also, jQuery is not required.
Methods
constructor(opts)
Make a WavePlayer instance with specific options.
| name | description | type | default | |------|-------------|--------|-----------| | opts | Options map. | object | See below |
Options
| name | description | type | default | |-----------|--------------------------------------------------------------------------------------|---------|--------------| | src | Sound uri to preload. | string | none | | container | Tag container for media tag (bgsound, embed, ...). | node | document.body| | resetPlay | Force playing from start for HTML5 audio when play method is called after stop method. | boolean | true |
.play(uri)
Play the sound in parameter or passed in constructor with option 'src'.
| name | description | type | default | |------|-------------|--------|-----------| | uri | Optional, sound uri to play | string | none |
.stop()
Stop current sound.