1.0.0 • Published 5 years ago

wavplayer v1.0.0

Weekly downloads
3
License
ISC
Repository
github
Last release
5 years ago

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.

Supports

Tested formats and browsers :

FormatIE7+FirefoxChromeChrome Android
WAV
MP3

Downloads

Installation with Bower is available :

bower install waveplayer

UI usage

UI

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.

namedescriptiontypedefault
optsOptions map.objectSee below
Options
namedescriptiontypedefault
srcSound uri to preload.stringnone
containerTag container for media tag (bgsound, embed, ...).nodedocument.body
resetPlayForce playing from start for HTML5 audio when play method is called after stop method.booleantrue

.play(uri)

Play the sound in parameter or passed in constructor with option 'src'.

namedescriptiontypedefault
uriOptional, sound uri to playstringnone

.stop()

Stop current sound.