Merge pull request #470 from processing/sound-updates

Update sound library reference categories/subcategories

content/references/examples/sound/SoundFile_set_/SoundFile_set_0.pde

@@ -16,7 +16,6 @@ void mousePressed() {
   float rate = 3;
   float pos = 0.5;
   float amp = 0.5;
-  float add = 0;
-  file.set(rate, pos, amp, add);
+  file.set(rate, pos, amp);
 }
 

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

@@ -17,17 +17,21 @@
   "classFields": [],
   "description": "This is a volume analyzer. It calculates the root mean square of the\n amplitude of each audio block and returns that value.",
   "type": "class",
-  "constructors": ["Amplitude(parent)"],
+  "constructors": [
+    "Amplitude(parent)"
+  ],
   "related": [],
   "name": "Amplitude",
   "classanchor": "sound/Amplitude",
-  "category": "analysis",
-  "subcategory": "",
+  "category": "Analysis",
+  "subcategory": "Amplitude",
   "parameters": [
     {
       "name": "parent",
       "description": "typically use \"this\"",
-      "type": ["PApplet"]
+      "type": [
+        "PApplet"
+      ]
     }
   ]
 }

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

@@ -6,8 +6,8 @@
   "syntax": [".analyze()"],
   "returns": "float",
   "type": "method",
-  "category": "amplitude",
-  "subcategory": "",
+  "category": "Analysis",
+  "subcategory": "Amplitude",
   "classanchor": "Amplitude",
   "parameters": []
 }

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

@@ -6,8 +6,8 @@
   "syntax": [".input(input)"],
   "returns": "void",
   "type": "method",
