Giter Club home page Giter Club logo

smoothfade's Introduction

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

smoothfade's People

Contributors

dependabot[bot] avatar juliangruber avatar notthetup avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.