Mirrors/Tone.js
2
0
Fork 0
mirror of https://github.com/Tonejs/Tone.js synced 2024-11-16 08:38:00 +00:00
Code Issues Projects Releases Packages Wiki Activity

updated docs on LFO

Browse source
This commit is contained in:
Yotam Mann 2014-08-23 13:49:50 -04:00
parent 151ca08a21
commit c37902cdfe
1 changed files with 14 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
Tone/component/LFO.js
View file

@ -1,11 +1,14 @@
define(["Tone/core/Tone", "Tone/source/Oscillator", "Tone/signal/Scale"], function(Tone){
define(["Tone/core/Tone", "Tone/source/Oscillator", "Tone/signal/Scale", "Tone/signal/Signal"],
function(Tone){
/**
* Low Frequency Oscillator
*
* LFO produces an output signal which can be attached to an AudioParam
* for constant control over that parameter
* the LFO can also be synced to the transport
* @class The Low Frequency Oscillator produces an output signal
* which can be attached to an AudioParam or Tone.Signal
* for constant control over that parameter. the LFO can
* also be synced to the transport to start/stop/pause
* and change when the tempo changes.
*
* @constructor
* @extends {Tone}
@ -15,12 +18,6 @@ define(["Tone/core/Tone", "Tone/source/Oscillator", "Tone/signal/Scale"], functi
*/
Tone.LFO = function(rate, outputMin, outputMax){
/**
* the input
* @type {GainNOde}
*/
this.input = this.context.createGain();
/**
* the oscillator
* @type {Tone.Oscillator}
@ -99,7 +96,7 @@ define(["Tone/core/Tone", "Tone/source/Oscillator", "Tone/signal/Scale"], functi
};
/**
* set the maximum output of the LFO
* Set the maximum output of the LFO
* @param {number} min
*/
Tone.LFO.prototype.setMax = function(max){
@ -107,7 +104,7 @@ define(["Tone/core/Tone", "Tone/source/Oscillator", "Tone/signal/Scale"], functi
};
/**
* set the waveform of the LFO
* Set the waveform of the LFO
* @param {string} type
*/
Tone.LFO.prototype.setType = function(type){
@ -115,16 +112,12 @@ define(["Tone/core/Tone", "Tone/source/Oscillator", "Tone/signal/Scale"], functi
};
/**
* pointer to the parent's connect method
* @private
*/
Tone.LFO.prototype._connect = Tone.prototype.connect;
/**
* override the connect method so that it 0's out the value
* if attached to an AudioParam
* Override the connect method so that it 0's out the value
* if attached to an AudioParam or Tone.Signal.
*
* @borrows Tone.Signal.connect as Tone.LFO.connect
* Borrowed from {@link Tone.Signal}
*
* @function
*/
Tone.LFO.prototype.connect = Tone.Signal.prototype.connect;
@ -133,11 +126,9 @@ define(["Tone/core/Tone", "Tone/source/Oscillator", "Tone/signal/Scale"], functi
*/
Tone.LFO.prototype.dispose = function(){
this.oscillator.dispose();
this.output.disconnect();
this._scaler.dispose();
this.oscillator = null;
this.output = null;
this._scaler = null;
};
return Tone.LFO;