-  "category": "amplitude",
-  "subcategory": "",
+  "category": "Analysis",
+  "subcategory": "Amplitude",
   "classanchor": "Amplitude",
   "parameters": [
     {

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

@@ -1,43 +1,65 @@
 {
   "brief": "AudioIn lets you grab the audio input from your sound card.",
   "methods": [
+    {
+      "anchor": "AudioIn_amp_",
+      "name": "amp()",
+      "desc": "Change the amplitude/volume of this sound."
+    },
+    {
+      "anchor": "AudioIn_pan_",
+      "name": "pan()",
+      "desc": "Move the sound in a stereo panorama."
+    },
     {
       "anchor": "AudioIn_play_",
       "name": "play()",
       "desc": "Start capturing the input stream and route it to the audio output"
     },
+    {
+      "anchor": "AudioIn_set_",
+      "name": "set()",
+      "desc": "Set amplitude and pan position with one method."
+    },
     {
       "anchor": "AudioIn_start_",
       "name": "start()",
       "desc": "Start the input stream without routing it to the audio output."
     },
     {
-      "anchor": "AudioIn_set_",
-      "name": "set()",
-      "desc": "Sets amplitude, add and pan position with one method."
+      "anchor": "AudioIn_stop_",
+      "name": "stop()",
+      "desc": "Stop capturing sound from this audio input."
     }
   ],
   "csspath": "../../",
   "isLibrary": "true",
   "classFields": [],
   "description": "AudioIn lets you grab the audio input from your sound card.",
   "type": "class",
-  "constructors": ["AudioIn(parent)", "AudioIn(parent, in)"],
+  "constructors": [
+    "AudioIn(parent)",
+    "AudioIn(parent, in)"
+  ],
   "related": [],
   "name": "AudioIn",
   "classanchor": "sound/AudioIn",
   "category": "I/O",
-  "subcategory": "",
+  "subcategory": "AudioIn",
   "parameters": [
     {
       "name": "parent",
       "description": "typically use \"this\"",
-      "type": ["PApplet"]
+      "type": [
+        "PApplet"
+      ]
     },
     {
       "name": "in",
       "description": "input channel number (optional, default 0)",
-      "type": ["int"]
+      "type": [
+        "int"
+      ]
     }
   ]
 }

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

@@ -1,8 +1,8 @@
 {
-  "brief": "Changes the amplitude/volume of the input stream.",
+  "brief": "Change the amplitude/volume of this sound.",
   "related": [],
   "name": "amp()",
-  "description": "Changes the amplitude/volume of the input stream. Allowed values are between 0.0 and 1.0.",
+  "description": "Change the amplitude/volume of this sound.",
   "syntax": [".amp(amp)"],
   "returns": "void",
   "type": "method",
@@ -12,7 +12,7 @@
   "parameters": [
     {
       "name": "amp",
-      "description": "the amplitude of the input stream as a value from 0.0 (complete silence) to 1.0 (full volume)",
+      "description": "A float value between 0.0 (complete silence) and 1.0 (full volume)\n            controlling the amplitude/volume of this sound.",
       "type": ["float"]
     }
   ]

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

@@ -1,8 +1,8 @@
 {
-  "brief": "Pan the input stream in a stereo panorama.",
+  "brief": "Move the sound in a stereo panorama.",
   "related": [],
   "name": "pan()",
-  "description": "Pan the input stream in a stereo panorama. -1.0 pans to the left channel and 1.0 to the right channel.",
+  "description": "Move the sound in a stereo panorama.",
   "syntax": [".pan(pos)"],
   "returns": "void",
   "type": "method",
@@ -12,7 +12,7 @@
   "parameters": [
     {
       "name": "pos",
-      "description": "the panoramic position of this sound unit from -1.0 (left) to 1.0\n            (right).",
+      "description": "The panoramic position of this sound unit as a float from -1.0\n            (left) to 1.0 (right).",
       "type": ["float"]
     }
   ]

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

@@ -11,20 +11,15 @@
   ],
   "returns": "void",
   "type": "method",
-  "category": "audioin",
-  "subcategory": "",
+  "category": "I/O",
+  "subcategory": "AudioIn",
   "classanchor": "AudioIn",
   "parameters": [
     {
       "name": "amp",
       "description": "the volume to grab the input at as a value from 0.0 (complete\n            silence) to 1.0 (full volume)",
       "type": ["float"]
     },
-    {
-      "name": "add",
-      "description": "offset the audio input by the given value",
-      "type": ["float"]
-    },
     {
       "name": "pos",
       "description": "pan the audio input in a stereo panorama. Allowed values are\n            between -1.0 (left) and 1.0 (right)",

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

@@ -1,25 +1,20 @@
 {
-  "brief": "Sets amplitude, add and pan position with one method.",
+  "brief": "Set amplitude and pan position with one method.",
   "related": [],
   "name": "set()",
-  "description": "Sets amplitude, add and pan position with one method.",
-  "syntax": [".set(amp, add, pos)"],
+  "description": "Set amplitude and pan position with one method.",
+  "syntax": [".set(amp, pos)", ".set(amp, add, pos)"],
   "returns": "void",
   "type": "method",
-  "category": "audioin",
-  "subcategory": "",
+  "category": "I/O",
+  "subcategory": "AudioIn",
   "classanchor": "AudioIn",
   "parameters": [
     {
       "name": "amp",
       "description": "the volume to grab the input at as a value from 0.0 (complete\n            silence) to 1.0 (full volume)",
       "type": ["float"]
     },
-    {
-      "name": "add",
-      "description": "offset the audio input by the given value",
-      "type": ["float"]
-    },
     {
       "name": "pos",
       "description": "pan the audio input in a stereo panorama. Allowed values are\n            between -1.0 (left) and 1.0 (right)",

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

@@ -11,8 +11,8 @@
   ],
   "returns": "void",
   "type": "method",
-  "category": "audioin",
-  "subcategory": "",
+  "category": "I/O",
+  "subcategory": "AudioIn",
   "classanchor": "AudioIn",
   "parameters": [
     {

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

@@ -1,8 +1,8 @@
 {
-  "brief": "Stops the Input Stream.",
+  "brief": "Stop capturing sound from this audio input.",
   "related": [],
   "name": "stop()",
-  "description": "Stops the Input Stream.",
+  "description": "Stop capturing sound from this audio input.",
   "syntax": [".stop()"],
   "returns": "void",
   "type": "method",

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

@@ -84,7 +84,7 @@
     {
       "anchor": "AudioSample_stop_",
       "name": "stop()",
-      "desc": "Stops the playback."
+      "desc": "Stops the playback, and sets the cue back to the start of the sample."
     },
     {
       "anchor": "AudioSample_position_",
@@ -135,8 +135,8 @@
   "related": [],
   "name": "AudioSample",
   "classanchor": "sound/AudioSample",
-  "category": "sampling",
-  "subcategory": "",
+  "category": "Sampling",
+  "subcategory": "AudioSample",
   "parameters": [
     {
       "name": "parent",

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

@@ -6,8 +6,8 @@
   "syntax": [".amp(amp)"],
   "returns": "void",
   "type": "method",
-  "category": "audiosample",
-  "subcategory": "",
+  "category": "Sampling",
+  "subcategory": "AudioSample",
   "classanchor": "AudioSample",
   "parameters": [
     {

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

@@ -6,8 +6,8 @@
   "syntax": [".channels()"],
   "returns": "int",
   "type": "method",
-  "category": "audiosample",
-  "subcategory": "",
+  "category": "Sampling",
+  "subcategory": "AudioSample",
   "classanchor": "AudioSample",
   "parameters": []
 }

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

@@ -6,8 +6,8 @@
   "syntax": [".cueFrame(frameNumber)"],
   "returns": "void",
   "type": "method",
-  "category": "audiosample",
-  "subcategory": "",
+  "category": "Sampling",
+  "subcategory": "AudioSample",
   "classanchor": "AudioSample",
   "parameters": [
     {