diff --git a/doc/api/sfxr.html b/doc/api/sfxr.html
index 8f21c1b..0d75658 100644
--- a/doc/api/sfxr.html
+++ b/doc/api/sfxr.html
@@ -30,9 +30,18 @@
@@ -94,203 +100,8 @@
Initialize the Sound instance. |
- self.volume |
- The sound volume and gain all samples are multiplied with |
-
-
- self.envelope |
- The ASD envelope that controls the sound amplitude
- (volume) over time |
-
-
- self.frequency |
- The base and minimum frequencies of the tone generator and their slides |
-
-
- self.vibrato |
- A vibrato-like amplitude
- modulation effect. |
-
-
- self.change |
- Changes the frequency mid-sound to create the characteristic
- "coin"-effect |
-
-
- self.duty |
- The duty of the square
- waveform |
-
-
- self.phaser |
- A simple phaser effect |
-
-
- self.lowpass |
- A lowpass filter effect |
-
-
- self.highpass |
- A highpass filter effect |
-
-
- self.volume.master |
- Master volume (default 0.5) |
-
-
- self.volume.sound |
- Additional gain (default 0.5) |
-
-
sfxr.Sound:resetParameters () |
Set all parameters to their default values. |
-
-
- self.repeatspeed |
- Repeat speed:
- Times to repeat the frequency slide over the course of the envelope
- (default 0.0, min 0.0, max 1.0) |
-
-
- self.waveform |
- The base waveform (default SQUARE) |
-
-
- self.envelope.attack |
- Attack time:
- Time the sound takes to reach its peak amplitude
- (default 0.0, min 0.0, max 1.0) |
-
-
- self.envelope.sustain |
- Sustain time:
- Time the sound stays on its peak amplitude
- (default 0.0, min 0.0, max 1.0) |
-
-
- self.envelope.punch |
- Sustain punch:
- Amount by which the sound peak amplitude is increased at the start of the
- sustain time
- (default 0.0, min 0.0, max 1.0) |
-
-
- self.envelope.decay |
- Decay time:
- Time the sound takes to decay after its sustain time
- (default 0.0, min 0.0, max 1.0) |
-
-
- self.frequency.start |
- Start frequency:
- Base tone of the sound, before sliding
- (default 0.0, min 0.0, max 1.0) |
-
-
- self.frequency.min |
- Min frequency:
- Tone below which the sound will get cut off
- (default 0.0, min 0.0, max 1.0) |
-
-
- self.frequency.slide |
- Slide:
- Amount by which the frequency is increased or decreased over time
- (default 0.0, min -1.0, max 1.0) |
-
-
- self.frequency.dslide |
- Delta slide:
- Amount by which the slide is increased or decreased over time
- (default 0.0, min -1.0, max 1.0) |
-
-
- self.vibrato.depth |
- Vibrato depth:
- Amount of amplitude modulation
- (default 0.0, min 0.0, max 1.0) |
-
-
- self.vibrato.speed |
- Vibrato speed:
- Oscillation speed of the vibrato
- (default 0.0, min 0.0, max 1.0) |
-
-
- self.vibrato.delay |
- Vibrato delay:
- Unused and unimplemented
- (default 0.0, min 0.0, max 1.0) |
-
-
- self.change.amount |
- Change amount:
- Amount by which the frequency is changed mid-sound
- (default 0.0, min -1.0, max 1.0) |
-
-
- self.change.speed |
- Change speed:
- Time before the frequency change happens
- (default 0.0, min 0.0, max 1.0) |
-
-
- self.duty.ratio |
- Square duty:
- Width of the square wave pulse cycle (doesn't affect other wave forms)
- (default 0.0, min 0.0, max 1.0) |
-
-
- self.duty.sweep |
- Duty sweep:
- Amount by which the square duty is increased or decreased over time
- (default 0.0, min -1.0, max 1.0) |
-
-
- self.phaser.offset |
- Phaser offset:
- Amount by which the phaser signal is offset from the sound
- (default 0.0, min -1.0, max 1.0) |
-
-
- self.phaser.sweep |
- Phaser sweep:
- Amount by which the phaser offset is increased or decreased over time
- (default 0.0, min -1.0, max 1.0) |
-
-
- self.lowpass.cutoff |
- Lowpass filter cutoff:
- Lower bound for frequencies allowed to pass through this filter
- (default 0.0, min 0.0, max 1.0) |
-
-
- self.lowpass.sweep |
- Lowpass filter cutoff sweep:
- Amount by which the LP filter cutoff is increased or decreased
- over time
- (default 0.0, min -1.0, max 1.0) |
-
-
- self.lowpass.resonance |
- Lowpass filter resonance:
- Amount by which certain resonant frequencies near the cutoff are
- increased
- (default 0.0, min 0.0, max 1.0) |
-
-
- self.highpass.cutoff |
- Highpass filter cutoff:
- Upper bound for frequencies allowed to pass through this filter
- (default 0.0, min 0.0, max 1.0) |
-
-
- self.highpass.sweep |
- Highpass filter cutoff sweep:
- Amount by which the HP filter cutoff is increased or decreased
- over time
- (default 0.0, min -1.0, max 1.0) |
sfxr.Sound:sanitizeParameters () |
@@ -374,6 +185,235 @@ y_Sustain_Release_.28ADSR.29_envelope">ASD envelope that controls the sound
(version 100-102)
+