https://github.com/nimitzdev/javascript-audio-pipeline
A simple class that wraps basic Web Audio APIs
https://github.com/nimitzdev/javascript-audio-pipeline
audiocontext html5-audio-api javascript webaudio-api
Last synced: about 2 months ago
JSON representation
A simple class that wraps basic Web Audio APIs
- Host: GitHub
- URL: https://github.com/nimitzdev/javascript-audio-pipeline
- Owner: NimitzDEV
- License: mit
- Created: 2018-02-07T14:48:23.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-02-11T08:19:13.000Z (over 7 years ago)
- Last Synced: 2024-10-01T09:29:59.957Z (9 months ago)
- Topics: audiocontext, html5-audio-api, javascript, webaudio-api
- Language: JavaScript
- Size: 30.3 KB
- Stars: 4
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AudioPipeline
AudioPipeline is a simple class that wraps basic Web Audio APIs, making connect and modify AudioNodes more easily.
## Install
[](https://npmjs.org/package/audio-pipeline)
install using npm or yarn
`npm i audio-pipeline`
`yarn add audio-pipeline`
## Basic Usage
```javascript
// init AudioPipeline
import AudioPipeline from 'audio-pipeline';
const AP = new AudioPipeline();
// pass ArrayBuffer to loadArrayBuffer to init AudioContext
await AP.loadArrayBuffer(buffer);
// then, we can build up our pipeline by using addNode
// first, we should get the source as the starting point.
AP.addNode(AP.getSourceNode());
// then we add effects that we want
AP.addNode(AP.getBiquadFilterNode('lowpass'));
// .... some more awesome effects
// and finally, we put it into the destination
AP.addNode(AP.getDestinationNode());
// after that, we connect those nodes
AP.fullConnect();
// and we play it
AP.control('start', 0);
```
## Add effects while playing
By passing true to the `addNode()` method, you can add new audio effects to the current pipeline.
```javascript
AP.addNode(AP.getBiquadFilterNode('highpass'), 2, true);
```
## Modify effects while playing
Using `getNode()` method, you can get AudioNode instant in specific position, previously, we constructed a pipeline in following order :
`Audio Source` => `lowpass` => `highpass`=>`Audio Destination`
now we want to change the cut-off frequency of the `lowpass` filter, which is on position 1.
```javascript
AP.getNode(1).frequency.value = 200;
```
## APIs
loadArrayBuffer(buffer: ArrayBuffer): Promise
> this function initialize the AudioContext with ArrayBuffer
control(action: String, params: Any)
> call methods on source object
fullConnect()
> connect all nodes added using addNode method
fullDisconnect()
> disconnect all nodes
addNode(node: AudioNode [, position: Number, reconnect: Boolean]): AudioNode
> add a AudioNode into pipeline, if position not set, the AudioNode will add to the last.
>
> if reconnect is set to true, will reconnect the AudioNodes between the new one, this is useful when you want to add AudioNode dynamically while playing audio.
deleteNode(position: Number [, reconnect: Boolean]): AudioNode
> delete specify AudioNode in the pipeline, if reconnect is set to true, will reconnect AudioNodes between the deleted one, this is useful when you want to delete AudioNode dynamically while playing audio.
switchNodes(from: Number, to: Number, [, reconnect: Boolean]): Boolean
> Switch two AudioNodes in the pipeline, if reconnect is set to true, will reconnect AudioNodes between the switched AudioNodes, this is useful when you want to switch AudioNodes order dynamically while playing audio.
getNode(position: Number): AudioNode
> get specific AudioNode reference in pipeline
clearNodes()
> empty pipeline, this method will not disconnect AudioNodes, make sure to call fullDisconnect() before clearNodes()
getBiquadFilterNode(type: String): BiquadFilterNode
> Create a new BiquadFilterNode with given type
getOscillatorNode(type: String): OscillatorNode
> Create a new OscillatorNode with given type
getGainNode(gain: Number): GainNode
> Create a new GainNode with given gain value
getDelayNode(delay: Number): DelayNode
> Create a new DelayNode with given delay time
getPannerNode(): PannerNode
> Create a new PannerNode
getPeriodicWave(real: Float32Array, imag: Float32Array, constraints; Object): OscillatorNode
> Create a new OscillatorNode with given PeriodicWave settings
getDestinationNode()
> Get the audio destination
getSourceNode()
> Get the audio source
getContext()
> Get the AudioContext
## How to build
install dependencies first
`yarn install`
run build
`yarn build`