🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Book a DemoInstallSign in
Socket

audio.js

Package Overview
Dependencies
Maintainers
1
Versions
12
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

audio.js

A handler for easing html5 audios volume

1.1.3
latest
Source
npm
Version published
Maintainers
1
Created
Source

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

Keywords

audio

FAQs

Package last updated on 10 Nov 2015

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts