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

adding some doc image

Browse source
This commit is contained in:
Yotam Mann 2019-07-16 16:47:07 -04:00
parent f13336bcaa
commit ad7d928be8
1 changed files with 16 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
Tone/source/oscillator/FMOscillator.ts
View file

@ -13,14 +13,22 @@ interface FMOscillatorOptions extends ToneOscillatorOptions {
}
/**
* @class FMOscillator
*
* @extends {Tone.Source}
* @constructor
* @param {Frequency} frequency The starting frequency of the oscillator.
* @param {String} type The type of the carrier oscillator.
* @param {String} modulationType The type of the modulator oscillator.
* @example
* FMOscillator implements a frequency modulation synthesis
* <pre>
* +-------------+
* +---------------+ +-------------+ | Carrier Osc |
* | Modulator Osc +>-------> GainNode | | +--->Output
* +---------------+ | +>----> frequency |
* +--> gain | +-------------+
* | +-------------+
* +-----------------+ |
* | modulationIndex +>--+
* +-----------------+
* </pre>
* @param frequency The starting frequency of the oscillator.
* @param type The type of the carrier oscillator.
* @param modulationType The type of the modulator oscillator.
* @example
* //a sine oscillator frequency-modulated by a square wave
* var fmOsc = new FMOscillator("Ab3", "sine", "square").toMaster().start();
*/