Mirrors/Tone.js
2
0
Fork 0
mirror of https://github.com/Tonejs/Tone.js synced 2025-01-13 20:39:06 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #1133 from quargsgreene/dev

Browse source 
small doc enhancements for chorus, distortion, and FFT
This commit is contained in:
Yotam Mann 2022-10-23 11:01:27 -04:00 committed by GitHub
commit bd1c604131
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
Tone/component/analysis/FFT.ts
View file

@ -13,6 +13,7 @@ export interface FFTOptions extends MeterBaseOptions {
/** /**
* Get the current frequency data of the connected audio source using a fast Fourier transform. * 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 * @category Component
*/ */
export class FFT extends MeterBase<FFTOptions> { export class FFT extends MeterBase<FFTOptions> {

6
Tone/effect/Chorus.ts
View file

@ -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. * 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). * 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 * @example
* const chorus = new Tone.Chorus(4, 2.5, 0.5).toDestination().start(); * const chorus = new Tone.Chorus(4, 2.5, 0.5).toDestination().start();
* const synth = new Tone.PolySynth().connect(chorus); * const synth = new Tone.PolySynth().connect(chorus);
* synth.triggerAttackRelease(["C3", "E3", "G3"], "8n"); * synth.triggerAttackRelease(["C3", "E3", "G3"], "8n");
* *
* @category Effect * @category Effect
*/ */
export class Chorus extends StereoFeedbackEffect<ChorusOptions> { export class Chorus extends StereoFeedbackEffect<ChorusOptions> {

2
Tone/effect/Distortion.ts
View file

@ -10,7 +10,7 @@ export interface DistortionOptions extends EffectOptions {
/** /**
* A simple distortion effect using Tone.WaveShaper. * A simple distortion effect using Tone.WaveShaper.
* Algorithm from [this stackoverflow answer](http://stackoverflow.com/a/22313408). * Algorithm from [this stackoverflow answer](http://stackoverflow.com/a/22313408).
* * Read more about distortion on [Wikipedia] (https://en.wikipedia.org/wiki/Distortion_(music)).
* @example * @example
* const dist = new Tone.Distortion(0.8).toDestination(); * const dist = new Tone.Distortion(0.8).toDestination();
* const fm = new Tone.FMSynth().connect(dist); * const fm = new Tone.FMSynth().connect(dist);