Generated files from updated build script (processing-doclet)

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": ["allpass.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": ["effect.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": ["effect.stop()"],
+  "returns": "void",
+  "type": "method",
+  "category": "Effects",
+  "subcategory": "AllPass",
+  "classanchor": "AllPass",
+  "parameters": []
+}

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

@@ -3,7 +3,7 @@
   "related": [],
   "name": "analyze()",
   "description": "Queries a value from the analyzer and returns a float between 0. and 1.",
-  "syntax": [".analyze()"],
+  "syntax": ["amplitude.analyze()"],
   "returns": "float",
   "type": "method",
   "category": "Analysis",

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

@@ -3,7 +3,7 @@
   "related": [],
   "name": "input()",
   "description": "Define the audio input for the analyzer.",
-  "syntax": [".input(input)"],
+  "syntax": ["amplitude.input(input)"],
   "returns": "void",
   "type": "method",
   "category": "Analysis",

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

@@ -3,7 +3,7 @@
   "related": [],
   "name": "amp()",
   "description": "Change the amplitude/volume of this sound.",
-  "syntax": [".amp(amp)"],
+  "syntax": ["soundobject.amp(amp)"],
   "returns": "void",
   "type": "method",
   "category": "I/O",

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

@@ -3,7 +3,7 @@
   "related": [],
   "name": "pan()",
   "description": "Move the sound in a stereo panorama.",
-  "syntax": [".pan(pos)"],
+  "syntax": ["soundobject.pan(pos)"],
   "returns": "void",
   "type": "method",
   "category": "I/O",

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

@@ -4,10 +4,10 @@
   "name": "play()",
   "description": "Start capturing the input stream and route it to the audio output",
   "syntax": [
-    ".play()",
-    ".play(amp)",
-    ".play(amp, add)",
-    ".play(amp, add, pos)"
+    "audioin.play()",
+    "audioin.play(amp)",
+    "audioin.play(amp, add)",
+    "audioin.play(amp, add, pos)"
   ],
   "returns": "void",
   "type": "method",

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

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

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

@@ -4,10 +4,10 @@
   "name": "start()",
   "description": "Start the input stream without routing it to the audio output. This is useful\n if you only want to perform audio analysis based on the microphone input.",
   "syntax": [
-    ".start()",
-    ".start(amp)",
-    ".start(amp, add)",
-    ".start(amp, add, pos)"
+    "audioin.start()",
+    "audioin.start(amp)",
+    "audioin.start(amp, add)",
+    "audioin.start(amp, add, pos)"
   ],
   "returns": "void",
   "type": "method",

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

@@ -3,7 +3,7 @@
   "related": [],
   "name": "stop()",
   "description": "Stop capturing sound from this audio input.",
-  "syntax": [".stop()"],
+  "syntax": ["audioin.stop()"],
   "returns": "void",
   "type": "method",
   "category": "I/O",

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_amp_.json

@@ -3,7 +3,7 @@
   "related": [],
   "name": "amp()",
   "description": "Change the amplitude/volume of the player. Values are between 0.0 and 1.0.",
-  "syntax": [".amp(amp)"],
+  "syntax": ["audiosample.amp(amp)"],
   "returns": "void",
   "type": "method",
   "category": "Sampling",

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

@@ -3,7 +3,7 @@
   "related": [],
   "name": "channels()",
   "description": "Returns the number of channels in the audiosample as an int (1 for mono, 2 for stereo).",
-  "syntax": [".channels()"],
+  "syntax": ["audiosample.channels()"],
   "returns": "int",
   "type": "method",
   "category": "Sampling",

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

@@ -3,7 +3,7 @@
   "related": [],
   "name": "cueFrame()",
   "description": "Cues the playhead to a fixed position in the audiosample.",
-  "syntax": [".cueFrame(frameNumber)"],
+  "syntax": ["audiosample.cueFrame(frameNumber)"],
   "returns": "void",
   "type": "method",
   "category": "Sampling",

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

@@ -3,7 +3,7 @@
   "related": [],
   "name": "cue()",
   "description": "Cues the playhead to a fixed position in the audiosample. Note that <b>cue()</b> only affects the playhead for future calls to <b>play()</b>, but not to <b>loop()</b>.",
