mirror of
https://github.com/Tonejs/Tone.js
synced 2024-12-26 11:33:09 +00:00
Merge pull request #1133 from quargsgreene/dev
small doc enhancements for chorus, distortion, and FFT
This commit is contained in:
commit
bd1c604131
3 changed files with 5 additions and 4 deletions
|
@ -13,6 +13,7 @@ export interface FFTOptions extends MeterBaseOptions {
|
|||
|
||||
/**
|
||||
* Get the current frequency data of the connected audio source using a fast Fourier transform.
|
||||
* Read more about FFT algorithms on [Wikipedia] (https://en.wikipedia.org/wiki/Fast_Fourier_transform).
|
||||
* @category Component
|
||||
*/
|
||||
export class FFT extends MeterBase<FFTOptions> {
|
||||
|
|
|
@ -17,15 +17,15 @@ export interface ChorusOptions extends StereoFeedbackEffectOptions {
|
|||
|
||||
/**
|
||||
* Chorus is a stereo chorus effect composed of a left and right delay with an [[LFO]] applied to the delayTime of each channel.
|
||||
* When [[feedback]] is set to a value larger than 0, you also get Flanger-type effects.
|
||||
* When [[feedback]] is set to a value larger than 0, you also get Flanger-type effects.
|
||||
* Inspiration from [Tuna.js](https://github.com/Dinahmoe/tuna/blob/master/tuna.js).
|
||||
* Read more on the chorus effect on [SoundOnSound](http://www.soundonsound.com/sos/jun04/articles/synthsecrets.htm).
|
||||
* Read more on the chorus effect on [Sound On Sound](http://www.soundonsound.com/sos/jun04/articles/synthsecrets.htm).
|
||||
*
|
||||
* @example
|
||||
* const chorus = new Tone.Chorus(4, 2.5, 0.5).toDestination().start();
|
||||
* const synth = new Tone.PolySynth().connect(chorus);
|
||||
* synth.triggerAttackRelease(["C3", "E3", "G3"], "8n");
|
||||
*
|
||||
*
|
||||
* @category Effect
|
||||
*/
|
||||
export class Chorus extends StereoFeedbackEffect<ChorusOptions> {
|
||||
|
|
|
@ -10,7 +10,7 @@ export interface DistortionOptions extends EffectOptions {
|
|||
/**
|
||||
* A simple distortion effect using Tone.WaveShaper.
|
||||
* Algorithm from [this stackoverflow answer](http://stackoverflow.com/a/22313408).
|
||||
*
|
||||
* Read more about distortion on [Wikipedia] (https://en.wikipedia.org/wiki/Distortion_(music)).
|
||||
* @example
|
||||
* const dist = new Tone.Distortion(0.8).toDestination();
|
||||
* const fm = new Tone.FMSynth().connect(dist);
|
||||
|
|
Loading…
Reference in a new issue