audio-node-suite
Advanced tools
Comparing version 0.9.1 to 0.9.2
{ | ||
"name": "audio-node-suite", | ||
"version": "0.9.1", | ||
"version": "0.9.2", | ||
"description": "Audio-Node-Suite -- Web Audio API AudioNode Suite", | ||
@@ -5,0 +5,0 @@ "keywords": [ "web", "audio", "api", "audionode", "suite" ], |
@@ -13,14 +13,13 @@ | ||
Installation | ||
------------ | ||
```shell | ||
$ npm install audio-node | ||
``` | ||
About | ||
----- | ||
Audio-Node-Suite is a JavaScript library for use in the Browser and Node.js, | ||
which provides a suite of Web Audio API compatible `AudioNode` classes: | ||
**Audio-Node-Suite** is a JavaScript library for use in the Browser | ||
(through its regular [Web Audio API](https://www.w3.org/TR/webaudio/)) | ||
and Node.js (through its Web Audio API emulating | ||
[web-audio-api](https://github.com/audiojs/web-audio-api) or | ||
[web-audio-engine](https://github.com/mohayonao/web-audio-engine) | ||
modules), which provides a suite of Web Audio API compatible | ||
[`AudioNode`](https://developer.mozilla.org/en-US/docs/Web/API/AudioNode) | ||
classes: | ||
@@ -35,14 +34,16 @@ - `AudioNodeComposite`: this is a convenient class for creating | ||
- `AudioNodeGain`, `AudioNodeCompressor`, `AudioNodeLimiter`: these | ||
are just convenient wrappers for the regular functionality provides | ||
are just convenient wrappers for the regular functionality provided | ||
by the Web Audio API `GainNode` and `DynamicsCompressorNode` classes, | ||
providing the `bypass()` functionality and useful parameter defaults. | ||
providing the `bypass()` functionality and some opinionated parameter defaults. | ||
- `AudioNodeEqualizer`: this is based on Web Audio API `BiquadFilterNode` | ||
instances and provides a convenient multi-band parametric equalizer `AudioNode`. | ||
- `AudioNodeEqualizer`: this is based on the Web Audio API `BiquadFilterNode` | ||
class and provides a convenient multi-band parametric equalizer `AudioNode`. | ||
- `AudioNodeMeter`: this is based on a Web Audio API `AnalyzerNode` | ||
instance and measures the volume in decibel of the audio stream in various ways. | ||
- `AudioNodeMeter`: this is based on the Web Audio API `AnalyzerNode` | ||
class and continuously tracks and measures the overall volume in | ||
decibel of the audio stream. It is also the internal base building | ||
block for the `AudioNodeGate` and `AudioNodeSpectrum` classes. | ||
- `AudioNodeGate`: this is based on a Web Audio API `GainNode` | ||
instance and measures the volume in decibel of the audio stream and | ||
- `AudioNodeGate`: this is based on the Web Audio API `GainNode` | ||
class and measures the volume in decibel of the audio stream and | ||
drains the volume if it drops below a certain decibel threshold. It is | ||
@@ -52,5 +53,6 @@ intended to act as a Noise Gate. | ||
- `AudioNodeSpectrum`: this is based on `AudioNodeMeter` and | ||
hence a Web Audio API `AnalyzerNode` instance to analyze the | ||
hence the Web Audio API `AnalyzerNode` class to analyze the | ||
frequency/decibel spectrum of the audio stream and continuously render | ||
it in a logarithmic scale to a `Canvas` DOM element. | ||
it in a (linear or logarithmic) scale to a `Canvas` element in the | ||
DOM. | ||
@@ -61,9 +63,17 @@ - `AudioNodeVoice`: this is based on `AudioNodeEqualizer`, | ||
which acts as a reasonable filter chain for voice. Its opinionated | ||
parameters are hard-coded and just based on some experiences. | ||
parameters are intentionally hard-coded and are just based on some | ||
experiences of the author. | ||
Installation | ||
------------ | ||
```shell | ||
$ npm install audio-node-suite | ||
``` | ||
Usage | ||
----- | ||
See the [TypeScript definition file](src/audio-node-suite.d.ts) | ||
for details on the exposed Application Programming Interface (API). | ||
See the [TypeScript definition](src/audio-node-suite.d.ts) | ||
for details on the provided Application Programming Interface (API). | ||
@@ -73,3 +83,3 @@ Implementation Notice | ||
Although Audio-Node-Suite is written in ECMAScript 2020, it is transpiled to older | ||
Although **Audio-Node-Suite** is written in ECMAScript 2020, it is transpiled to older | ||
environments and this way runs in really all current (as of 2020) | ||
@@ -85,3 +95,3 @@ JavaScript environments, of course. | ||
Copyright (c) 2020 Dr. Ralf S. Engelschall (http://engelschall.com/) | ||
Copyright © 2020 Dr. Ralf S. Engelschall <http://engelschall.com> | ||
@@ -88,0 +98,0 @@ Permission is hereby granted, free of charge, to any person obtaining |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
119372
111