Skip to content

Latest commit

 

History

History
74 lines (47 loc) · 3.44 KB

README.md

File metadata and controls

74 lines (47 loc) · 3.44 KB
Raw

smoothfade

npm version

Smooth fading of volume (gain) in WebAudio is possible with parameter automation on the GainNode.

However, currently, there is no easy way to stop and change (for eg. reverse) an automation smoothly. Once an AudioParam is automated, there is no easy way to know it's value at a given point of time except for calculating it manually using the automation equations. Hence stopping and reversing the automation is not trivial.

This JSFiddle shows the various techniques that don't work for smooth fading, and finally the calculation based technique which does.

This library does the calculation and allows fading in/out smoothly.

Usage

npm install smoothfade

// wrap the smoothfade around a gain node

var sm = smoothfade(context, gain);


// use fadeIn/fadeOut functions to
// fadeIn/fadeOut the audio.

sm.fadeIn();

sm.fadeOut();

API

Constructor

eg: var sm = smoothfade(context, gainNode, options);

  • context: AudioContext - The AudioContext within which the GainNode has been created.
  • gainNode: GainNode - The GainNode which is connected to the audio graph which needs to be faded in/out.
  • options: Object - Optional object attribute which contains extra configuration options in the following format
    • startValue : Number - The initial starting value of the gainNode. If not specified, the library attempts to read it from the gainNode itself. This is useful if the gainNode is already being automated before this library is initialized.
    • type : String - The type of automation to use. Currently support 'linear' and 'exponential'. 'exponential' fade is considered to be more natural to human ears and hence is the default
    • fadeLength : Number - The time taken (in seconds) for a complete fadeout (from 1 - 0) or fadein (from 0 - 1). This determines how quickly the volume fades for both fadeins and fadeouts. This defaults to 10.

Methods

  • fadeIn : Fade in the audio. Slowly increase the gain of gainNode.

    • eg :
     sm.fadeIn(options);
    • arguments (optional):
      • targetValue : Number - The targeted value of the gain (between 0 and 1) where the fadeIn will stop. This defaults to 1.
      • startTime : Number - Timestamp to define when the fading starts, in the same time coordinate system as the AudioContext currentTime attribute. This defaults currentTime.

  • fadeOut : Fade out the audio. Slowly decrease the gain of gainNode.

    • eg :
     sm.fadeOut(options);
    • arguments (optional):
      • targetValue : Number - The targeted value of the gain (between 0 and 1) where the fadeOut will stop. This defaults to 1.
      • startTime : Number - Timestamp to define when the fading starts, in the same time coordinate system as the AudioContext currentTime attribute. This defaults currentTime.

License

Apache-2.0

See License file