Generated files from updated build script (processing-doclet)

These files were created by running the `processingrefBuild.sh` script as updated by Kevin in processing/processing-doclet#5

content/references/translations/en/sound/AllPass.json

@@ -0,0 +1,34 @@
+{
+  "brief": "Outputs all input frequencies at the same amplitude but changes \n their phase relationship.",
+  "methods": [
+    {
+      "anchor": "AllPass_gain_",
+      "name": "gain()",
+      "desc": "Sets the gain for the filter."
+    },
+    {
+      "anchor": "AllPass_process_",
+      "name": "process()",
+      "desc": "Start the effect."
+    },
+    {
+      "anchor": "AllPass_stop_",
+      "name": "stop()",
+      "desc": "Stop the effect."
+    }
+  ],
+  "csspath": "../../",
+  "isLibrary": "true",
+  "classFields": [],
+  "description": "This is an all pass filter. For signals processed, all frequencies hold the \n same amplitude but have their phase relationship modified using a delayline \n of one sample,<br/>\n <br/>\n <code>y(k) = -z * x(k) + x(k - 1) + z * y(k - 1)</code><br/>\n <br/>\n where <code>y</code> is the output, <code>x</code> is the input, \n <code>z</code> is the gain coefficient, and <code>k</code> is the signal.",
+  "type": "class",
+  "constructors": [
+    "AllPass(parent)"
+  ],
+  "related": [],
+  "name": "AllPass",
+  "classanchor": "sound/AllPass",
+  "category": "Effects",
+  "subcategory": "AllPass",
+  "parameters": []
+}

content/references/translations/en/sound/AllPass_gain_.json

@@ -0,0 +1,19 @@
+{
+  "brief": "Sets the gain for the filter.",
+  "related": [],
+  "name": "gain()",
+  "description": "Sets the gain for the filter in the range 0.0 - 1.0, where larger values \n increase phase displacement.",
+  "syntax": [".gain(g)"],
+  "returns": "void",
+  "type": "method",
+  "category": "Effects",
+  "subcategory": "AllPass",
+  "classanchor": "AllPass",
+  "parameters": [
+    {
+      "name": "g",
+      "description": "phase displacement in the range 0.0 - 1.0",
+      "type": ["float"]
+    }
+  ]
+}

content/references/translations/en/sound/AllPass_process_.json

@@ -0,0 +1,19 @@
+{
+  "brief": "Start the effect.",
+  "related": [],
+  "name": "process()",
+  "description": "Start the effect.",
+  "syntax": [".process(input)"],
+  "returns": "void",
+  "type": "method",
+  "category": "Effects",
+  "subcategory": "AllPass",
+  "classanchor": "AllPass",
+  "parameters": [
+    {
+      "name": "input",
+      "description": "Input sound source",
+      "type": ["SoundObject"]
+    }
+  ]
+}

content/references/translations/en/sound/AllPass_stop_.json

@@ -0,0 +1,13 @@
+{
+  "brief": "Stop the effect.",
+  "related": [],
+  "name": "stop()",
+  "description": "Stop the effect.",
+  "syntax": [".stop()"],
+  "returns": "void",
+  "type": "method",
+  "category": "Effects",
+  "subcategory": "AllPass",
+  "classanchor": "AllPass",
+  "parameters": []
+}

content/references/translations/en/sound/AudioSample.json

@@ -34,7 +34,7 @@
     {
       "anchor": "AudioSample_jump_",
       "name": "jump()",
-      "desc": "Jump to a specific position in the audiosample while continuing to play (or starting to play if it wasn't playing already)."
+      "desc": "Jumps to a specific position in the audio sample."
     },
     {
       "anchor": "AudioSample_jumpFrame_",
@@ -84,7 +84,7 @@
     {
       "anchor": "AudioSample_stop_",
       "name": "stop()",
-      "desc": "Stops the playback, and sets the cue back to the start of the sample."
+      "desc": "Stops the playback."
     },
     {
       "anchor": "AudioSample_position_",
@@ -120,7 +120,7 @@
   "csspath": "../../",
   "isLibrary": "true",
   "classFields": [],
-  "description": "This class allows you low-level access to an audio buffer to create, access,\n manipulate and play back sound samples.\n \n If you want to pre-load your audio sample with an audio file from disk you\n can do so using the SoundFile subclass.",
+  "description": "This class allows you low-level access to an audio buffer to create, access,\n manipulate and play back sound samples.\n \n If you want to pre-load your audio sample with an audio file from disk you\n can do so using the {@link SoundFile} subclass.",
   "type": "class",
   "constructors": [
     "AudioSample(parent, frames)",
@@ -150,18 +150,13 @@
     },
     {
       "name": "stereo",
-      "description": "whether to treat the audiosample as 2-channel (stereo) or not\n            (default: false)",
+      "description": "whether to treat the audiosample as 2-channel (stereo) or not\n            (default: ,<code>,false,</code>,)",
       "type": ["boolean"]
     },
     {
       "name": "frameRate",
       "description": "the underlying frame rate of the sample (default: 44100)",
       "type": ["int"]
-    },
-    {
-      "name": "data",
-      "description": "an array of float values to be used as this audiosample's sound\n            data. The audiosample will consequently have as many frames as the\n            length of the given array.",
-      "type": ["float[]"]
     }
   ]
 }

content/references/translations/en/sound/AudioSample_jump_.json

@@ -1,8 +1,8 @@
 {
-  "brief": "Jump to a specific position in the audiosample while continuing to play (or starting to play if it wasn't playing already).",
+  "brief": "Jumps to a specific position in the audio sample.",
   "related": ["sound/AudioSample_cue_", "sound/AudioSample_play_"],
   "name": "jump()",
-  "description": "Jump to a specific position in the audiosample while continuing to play (or starting to play if it wasn't playing already).",
+  "description": "Jump to a specific position in the audiosample while continuing to play (or \n starting to play if it wasn't playing already).",
   "syntax": [".jump(time)"],
   "returns": "void",
   "type": "method",
@@ -12,7 +12,7 @@
   "parameters": [
     {
       "name": "time",
-      "description": "position to jump to, in seconds.",
+      "description": "position to jump to, in seconds",
       "type": ["float"]
     }
   ]

content/references/translations/en/sound/AudioSample_loop_.json

@@ -2,13 +2,12 @@
   "brief": "Starts the playback of the audiosample.",
   "related": [],
   "name": "loop()",
-  "description": "Starts playback which will loop at the end of the audiosample.",
+  "description": "Starts the playback of the audiosample. Only plays to the end of the audiosample \n once. If <b>cue()</b> or <b>pause()</b> were called previously, playback will resume from the cued position.",
   "syntax": [
     ".loop()",
     ".loop(rate)",
     ".loop(rate, amp)",
-    ".loop(rate, pos, amp)",
-    ".loop(rate, pos, amp, add)"
+    ".loop(rate, pos, amp)"
   ],
   "returns": "void",
   "type": "method",

content/references/translations/en/sound/AudioSample_play_.json

@@ -8,8 +8,7 @@
     ".play(rate)",
     ".play(rate, amp)",
     ".play(rate, pos, amp)",
-    ".play(rate, pos, amp, add)",
-    ".play(rate, pos, amp, add, cue)"
+    ".play(rate, pos, amp, cue)"
   ],
   "returns": "void",
   "type": "method",
@@ -32,11 +31,6 @@
       "description": "the desired playback amplitude of the audiosample as a value from\n            0.0 (complete silence) to 1.0 (full volume)",
       "type": ["float"]
     },
-    {
-      "name": "add",
-      "description": "offset the output of the generator by the given value",
-      "type": ["float"]
-    },
     {
       "name": "cue",
       "description": "position in the audiosample that playback should start from, in\n            seconds.",

content/references/translations/en/sound/AudioSample_set_.json

@@ -3,7 +3,7 @@
   "related": [],
   "name": "set()",
   "description": "Set multiple parameters at once.",
-  "syntax": [".set(rate, pos, amp)", ".set(rate, pos, amp, add)"],
+  "syntax": [".set(rate, pos, amp)"],
   "returns": "void",
   "type": "method",
   "category": "Sampling",

content/references/translations/en/sound/AudioSample_stop_.json

@@ -1,8 +1,8 @@
 {
-  "brief": "Stops the playback, and sets the cue back to the start of the sample.",
+  "brief": "Stops the playback.",
   "related": [],
   "name": "stop()",
-  "description": "Stops the playback, and sets the cue back to the start of the sample.",
+  "description": "Stops the playback.",
   "syntax": [".stop()"],
   "returns": "void",
   "type": "method",

content/references/translations/en/sound/BandPass.json

@@ -4,18 +4,23 @@
     {
       "anchor": "BandPass_bw_",
       "name": "bw()",
-      "desc": "Set the bandwidth for the filter."
+      "desc": "Sets the bandwidth for the filter."
     },
     {
       "anchor": "BandPass_freq_",
       "name": "freq()",
-      "desc": "Set the cutoff frequency for the filter."
+      "desc": "Sets the center frequency of the filter."
     },
     {
       "anchor": "BandPass_process_",
       "name": "process()",
       "desc": "Start applying this bandpass filter to an input signal."
     },
+    {
+      "anchor": "BandPass_res_",
+      "name": "res()",
+      "desc": "Sets the resonance (or 'Q factor') of this filter."
+    },
     {
       "anchor": "BandPass_set_",
       "name": "set()",

content/references/translations/en/sound/BandPass_bw_.json

@@ -1,13 +1,19 @@
 {
-  "brief": "Set the bandwidth for the filter.",
+  "brief": "Sets the bandwidth for the filter.",
   "related": [],
   "name": "bw()",
-  "description": "Set the bandwidth for the filter.",
+  "description": "Sets the bandwidth of this BandPass filter.",
   "syntax": [".bw(bw)"],
   "returns": "void",
   "type": "method",
   "category": "Effects",
   "subcategory": "BandPass",
   "classanchor": "BandPass",
-  "parameters": []
+  "parameters": [
+    {
+      "name": "bw",
+      "description": "the filter bandwidth in Hertz",
+      "type": ["float"]
+    }
+  ]
 }

content/references/translations/en/sound/BandPass_freq_.json

@@ -1,8 +1,8 @@
 {
-  "brief": "Set the cutoff frequency for the filter.",
+  "brief": "Sets the center frequency of the filter.",
   "related": [],
   "name": "freq()",
-  "description": "Set the cutoff frequency for the filter.",
+  "description": "Sets the center frequency of the filter.",
   "syntax": [".freq(freq)"],
   "returns": "void",
   "type": "method",
@@ -12,7 +12,7 @@
   "parameters": [
     {
       "name": "freq",
-      "description": "Cutoff frequency between 0 and 20000",
+      "description": "the center frequency in Hertz",
       "type": ["float"]
     }
   ]

content/references/translations/en/sound/BandPass_process_.json

@@ -3,7 +3,7 @@
   "related": [],
   "name": "process()",
   "description": "Start applying this bandpass filter to an input signal.",
-  "syntax": [".process(input, freq)", ".process(input, freq, bw)"],
+  "syntax": [".process(input, freq, bw)"],
   "returns": "void",
   "type": "method",
   "category": "Effects",
@@ -12,14 +12,18 @@
   "parameters": [
     {
       "name": "input",
-      "description": "the sound source to apply the filter to",
+      "description": "the sound source to filter",
       "type": ["SoundObject"]
     },
     {
       "name": "freq",
-      "description": "Cutoff frequency between 0 and 20000",
+      "description": "the center frequency in Hertz",
       "type": ["float"]
     },
-    { "name": "bw", "description": "Set the bandwidth", "type": ["float"] }
+    {
+      "name": "bw",
+      "description": "the filter bandwidth in Hertz",
+      "type": ["float"]
+    }
   ]
 }

content/references/translations/en/sound/BandPass_res_.json

@@ -0,0 +1,19 @@
+{
+  "brief": "Sets the resonance (or 'Q factor') of this filter.",
+  "related": [],
+  "name": "res()",
+  "description": "Sets a fixed Q factor for this filter. If you want to specify a fixed \n bandwidth for this bandpass filter (in Hertz) that is maintained even as \n the center frequency of the filter changes, use <code>bw(float)</code> \n instead.",
+  "syntax": [".res(q)"],
+  "returns": "void",
+  "type": "method",
+  "category": "Effects",
+  "subcategory": "BandPass",
+  "classanchor": "BandPass",
+  "parameters": [
+    {
+      "name": "q",
+      "description": "the desired Q factor, a value between 0.1 and 10",
+      "type": ["float"]
+    }
+  ]
+}

content/references/translations/en/sound/BandPass_set_.json

@@ -10,7 +10,15 @@
   "subcategory": "BandPass",
   "classanchor": "BandPass",
   "parameters": [
-    { "name": "freq", "description": "Set the frequency", "type": ["float"] },
-    { "name": "bw", "description": "Set the bandwidth", "type": ["float"] }
+    {
+      "name": "freq",
+      "description": "the center frequency in Hertz",
+      "type": ["float"]
+    },
+    {
+      "name": "bw",
+      "description": "the filter bandwidth in Hertz",
+      "type": ["float"]
+    }
   ]
 }

content/references/translations/en/sound/BeatDetector_isBeat_.json

@@ -2,7 +2,7 @@
   "brief": "Returns whether or not the current moment of audio contains a beat or not.",
   "related": [],
   "name": "isBeat()",
-  "description": "Returns whether or not the current moment of audio contains a beat or not.\n A \"beat\" is defined as a spike in the energy of the audio signal \\u2014 it may\n or may not coincide exactly with a musical beat.",
+  "description": "Returns <code>true</code> if the current moment of the audio signal \n contains a beat, <code>false</code> otherwise.<br/>\n A \"beat\" is defined as a spike in the energy of the audio signal - it may\n or may not coincide exactly with a musical beat.",
   "syntax": [".isBeat()"],
   "returns": "boolean",
   "type": "method",

content/references/translations/en/sound/BrownNoise_set_.json

@@ -3,7 +3,7 @@
   "related": [],
   "name": "set()",
   "description": "Set the amplitude and panoramic position with one method.",
-  "syntax": [".set(amp, pos)"],
+  "syntax": [".set(amp, pos)", ".set(amp, add, pos)"],
   "returns": "void",
   "type": "method",
   "category": "Noise",

content/references/translations/en/sound/Env_play_.json

@@ -27,6 +27,11 @@
       "description": "Sustain time value as a float.",
       "type": ["float"]
     },
+    {
+      "name": "sustainLevel",
+      "description": "Sustain level value as a float. (as fraction of the input amplitude)",
+      "type": ["float"]
+    },
     {
       "name": "releaseTime",
       "description": "Release time value as a float.",