Merge pull request #516 from processing/update-sound-docs

Generated files from updated build script (processing-doclet)

Author: SableRaf

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",