1.1.3 • Published 8 years ago

audio.js v1.1.3

Weekly downloads
3
License
MIT
Repository
github
Last release
8 years ago

audio.js

stable

A handler for HTML5 audios, special to fade volume
Take a look to the demo, only for check fades--> Demo

var AudioJS = require('audio.js');  
  
var audioElement = document.getElementById('background-audio');  
// AUDIO ELEMENT should be an html5 audio element  
  
var audioJS = AudioJS(audioElement);  
var options = {
  duration: 10, //in seconds
  intialVolume: 0, // a volume from 0.0 to 1.0
  finalVolume: 0.9, // a volume from 0.0 to 1.0
  ease: 'easeOutExpo',
  callback: function(){console.log('Im a callback!');}
};  
  
audioJS.play(callback);  
audioJS.stop(callback);  
audioJS.pause();  
audioJS.setVolume(0.4);  
audioJS.status();  
audioJS.load();  
audioJS.getStringStatus();  
  // 0 is loaded  
  // 1 is playing  
  // 2 paused  
  // 3 stoped  
  // 4 is fading  
  // 5 endFade  
  // 6 ended  
  
audioJS.fadeIn(options);

##Methods

###PLAY

audioJS.play(function(){console.log('ended')});
//Status here is 1
// This function play the audio, and when the audio complete playing execute the callback function
//After the audio ended status is 6

###STOP

audioJS.stop(function(){console.log('ended')});
//Status here is 3
// This function stop the audio, and when the audio is stoped execute the callback function

###FADE IN

audioJS.fadeIn({duration: 2, initialVolume: 0, finalVolume: 0.95, ease: 'easeOutExpo'});
//Status here is 4  
audioJS.fadeIn({duration: 10, initialVolume: 0, finalVolume: 0.95, ease: 'easeOutExpo', 
  callback: function(){
    //Status here is 5  
    console.log("bullshit");
  }
});

###FADE OUT

audioJS.fadeOut({duration: 3, initialVolume: 0.9, finalVolume: 0.1});  

audioJS.fadeOut({duration: 5 , initialVolume: 0.9, finalVolume: 0.1, ease:'easeInQuad'});

###KILL FADE

  
//if you want to kill a fade that is animating
audioJS.killFade();  

Available Eases

'easeLinear'
'easeInQuad'
'easeOutQuad'
'easeInOutQuad'
'easeInCubic'
'easeOutCubic'
'easeInOutCubic'
'easeInExpo'
'easeOutExpo'
'easeInOutExpo'
'easeInCirc'
'easeOutCirc'
'easeInOutCirc'

Note: If you dont choose any ease, easeLinear is going to be run.

Usage

NPM

1.1.3

8 years ago

1.1.2

9 years ago

1.1.1

9 years ago

1.1.0

9 years ago

1.0.7

9 years ago

1.0.6

9 years ago

1.0.5

9 years ago

1.0.4

9 years ago

1.0.3

9 years ago

1.0.2

9 years ago

1.0.1

9 years ago

1.0.0

9 years ago