Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skratchdot/audio-automator
A better way to change AudioParam values
https://github.com/skratchdot/audio-automator
Last synced: about 2 months ago
JSON representation
A better way to change AudioParam values
- Host: GitHub
- URL: https://github.com/skratchdot/audio-automator
- Owner: skratchdot
- License: mit
- Created: 2016-01-30T17:33:08.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-01-30T18:59:40.000Z (almost 9 years ago)
- Last Synced: 2024-10-19T00:24:21.961Z (3 months ago)
- Language: JavaScript
- Homepage: http://projects.skratchdot.com/audio-automator/
- Size: 659 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# audio-automator
[](http://badge.fury.io/js/audio-automator)
[](https://travis-ci.org/skratchdot/audio-automator)
[](https://codeclimate.com/github/skratchdot/audio-automator)
[](https://coveralls.io/github/skratchdot/audio-automator?branch=master)
[](https://david-dm.org/skratchdot/audio-automator)
[](https://david-dm.org/skratchdot/audio-automator#info=devDependencies)
[](https://npmjs.org/package/audio-automator)
## Description
A better way to change AudioParam values.
This library was created to deal with some of the issues I've encountered when
working with the WebAudio [AudioParam](http://webaudio.github.io/web-audio-api/#AudioParam)
([MDN](https://developer.mozilla.org/en-US/docs/Web/API/AudioParam))
automation features. The [web-audio-api](http://webaudio.github.io/web-audio-api/)
provides 6 functions for automating param values, as well as letting you set the
param.value directly:
- AudioParam.cancelScheduledValues()
- AudioParam.exponentialRampToValueAtTime()
- AudioParam.linearRampToValueAtTime()
- AudioParam.setTargetAtTime()
- AudioParam.setValueAtTime()
- AudioParam.setValueCurveAtTime()
There are however, some annoyances with the API (IMHO), so I created this
library. For example, when using any of the 6 functions above, the param.value
does not change while automations are occurring, so you cannot inspect where in
the automation you are (you have to calculate this yourself by keeping track
of timings). Also, when you cancel an automation, the "value" jumps back to
the value when the automation started (which may or may not be what you intended).
I've "fixed" these issues by always setting the param.value directly, and not
using the built-in web audio automation functions. This allows me to expose
different types of automation easing functions, as well as allowing end users
to inspect automation timings and values at any time. It also lets you schedule
new automations that just "pick up from the right spot". Meaning you don't have
to cancel running automations if you don't want to. Just schedule a new one,
and the most recent automation added will work correctly.
You can check out a live demo here:
- [http://projects.skratchdot.com/audio-automator/demo](http://projects.skratchdot.com/audio-automator/demo)
## Getting Started
Install the module with: `npm install audio-automator`
## Documentation
#### Basic Usage
```javascript
import AudioAutomator from 'audio-automator';
// create a context, and a gain node (which we will automate)
const audioContext = new AudioContext();
const gain = audioContext.createGain();
// create our AudioAutomator
const auto = new AudioAutomator(audioContext);
// Automate the gain node:
// This waits for 3 seconds, then starts using a `sinInOut` easing
// function to change the value of the gain node to 0.5. It will
// take 1.2 seconds to complete the automation.
auto.sinInOut(gain.gain, 0.5, 1.2, 3);
```
## Links
- [Homepage](https://github.com/skratchdot/audio-automator/)
- [Demo](http://projects.skratchdot.com/audio-automator/demo)
## License
Copyright (c) 2016 [skratchdot](http://skratchdot.com/)
Licensed under the [MIT license](LICENSE-MIT).