-  "syntax": [".cue(time)"],
+  "syntax": ["audiosample.cue(time)"],
   "returns": "void",
   "type": "method",
   "category": "Sampling",

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

@@ -3,7 +3,7 @@
   "related": [],
   "name": "duration()",
   "description": "Returns the duration of the audiosample in seconds.",
-  "syntax": [".duration()"],
+  "syntax": ["audiosample.duration()"],
   "returns": "float",
   "type": "method",
   "category": "Sampling",

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

@@ -3,7 +3,7 @@
   "related": [],
   "name": "frames()",
   "description": "Returns the number of frames of the audiosample as an int.",
-  "syntax": [".frames()"],
+  "syntax": ["audiosample.frames()"],
   "returns": "int",
   "type": "method",
   "category": "Sampling",

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

@@ -3,7 +3,7 @@
   "related": ["sound/AudioSample_cue_", "sound/AudioSample_play_"],
   "name": "jumpFrame()",
   "description": "Jump to a specific position in the audiosample without interrupting playback.",
-  "syntax": [".jumpFrame(frameNumber)"],
+  "syntax": ["audiosample.jumpFrame(frameNumber)"],
   "returns": "void",
   "type": "method",
   "category": "Sampling",

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

@@ -1,9 +1,9 @@
 {
-  "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).",
-  "syntax": [".jump(time)"],
+  "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": ["audiosample.jump(time)"],
   "returns": "void",
   "type": "method",
   "category": "Sampling",
@@ -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)"
+    "audiosample.loop()",
+    "audiosample.loop(rate)",
+    "audiosample.loop(rate, amp)",
+    "audiosample.loop(rate, pos, amp)"
   ],
   "returns": "void",
   "type": "method",

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

@@ -3,7 +3,7 @@
   "related": [],
   "name": "pan()",
   "description": "Pan the soundfile in a stereo panorama. -1.0 pans to the left channel and 1.0 to the right channel. \n Note that panning is only supported for mono (1 channel) audiosamples.",
-  "syntax": [".pan(pos)"],
+  "syntax": ["audiosample.pan(pos)"],
   "returns": "void",
   "type": "method",
   "category": "Sampling",

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

@@ -3,7 +3,7 @@
   "related": ["sound/AudioSample_cue_"],
   "name": "pause()",
   "description": "Stop the playback of the sample, but cue it to the current position. \n The next call to <b>play()</b> will continue playing where it left off.",
-  "syntax": [".pause()"],
+  "syntax": ["audiosample.pause()"],
   "returns": "void",
   "type": "method",
   "category": "Sampling",

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

@@ -3,7 +3,7 @@
   "related": [],
   "name": "percent()",
   "description": "Get current sound file playback position in percent.\n \n Note that, if this audio sample was at some point played back in parallel\n (triggered by another call to <b>play()</b> before the original playback had finished),\n the position returned by this function can be of any of the concurrent playbacks,\n not necessarily the last one that was triggered.",
-  "syntax": [".percent()"],
+  "syntax": ["audiosample.percent()"],
   "returns": "float",
   "type": "method",
   "category": "Sampling",

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

@@ -3,7 +3,10 @@
   "related": [],
   "name": "playFor()",
   "description": "Starts the playback of the audiosample for the specified duration or to the\n end of the audiosample, whichever comes first.",
-  "syntax": [".playFor(duration)", ".playFor(duration, cue)"],
+  "syntax": [
+    "audiosample.playFor(duration)",
+    "audiosample.playFor(duration, cue)"
+  ],
   "returns": "void",
   "type": "method",
   "category": "Sampling",

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

@@ -4,12 +4,11 @@
   "name": "play()",
   "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": [
-    ".play()",
-    ".play(rate)",
-    ".play(rate, amp)",
-    ".play(rate, pos, amp)",
-    ".play(rate, pos, amp, add)",
-    ".play(rate, pos, amp, add, cue)"
+    "audiosample.play()",
+    "audiosample.play(rate)",
+    "audiosample.play(rate, amp)",
+    "audiosample.play(rate, pos, amp)",
+    "audiosample.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.",