diff --git a/content/references/examples/sound/Amplitude_stop_/Amplitude_stop_0.pde b/content/references/examples/sound/Amplitude_stop_/Amplitude_stop_0.pde
deleted file mode 100644
index b8d2a337..00000000
--- a/content/references/examples/sound/Amplitude_stop_/Amplitude_stop_0.pde
+++ /dev/null
@@ -1,22 +0,0 @@
-import processing.sound.*;
-Amplitude amp;
-AudioIn in;
-
-void setup() {
- size(640, 360);
- background(255);
-
- // Create an Input stream which is routed into the Amplitude analyzer
- amp = new Amplitude(this);
- in = new AudioIn(this, 0);
- in.start();
- amp.input(in);
-}
-
-void draw() {
- println(amp.analyze());
-}
-
-void mousePressed() {
- in.stop();
-}
diff --git a/content/references/examples/sound/FFT_stop_/FFT_stop_0.pde b/content/references/examples/sound/FFT_stop_/FFT_stop_0.pde
deleted file mode 100644
index cf0dad25..00000000
--- a/content/references/examples/sound/FFT_stop_/FFT_stop_0.pde
+++ /dev/null
@@ -1,36 +0,0 @@
-import processing.sound.*;
-
-FFT fft;
-AudioIn in;
-int bands = 512;
-float[] spectrum = new float[bands];
-
-void setup() {
- size(512, 360);
- background(255);
-
- // Create an Input stream which is routed into the Amplitude analyzer
- fft = new FFT(this, bands);
- in = new AudioIn(this, 0);
-
- // start the Audio Input
- in.start();
-
- // patch the AudioIn
- fft.input(in);
-}
-
-void draw() {
- background(255);
- fft.analyze(spectrum);
-
- for(int i = 0; i < bands; i++){
- // The result of the FFT is normalized
- // draw the line for frequency band i scaling it up by 5 to get more amplitude.
- line( i, height, i, height - spectrum[i]*height*5 );
- }
-}
-
-void mousePressed() {
- in.stop();
-}
diff --git a/content/references/examples/sound/SoundFile_set_/SoundFile_set_0.pde b/content/references/examples/sound/SoundFile_set_/SoundFile_set_0.pde
index 0593cfb9..990d47ed 100644
--- a/content/references/examples/sound/SoundFile_set_/SoundFile_set_0.pde
+++ b/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);
}
diff --git a/content/references/translations/en/sound/Amplitude.json b/content/references/translations/en/sound/Amplitude.json
index 763d486c..84ea3fab 100644
--- a/content/references/translations/en/sound/Amplitude.json
+++ b/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"
+ ]
}
]
}
diff --git a/content/references/translations/en/sound/Amplitude_analyze_.json b/content/references/translations/en/sound/Amplitude_analyze_.json
index f6cdb38d..dbc67330 100644
--- a/content/references/translations/en/sound/Amplitude_analyze_.json
+++ b/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": []
}
diff --git a/content/references/translations/en/sound/Amplitude_input_.json b/content/references/translations/en/sound/Amplitude_input_.json
index 52c16456..253c83eb 100644
--- a/content/references/translations/en/sound/Amplitude_input_.json
+++ b/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": [
{
diff --git a/content/references/translations/en/sound/Amplitude_stop_.json b/content/references/translations/en/sound/Amplitude_stop_.json
deleted file mode 100644
index 2265b13b..00000000
--- a/content/references/translations/en/sound/Amplitude_stop_.json
+++ /dev/null
@@ -1,13 +0,0 @@
-{
- "brief": "",
- "related": [],
- "name": "stop()",
- "description": "",
- "syntax": [".stop()"],
- "returns": "void",
- "type": "method",
- "category": "analysis",
- "subcategory": "Amplitude",
- "classanchor": "Amplitude",
- "parameters": []
-}
diff --git a/content/references/translations/en/sound/AudioIn.json b/content/references/translations/en/sound/AudioIn.json
index d933fee7..57693b73 100644
--- a/content/references/translations/en/sound/AudioIn.json
+++ b/content/references/translations/en/sound/AudioIn.json
@@ -1,20 +1,35 @@
{
"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": "../../",
@@ -22,22 +37,29 @@
"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"
+ ]
}
]
}
diff --git a/content/references/translations/en/sound/AudioIn_add_.json b/content/references/translations/en/sound/AudioIn_add_.json
deleted file mode 100644
index dd1829ed..00000000
--- a/content/references/translations/en/sound/AudioIn_add_.json
+++ /dev/null
@@ -1,19 +0,0 @@
-{
- "brief": "The .add() method is useful for modulating other audio signals.",
- "related": [],
- "name": "add()",
- "description": "The .add() method is useful for modulating other audio signals.",
- "syntax": [".add(add)"],
- "returns": "void",
- "type": "method",
- "category": "I/O",
- "subcategory": "AudioIn",
- "classanchor": "AudioIn",
- "parameters": [
- {
- "name": "add",
- "description": "offset the output of the audio input by the given value",
- "type": ["float"]
- }
- ]
-}
diff --git a/content/references/translations/en/sound/AudioIn_amp_.json b/content/references/translations/en/sound/AudioIn_amp_.json
index 4317bf1a..74e069ab 100644
--- a/content/references/translations/en/sound/AudioIn_amp_.json
+++ b/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"]
}
]
diff --git a/content/references/translations/en/sound/AudioIn_pan_.json b/content/references/translations/en/sound/AudioIn_pan_.json
index bfe3f706..361d8750 100644
--- a/content/references/translations/en/sound/AudioIn_pan_.json
+++ b/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"]
}
]
diff --git a/content/references/translations/en/sound/AudioIn_play_.json b/content/references/translations/en/sound/AudioIn_play_.json
index a69e70fc..4ac6ad64 100644
--- a/content/references/translations/en/sound/AudioIn_play_.json
+++ b/content/references/translations/en/sound/AudioIn_play_.json
@@ -11,8 +11,8 @@
],
"returns": "void",
"type": "method",
- "category": "audioin",
- "subcategory": "",
+ "category": "I/O",
+ "subcategory": "AudioIn",
"classanchor": "AudioIn",
"parameters": [
{
@@ -20,11 +20,6 @@
"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)",
diff --git a/content/references/translations/en/sound/AudioIn_set_.json b/content/references/translations/en/sound/AudioIn_set_.json
index 5a3c03e4..05e13704 100644
--- a/content/references/translations/en/sound/AudioIn_set_.json
+++ b/content/references/translations/en/sound/AudioIn_set_.json
@@ -1,13 +1,13 @@
{
- "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": [
{
@@ -15,11 +15,6 @@
"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)",
diff --git a/content/references/translations/en/sound/AudioIn_start_.json b/content/references/translations/en/sound/AudioIn_start_.json
index 69be4fe0..118ac5f5 100644
--- a/content/references/translations/en/sound/AudioIn_start_.json
+++ b/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": [
{
diff --git a/content/references/translations/en/sound/AudioIn_stop_.json b/content/references/translations/en/sound/AudioIn_stop_.json
index 161c893f..c330d5c8 100644
--- a/content/references/translations/en/sound/AudioIn_stop_.json
+++ b/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",
diff --git a/content/references/translations/en/sound/AudioSample.json b/content/references/translations/en/sound/AudioSample.json
index 2a41e96a..4908e6e6 100644
--- a/content/references/translations/en/sound/AudioSample.json
+++ b/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",
diff --git a/content/references/translations/en/sound/AudioSample_amp_.json b/content/references/translations/en/sound/AudioSample_amp_.json
index 210c1b02..8008909b 100644
--- a/content/references/translations/en/sound/AudioSample_amp_.json
+++ b/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": [
{
diff --git a/content/references/translations/en/sound/AudioSample_channels_.json b/content/references/translations/en/sound/AudioSample_channels_.json
index fe479e1c..ca71eddf 100644
--- a/content/references/translations/en/sound/AudioSample_channels_.json
+++ b/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": []
}
diff --git a/content/references/translations/en/sound/AudioSample_cueFrame_.json b/content/references/translations/en/sound/AudioSample_cueFrame_.json
index 34cb3c84..0a429b8f 100644
--- a/content/references/translations/en/sound/AudioSample_cueFrame_.json
+++ b/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": [
{
diff --git a/content/references/translations/en/sound/AudioSample_cue_.json b/content/references/translations/en/sound/AudioSample_cue_.json
index 7d4f540c..c3bb13e6 100644
--- a/content/references/translations/en/sound/AudioSample_cue_.json
+++ b/content/references/translations/en/sound/AudioSample_cue_.json
@@ -6,8 +6,8 @@
"syntax": [".cue(time)"],
"returns": "void",
"type": "method",
- "category": "audiosample",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "AudioSample",
"classanchor": "AudioSample",
"parameters": [
{
diff --git a/content/references/translations/en/sound/AudioSample_duration_.json b/content/references/translations/en/sound/AudioSample_duration_.json
index d9c9a9d8..b8fe91dd 100644
--- a/content/references/translations/en/sound/AudioSample_duration_.json
+++ b/content/references/translations/en/sound/AudioSample_duration_.json
@@ -6,8 +6,8 @@
"syntax": [".duration()"],
"returns": "float",
"type": "method",
- "category": "audiosample",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "AudioSample",
"classanchor": "AudioSample",
"parameters": []
}
diff --git a/content/references/translations/en/sound/AudioSample_frames_.json b/content/references/translations/en/sound/AudioSample_frames_.json
index 998b100d..ec8a70a9 100644
--- a/content/references/translations/en/sound/AudioSample_frames_.json
+++ b/content/references/translations/en/sound/AudioSample_frames_.json
@@ -6,8 +6,8 @@
"syntax": [".frames()"],
"returns": "int",
"type": "method",
- "category": "audiosample",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "AudioSample",
"classanchor": "AudioSample",
"parameters": []
}
diff --git a/content/references/translations/en/sound/AudioSample_jumpFrame_.json b/content/references/translations/en/sound/AudioSample_jumpFrame_.json
index 1a5cface..5fa149bf 100644
--- a/content/references/translations/en/sound/AudioSample_jumpFrame_.json
+++ b/content/references/translations/en/sound/AudioSample_jumpFrame_.json
@@ -1,13 +1,13 @@
{
"brief": "Jump to a specific position in the audiosample without interrupting playback.",
- "related": [],
+ "related": ["sound/AudioSample_cue_", "sound/AudioSample_play_"],
"name": "jumpFrame()",
"description": "Jump to a specific position in the audiosample without interrupting playback.",
"syntax": [".jumpFrame(frameNumber)"],
"returns": "void",
"type": "method",
- "category": "sound",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "AudioSample",
"classanchor": "AudioSample",
"parameters": []
}
diff --git a/content/references/translations/en/sound/AudioSample_jump_.json b/content/references/translations/en/sound/AudioSample_jump_.json
index b25a15b4..7ad59a93 100644
--- a/content/references/translations/en/sound/AudioSample_jump_.json
+++ b/content/references/translations/en/sound/AudioSample_jump_.json
@@ -1,13 +1,13 @@
{
"brief": "Jump to a specific position in the audiosample while continuing to play (or starting to play if it wasn't playing already).",
- "related": [],
+ "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)"],
"returns": "void",
"type": "method",
- "category": "audiosample",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "AudioSample",
"classanchor": "AudioSample",
"parameters": [
{
diff --git a/content/references/translations/en/sound/AudioSample_loop_.json b/content/references/translations/en/sound/AudioSample_loop_.json
index 9e6b89a7..88f5ef10 100644
--- a/content/references/translations/en/sound/AudioSample_loop_.json
+++ b/content/references/translations/en/sound/AudioSample_loop_.json
@@ -2,7 +2,7 @@
"brief": "Starts the playback of the audiosample.",
"related": [],
"name": "loop()",
- "description": "Starts the playback of the audiosample. Only plays to the end of the audiosample \n once. If cue() or pause() were called previously, playback will resume from the cued position.",
+ "description": "Starts playback which will loop at the end of the audiosample.",
"syntax": [
".loop()",
".loop(rate)",
@@ -12,8 +12,8 @@
],
"returns": "void",
"type": "method",
- "category": "audiosample",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "AudioSample",
"classanchor": "AudioSample",
"parameters": [
{
@@ -30,11 +30,6 @@
"name": "amp",
"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"]
}
]
}
diff --git a/content/references/translations/en/sound/AudioSample_pan_.json b/content/references/translations/en/sound/AudioSample_pan_.json
index dbee5bab..4fb62679 100644
--- a/content/references/translations/en/sound/AudioSample_pan_.json
+++ b/content/references/translations/en/sound/AudioSample_pan_.json
@@ -6,8 +6,8 @@
"syntax": [".pan(pos)"],
"returns": "void",
"type": "method",
- "category": "audiosample",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "AudioSample",
"classanchor": "AudioSample",
"parameters": [
{
diff --git a/content/references/translations/en/sound/AudioSample_pause_.json b/content/references/translations/en/sound/AudioSample_pause_.json
index c59b8efc..27e62a3d 100644
--- a/content/references/translations/en/sound/AudioSample_pause_.json
+++ b/content/references/translations/en/sound/AudioSample_pause_.json
@@ -1,13 +1,13 @@
{
"brief": "Stop the playback of the sample, but cue it to the current position.",
- "related": [],
+ "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 play() will continue playing where it left off.",
"syntax": [".pause()"],
"returns": "void",
"type": "method",
- "category": "audiosample",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "AudioSample",
"classanchor": "AudioSample",
"parameters": []
}
diff --git a/content/references/translations/en/sound/AudioSample_percent_.json b/content/references/translations/en/sound/AudioSample_percent_.json
index 8b97a3a0..da56b696 100644
--- a/content/references/translations/en/sound/AudioSample_percent_.json
+++ b/content/references/translations/en/sound/AudioSample_percent_.json
@@ -6,8 +6,8 @@
"syntax": [".percent()"],
"returns": "float",
"type": "method",
- "category": "sound",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "AudioSample",
"classanchor": "AudioSample",
"parameters": []
}
diff --git a/content/references/translations/en/sound/AudioSample_playFor_.json b/content/references/translations/en/sound/AudioSample_playFor_.json
index 5c77b48f..693f001f 100644
--- a/content/references/translations/en/sound/AudioSample_playFor_.json
+++ b/content/references/translations/en/sound/AudioSample_playFor_.json
@@ -6,8 +6,8 @@
"syntax": [".playFor(duration)", ".playFor(duration, cue)"],
"returns": "void",
"type": "method",
- "category": "sound",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "AudioSample",
"classanchor": "AudioSample",
"parameters": [
{
diff --git a/content/references/translations/en/sound/AudioSample_play_.json b/content/references/translations/en/sound/AudioSample_play_.json
index 439f6dc6..984989a3 100644
--- a/content/references/translations/en/sound/AudioSample_play_.json
+++ b/content/references/translations/en/sound/AudioSample_play_.json
@@ -13,8 +13,8 @@
],
"returns": "void",
"type": "method",
- "category": "audiosample",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "AudioSample",
"classanchor": "AudioSample",
"parameters": [
{
diff --git a/content/references/translations/en/sound/AudioSample_positionFrame_.json b/content/references/translations/en/sound/AudioSample_positionFrame_.json
index c9bd5d4e..102355a0 100644
--- a/content/references/translations/en/sound/AudioSample_positionFrame_.json
+++ b/content/references/translations/en/sound/AudioSample_positionFrame_.json
@@ -6,8 +6,8 @@
"syntax": [".positionFrame()"],
"returns": "int",
"type": "method",
- "category": "sound",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "AudioSample",
"classanchor": "AudioSample",
"parameters": []
}
diff --git a/content/references/translations/en/sound/AudioSample_position_.json b/content/references/translations/en/sound/AudioSample_position_.json
index ee0090a3..6221a6ce 100644
--- a/content/references/translations/en/sound/AudioSample_position_.json
+++ b/content/references/translations/en/sound/AudioSample_position_.json
@@ -6,8 +6,8 @@
"syntax": [".position()"],
"returns": "float",
"type": "method",
- "category": "audiosample",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "AudioSample",
"classanchor": "AudioSample",
"parameters": []
}
diff --git a/content/references/translations/en/sound/AudioSample_rate_.json b/content/references/translations/en/sound/AudioSample_rate_.json
index df0c9496..518cc0f0 100644
--- a/content/references/translations/en/sound/AudioSample_rate_.json
+++ b/content/references/translations/en/sound/AudioSample_rate_.json
@@ -6,8 +6,8 @@
"syntax": [".rate(rate)"],
"returns": "void",
"type": "method",
- "category": "audiosample",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "AudioSample",
"classanchor": "AudioSample",
"parameters": [
{
diff --git a/content/references/translations/en/sound/AudioSample_read_.json b/content/references/translations/en/sound/AudioSample_read_.json
index 34e091e1..26608f67 100644
--- a/content/references/translations/en/sound/AudioSample_read_.json
+++ b/content/references/translations/en/sound/AudioSample_read_.json
@@ -11,8 +11,8 @@
],
"returns": "void or float",
"type": "method",
- "category": "audiosample",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "AudioSample",
"classanchor": "AudioSample",
"parameters": [
{
diff --git a/content/references/translations/en/sound/AudioSample_resize_.json b/content/references/translations/en/sound/AudioSample_resize_.json
index c6716ab5..51379c51 100644
--- a/content/references/translations/en/sound/AudioSample_resize_.json
+++ b/content/references/translations/en/sound/AudioSample_resize_.json
@@ -6,8 +6,8 @@
"syntax": [".resize(frames)", ".resize(frames, stereo)"],
"returns": "void",
"type": "method",
- "category": "audiosample",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "AudioSample",
"classanchor": "AudioSample",
"parameters": [
{
diff --git a/content/references/translations/en/sound/AudioSample_sampleRate_.json b/content/references/translations/en/sound/AudioSample_sampleRate_.json
index 36caebe6..7f2a39f1 100644
--- a/content/references/translations/en/sound/AudioSample_sampleRate_.json
+++ b/content/references/translations/en/sound/AudioSample_sampleRate_.json
@@ -6,8 +6,8 @@
"syntax": [".sampleRate()"],
"returns": "int",
"type": "method",
- "category": "audiosample",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "AudioSample",
"classanchor": "AudioSample",
"parameters": []
}
diff --git a/content/references/translations/en/sound/AudioSample_set_.json b/content/references/translations/en/sound/AudioSample_set_.json
index 58356deb..5a831b44 100644
--- a/content/references/translations/en/sound/AudioSample_set_.json
+++ b/content/references/translations/en/sound/AudioSample_set_.json
@@ -3,11 +3,11 @@
"related": [],
"name": "set()",
"description": "Set multiple parameters at once.",
- "syntax": [".set(rate, pos, amp, add)"],
+ "syntax": [".set(rate, pos, amp)", ".set(rate, pos, amp, add)"],
"returns": "void",
"type": "method",
- "category": "audiosample",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "AudioSample",
"classanchor": "AudioSample",
"parameters": [
{
@@ -24,11 +24,6 @@
"name": "amp",
"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"]
}
]
}
diff --git a/content/references/translations/en/sound/AudioSample_stop_.json b/content/references/translations/en/sound/AudioSample_stop_.json
index 6c95bccf..e08e9756 100644
--- a/content/references/translations/en/sound/AudioSample_stop_.json
+++ b/content/references/translations/en/sound/AudioSample_stop_.json
@@ -1,13 +1,13 @@
{
- "brief": "Stops the playback.",
+ "brief": "Stops the playback, and sets the cue back to the start of the sample.",
"related": [],
"name": "stop()",
- "description": "Stops the playback.",
+ "description": "Stops the playback, and sets the cue back to the start of the sample.",
"syntax": [".stop()"],
"returns": "void",
"type": "method",
- "category": "audiosample",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "AudioSample",
"classanchor": "AudioSample",
"parameters": []
}
diff --git a/content/references/translations/en/sound/AudioSample_write_.json b/content/references/translations/en/sound/AudioSample_write_.json
index ad8362fa..95cda0f2 100644
--- a/content/references/translations/en/sound/AudioSample_write_.json
+++ b/content/references/translations/en/sound/AudioSample_write_.json
@@ -10,8 +10,8 @@
],
"returns": "void",
"type": "method",
- "category": "audiosample",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "AudioSample",
"classanchor": "AudioSample",
"parameters": [
{
diff --git a/content/references/translations/en/sound/BandPass.json b/content/references/translations/en/sound/BandPass.json
index 5a6224d1..6f450a3e 100644
--- a/content/references/translations/en/sound/BandPass.json
+++ b/content/references/translations/en/sound/BandPass.json
@@ -11,10 +11,20 @@
"name": "freq()",
"desc": "Set the cutoff frequency for the filter."
},
+ {
+ "anchor": "BandPass_process_",
+ "name": "process()",
+ "desc": "Start applying this bandpass filter to an input signal."
+ },
{
"anchor": "BandPass_set_",
"name": "set()",
"desc": "Sets frequency and bandwidth of the filter with one method."
+ },
+ {
+ "anchor": "BandPass_stop_",
+ "name": "stop()",
+ "desc": "Stop the effect."
}
],
"csspath": "../../",
@@ -22,11 +32,13 @@
"classFields": [],
"description": "This is a band pass filter.",
"type": "class",
- "constructors": ["BandPass(parent)"],
+ "constructors": [
+ "BandPass(parent)"
+ ],
"related": [],
"name": "BandPass",
"classanchor": "sound/BandPass",
- "category": "effects",
- "subcategory": "",
+ "category": "Effects",
+ "subcategory": "BandPass",
"parameters": []
}
diff --git a/content/references/translations/en/sound/BandPass_bw_.json b/content/references/translations/en/sound/BandPass_bw_.json
index d1df62be..1083b4a1 100644
--- a/content/references/translations/en/sound/BandPass_bw_.json
+++ b/content/references/translations/en/sound/BandPass_bw_.json
@@ -6,8 +6,8 @@
"syntax": [".bw(bw)"],
"returns": "void",
"type": "method",
- "category": "bandpass",
- "subcategory": "",
+ "category": "Effects",
+ "subcategory": "BandPass",
"classanchor": "BandPass",
"parameters": []
}
diff --git a/content/references/translations/en/sound/BandPass_freq_.json b/content/references/translations/en/sound/BandPass_freq_.json
index 941bc7d6..2bb49045 100644
--- a/content/references/translations/en/sound/BandPass_freq_.json
+++ b/content/references/translations/en/sound/BandPass_freq_.json
@@ -6,8 +6,8 @@
"syntax": [".freq(freq)"],
"returns": "void",
"type": "method",
- "category": "bandpass",
- "subcategory": "",
+ "category": "Effects",
+ "subcategory": "BandPass",
"classanchor": "BandPass",
"parameters": [
{
diff --git a/content/references/translations/en/sound/BandPass_process_.json b/content/references/translations/en/sound/BandPass_process_.json
index 4afffa9b..3a7accbf 100644
--- a/content/references/translations/en/sound/BandPass_process_.json
+++ b/content/references/translations/en/sound/BandPass_process_.json
@@ -1,19 +1,25 @@
{
- "brief": "Start the filter.",
+ "brief": "Start applying this bandpass filter to an input signal.",
"related": [],
"name": "process()",
- "description": "Start the filter.",
- "syntax": [".process(input)"],
+ "description": "Start applying this bandpass filter to an input signal.",
+ "syntax": [".process(input, freq)", ".process(input, freq, bw)"],
"returns": "void",
"type": "method",
- "category": "effects",
+ "category": "Effects",
"subcategory": "BandPass",
"classanchor": "BandPass",
"parameters": [
{
"name": "input",
- "description": "Input audio source",
+ "description": "the sound source to apply the filter to",
"type": ["SoundObject"]
- }
+ },
+ {
+ "name": "freq",
+ "description": "Cutoff frequency between 0 and 20000",
+ "type": ["float"]
+ },
+ { "name": "bw", "description": "Set the bandwidth", "type": ["float"] }
]
}
diff --git a/content/references/translations/en/sound/BandPass_set_.json b/content/references/translations/en/sound/BandPass_set_.json
index c404b8d2..00604221 100644
--- a/content/references/translations/en/sound/BandPass_set_.json
+++ b/content/references/translations/en/sound/BandPass_set_.json
@@ -6,8 +6,8 @@
"syntax": [".set(freq, bw)"],
"returns": "void",
"type": "method",
- "category": "bandpass",
- "subcategory": "",
+ "category": "Effects",
+ "subcategory": "BandPass",
"classanchor": "BandPass",
"parameters": [
{ "name": "freq", "description": "Set the frequency", "type": ["float"] },
diff --git a/content/references/translations/en/sound/BandPass_stop_.json b/content/references/translations/en/sound/BandPass_stop_.json
index b1046cd5..3a81abdb 100644
--- a/content/references/translations/en/sound/BandPass_stop_.json
+++ b/content/references/translations/en/sound/BandPass_stop_.json
@@ -1,12 +1,12 @@
{
- "brief": "Stops the filter.",
+ "brief": "Stop the effect.",
"related": [],
"name": "stop()",
- "description": "Stops the filter.",
+ "description": "Stop the effect.",
"syntax": [".stop()"],
"returns": "void",
"type": "method",
- "category": "effects",
+ "category": "Effects",
"subcategory": "BandPass",
"classanchor": "BandPass",
"parameters": []
diff --git a/content/references/translations/en/sound/BeatDetector.json b/content/references/translations/en/sound/BeatDetector.json
index 240a3a36..29235068 100644
--- a/content/references/translations/en/sound/BeatDetector.json
+++ b/content/references/translations/en/sound/BeatDetector.json
@@ -1,6 +1,11 @@
{
"brief": "Looks for spikes in the energy of an audio signal\n which are often associated with rhythmic musical beats and can be used to trigger a\n response whenever the incoming audio signal pulses.",
"methods": [
+ {
+ "anchor": "BeatDetector_input_",
+ "name": "input()",
+ "desc": "Define the audio input for the analyzer."
+ },
{
"anchor": "BeatDetector_isBeat_",
"name": "isBeat()",
@@ -22,17 +27,21 @@
"classFields": [],
"description": "The BeatDetector analyzer looks for spikes in the energy of an audio signal\n which are often associated with rhythmic musical beats and can be used to trigger a\n response whenever the incoming audio signal pulses. Note that this\n implementation does not return a tempo or BPM (beats per minute) value \\u2014 it\n can only tell you whether the current moment of audio contains a beat or not.",
"type": "class",
- "constructors": ["BeatDetector(parent)"],
+ "constructors": [
+ "BeatDetector(parent)"
+ ],
"related": [],
"name": "BeatDetector",
"classanchor": "sound/BeatDetector",
- "category": "analysis",
- "subcategory": "",
+ "category": "Analysis",
+ "subcategory": "BeatDetector",
"parameters": [
{
"name": "parent",
"description": "Typically \"this\"",
- "type": ["PApplet"]
+ "type": [
+ "PApplet"
+ ]
}
]
}
diff --git a/content/references/translations/en/sound/BeatDetector_input_.json b/content/references/translations/en/sound/BeatDetector_input_.json
new file mode 100644
index 00000000..cf535aee
--- /dev/null
+++ b/content/references/translations/en/sound/BeatDetector_input_.json
@@ -0,0 +1,19 @@
+{
+ "brief": "Define the audio input for the analyzer.",
+ "related": [],
+ "name": "input()",
+ "description": "Define the audio input for the analyzer.",
+ "syntax": [".input(input)"],
+ "returns": "void",
+ "type": "method",
+ "category": "Analysis",
+ "subcategory": "BeatDetector",
+ "classanchor": "BeatDetector",
+ "parameters": [
+ {
+ "name": "input",
+ "description": "The input sound source",
+ "type": ["SoundObject"]
+ }
+ ]
+}
diff --git a/content/references/translations/en/sound/BeatDetector_isBeat_.json b/content/references/translations/en/sound/BeatDetector_isBeat_.json
index dae1f357..b6d11cbb 100644
--- a/content/references/translations/en/sound/BeatDetector_isBeat_.json
+++ b/content/references/translations/en/sound/BeatDetector_isBeat_.json
@@ -6,8 +6,8 @@
"syntax": [".isBeat()"],
"returns": "boolean",
"type": "method",
- "category": "beatdetector",
- "subcategory": "",
+ "category": "Analysis",
+ "subcategory": "BeatDetector",
"classanchor": "BeatDetector",
"parameters": []
}
diff --git a/content/references/translations/en/sound/BeatDetector_sensitivity_.json b/content/references/translations/en/sound/BeatDetector_sensitivity_.json
index 5cb814e3..59c82edf 100644
--- a/content/references/translations/en/sound/BeatDetector_sensitivity_.json
+++ b/content/references/translations/en/sound/BeatDetector_sensitivity_.json
@@ -6,8 +6,8 @@
"syntax": [".sensitivity(sensitivity)", ".sensitivity()"],
"returns": "int or void",
"type": "method",
- "category": "beatdetector",
- "subcategory": "",
+ "category": "Analysis",
+ "subcategory": "BeatDetector",
"classanchor": "BeatDetector",
"parameters": [
{
diff --git a/content/references/translations/en/sound/BrownNoise.json b/content/references/translations/en/sound/BrownNoise.json
index da2dd49f..e4270bbd 100644
--- a/content/references/translations/en/sound/BrownNoise.json
+++ b/content/references/translations/en/sound/BrownNoise.json
@@ -4,32 +4,27 @@
{
"anchor": "BrownNoise_amp_",
"name": "amp()",
- "desc": "Changes the amplitude/volume of the noise generator."
+ "desc": "Change the amplitude/volume of this sound."
+ },
+ {
+ "anchor": "BrownNoise_pan_",
+ "name": "pan()",
+ "desc": "Move the sound in a stereo panorama."
},
{
"anchor": "BrownNoise_play_",
"name": "play()",
- "desc": "Start the generator."
+ "desc": "Starts the noise"
},
{
"anchor": "BrownNoise_set_",
"name": "set()",
- "desc": "Sets amplitude, add and pan position with one method."
- },
- {
- "anchor": "BrownNoise_add_",
- "name": "add()",
- "desc": "Offset the output of this generator by a fixed value."
- },
- {
- "anchor": "BrownNoise_pan_",
- "name": "pan()",
- "desc": "Pan the generator in a stereo panorama."
+ "desc": "Set the amplitude and panoramic position with one method."
},
{
"anchor": "BrownNoise_stop_",
"name": "stop()",
- "desc": "Stops the Brown Noise generator."
+ "desc": "Stop the noise from playing back"
}
],
"csspath": "../../",
@@ -37,17 +32,21 @@
"classFields": [],
"description": "Brown noise (also called red noise) has higher energy at lower frequencies. Its power density\n decreases 6dB per octave.\n \n Please be aware that, because most of its power resides in the bass frequencies, the subjective\n loudness of brown noise relative to other sounds can vary dramatically depending on how well\n your sound system can reproduce low frequency sounds!",
"type": "class",
- "constructors": ["BrownNoise(parent)"],
+ "constructors": [
+ "BrownNoise(parent)"
+ ],
"related": [],
"name": "BrownNoise",
"classanchor": "sound/BrownNoise",
- "category": "noise",
- "subcategory": "",
+ "category": "Noise",
+ "subcategory": "BrownNoise",
"parameters": [
{
"name": "parent",
"description": "typically use \"this\"",
- "type": ["PApplet"]
+ "type": [
+ "PApplet"
+ ]
}
]
}
diff --git a/content/references/translations/en/sound/BrownNoise_add_.json b/content/references/translations/en/sound/BrownNoise_add_.json
deleted file mode 100644
index 7cc977ee..00000000
--- a/content/references/translations/en/sound/BrownNoise_add_.json
+++ /dev/null
@@ -1,19 +0,0 @@
-{
- "brief": "Offset the output of this generator by a fixed value.",
- "related": [],
- "name": "add()",
- "description": "Offset the output of this generator by a fixed value.",
- "syntax": [".add(add)"],
- "returns": "void",
- "type": "method",
- "category": "brownnoise",
- "subcategory": "",
- "classanchor": "BrownNoise",
- "parameters": [
- {
- "name": "add",
- "description": "offset the output of the generator by the given value",
- "type": ["float"]
- }
- ]
-}
diff --git a/content/references/translations/en/sound/BrownNoise_amp_.json b/content/references/translations/en/sound/BrownNoise_amp_.json
index ca1dfb22..e0988bf6 100644
--- a/content/references/translations/en/sound/BrownNoise_amp_.json
+++ b/content/references/translations/en/sound/BrownNoise_amp_.json
@@ -1,18 +1,18 @@
{
- "brief": "Changes the amplitude/volume of the noise generator.",
+ "brief": "Change the amplitude/volume of this sound.",
"related": [],
"name": "amp()",
- "description": "Changes the amplitude/volume of the noise generator. Allowed values are between 0.0 and 1.0.",
+ "description": "Change the amplitude/volume of this sound.",
"syntax": [".amp(amp)"],
"returns": "void",
"type": "method",
- "category": "brownnoise",
- "subcategory": "",
+ "category": "Noise",
+ "subcategory": "BrownNoise",
"classanchor": "BrownNoise",
"parameters": [
{
"name": "amp",
- "description": "the amplitude of the noise 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"]
}
]
diff --git a/content/references/translations/en/sound/BrownNoise_pan_.json b/content/references/translations/en/sound/BrownNoise_pan_.json
index 6757ad4b..99f63d6b 100644
--- a/content/references/translations/en/sound/BrownNoise_pan_.json
+++ b/content/references/translations/en/sound/BrownNoise_pan_.json
@@ -1,18 +1,18 @@
{
- "brief": "Pan the generator in a stereo panorama.",
+ "brief": "Move the sound in a stereo panorama.",
"related": [],
"name": "pan()",
- "description": "Pan the generator 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",
- "category": "brownnoise",
- "subcategory": "",
+ "category": "Noise",
+ "subcategory": "BrownNoise",
"classanchor": "BrownNoise",
"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"]
}
]
diff --git a/content/references/translations/en/sound/BrownNoise_play_.json b/content/references/translations/en/sound/BrownNoise_play_.json
index de8b239e..0e93b4da 100644
--- a/content/references/translations/en/sound/BrownNoise_play_.json
+++ b/content/references/translations/en/sound/BrownNoise_play_.json
@@ -1,33 +1,23 @@
{
- "brief": "Start the generator.",
+ "brief": "Starts the noise",
"related": [],
"name": "play()",
- "description": "Start the generator.",
- "syntax": [
- ".play()",
- ".play(amp)",
- ".play(amp, pos)",
- ".play(amp, add, pos)"
- ],
+ "description": "Starts the noise",
+ "syntax": [".play(amp)", ".play(amp, pos)", ".play(amp, add, pos)"],
"returns": "void",
"type": "method",
- "category": "brownnoise",
- "subcategory": "",
+ "category": "Noise",
+ "subcategory": "BrownNoise",
"classanchor": "BrownNoise",
"parameters": [
{
"name": "amp",
- "description": "the amplitude of the noise as a value from 0.0 (complete silence) to 1.0 (full volume)",
- "type": ["float"]
- },
- {
- "name": "add",
- "description": "offset the output of the noise by given value",
+ "description": "The amplitude of the noise as a value between 0.0 and 1.0.",
"type": ["float"]
},
{
"name": "pos",
- "description": "pan the generator in stereo panorama. Allowed values are between -1.0 and 1.0.",
+ "description": "The panoramic position of the noise as a float from -1.0 to 1.0.",
"type": ["float"]
}
]
diff --git a/content/references/translations/en/sound/BrownNoise_set_.json b/content/references/translations/en/sound/BrownNoise_set_.json
index c8cf71e6..61a33a02 100644
--- a/content/references/translations/en/sound/BrownNoise_set_.json
+++ b/content/references/translations/en/sound/BrownNoise_set_.json
@@ -1,28 +1,23 @@
{
- "brief": "Sets amplitude, add and pan position with one method.",
+ "brief": "Set the amplitude and panoramic position with one method.",
"related": [],
"name": "set()",
- "description": "Sets amplitude, add and pan position with one method.",
- "syntax": [".set(amp, add, pos)"],
+ "description": "Set the amplitude and panoramic position with one method.",
+ "syntax": [".set(amp, pos)"],
"returns": "void",
"type": "method",
- "category": "brownnoise",
- "subcategory": "",
+ "category": "Noise",
+ "subcategory": "BrownNoise",
"classanchor": "BrownNoise",
"parameters": [
{
"name": "amp",
- "description": "the amplitude of the noise as a value from 0.0 (complete silence) to 1.0 (full volume)",
- "type": ["float"]
- },
- {
- "name": "add",
- "description": "offset the output of the noise by given value",
+ "description": "The amplitude of the noise as a value between 0.0 and 1.0.",
"type": ["float"]
},
{
"name": "pos",
- "description": "pan the generator in stereo panorama. Allowed values are between -1.0 and 1.0.",
+ "description": "The panoramic position of the noise as a float from -1.0 to 1.0.",
"type": ["float"]
}
]
diff --git a/content/references/translations/en/sound/BrownNoise_stop_.json b/content/references/translations/en/sound/BrownNoise_stop_.json
index 3ea936f3..45b63157 100644
--- a/content/references/translations/en/sound/BrownNoise_stop_.json
+++ b/content/references/translations/en/sound/BrownNoise_stop_.json
@@ -1,13 +1,13 @@
{
- "brief": "Stops the Brown Noise generator.",
+ "brief": "Stop the noise from playing back",
"related": [],
"name": "stop()",
- "description": "Stop the generator",
+ "description": "Stop the noise from playing back",
"syntax": [".stop()"],
"returns": "void",
"type": "method",
- "category": "brownnoise",
- "subcategory": "",
+ "category": "Noise",
+ "subcategory": "BrownNoise",
"classanchor": "BrownNoise",
"parameters": []
}
diff --git a/content/references/translations/en/sound/Delay.json b/content/references/translations/en/sound/Delay.json
index 336e4962..7962aa43 100644
--- a/content/references/translations/en/sound/Delay.json
+++ b/content/references/translations/en/sound/Delay.json
@@ -1,6 +1,11 @@
{
"brief": "This is a simple delay effect.",
"methods": [
+ {
+ "anchor": "Delay_feedback_",
+ "name": "feedback()",
+ "desc": "Change the feedback of the delay effect."
+ },
{
"anchor": "Delay_process_",
"name": "process()",
@@ -11,15 +16,15 @@
"name": "set()",
"desc": "Set delay time and feedback values at once."
},
+ {
+ "anchor": "Delay_stop_",
+ "name": "stop()",
+ "desc": "Stop the effect."
+ },
{
"anchor": "Delay_time_",
"name": "time()",
"desc": "Changes the delay time of the effect."
- },
- {
- "anchor": "Delay_feedback_",
- "name": "feedback()",
- "desc": "Change the feedback of the delay effect."
}
],
"csspath": "../../",
@@ -27,11 +32,13 @@
"classFields": [],
"description": "This is a simple delay effect.",
"type": "class",
- "constructors": ["Delay(parent)"],
+ "constructors": [
+ "Delay(parent)"
+ ],
"related": [],
"name": "Delay",
"classanchor": "sound/Delay",
- "category": "effects",
- "subcategory": "",
+ "category": "Effects",
+ "subcategory": "Delay",
"parameters": []
}
diff --git a/content/references/translations/en/sound/Delay_feedback_.json b/content/references/translations/en/sound/Delay_feedback_.json
index f653ed42..15b332ac 100644
--- a/content/references/translations/en/sound/Delay_feedback_.json
+++ b/content/references/translations/en/sound/Delay_feedback_.json
@@ -6,8 +6,8 @@
"syntax": [".feedback(feedback)"],
"returns": "void",
"type": "method",
- "category": "delay",
- "subcategory": "",
+ "category": "Effects",
+ "subcategory": "Delay",
"classanchor": "Delay",
"parameters": [
{
diff --git a/content/references/translations/en/sound/Delay_process_.json b/content/references/translations/en/sound/Delay_process_.json
index 44eef8e5..7e82eb75 100644
--- a/content/references/translations/en/sound/Delay_process_.json
+++ b/content/references/translations/en/sound/Delay_process_.json
@@ -9,8 +9,8 @@
],
"returns": "void",
"type": "method",
- "category": "delay",
- "subcategory": "",
+ "category": "Effects",
+ "subcategory": "Delay",
"classanchor": "Delay",
"parameters": [
{
diff --git a/content/references/translations/en/sound/Delay_set_.json b/content/references/translations/en/sound/Delay_set_.json
index de80325b..3fc9ccd4 100644
--- a/content/references/translations/en/sound/Delay_set_.json
+++ b/content/references/translations/en/sound/Delay_set_.json
@@ -6,8 +6,8 @@
"syntax": [".set(delayTime, feedback)"],
"returns": "void",
"type": "method",
- "category": "delay",
- "subcategory": "",
+ "category": "Effects",
+ "subcategory": "Delay",
"classanchor": "Delay",
"parameters": [
{
diff --git a/content/references/translations/en/sound/Delay_stop_.json b/content/references/translations/en/sound/Delay_stop_.json
index 47346e7f..3d93c2ba 100644
--- a/content/references/translations/en/sound/Delay_stop_.json
+++ b/content/references/translations/en/sound/Delay_stop_.json
@@ -1,12 +1,12 @@
{
- "brief": "Stops the effect.",
+ "brief": "Stop the effect.",
"related": [],
"name": "stop()",
- "description": "Stops the effect.",
+ "description": "Stop the effect.",
"syntax": [".stop()"],
"returns": "void",
"type": "method",
- "category": "effects",
+ "category": "Effects",
"subcategory": "Delay",
"classanchor": "Delay",
"parameters": []
diff --git a/content/references/translations/en/sound/Delay_time_.json b/content/references/translations/en/sound/Delay_time_.json
index bcb4f73a..e583c381 100644
--- a/content/references/translations/en/sound/Delay_time_.json
+++ b/content/references/translations/en/sound/Delay_time_.json
@@ -6,8 +6,8 @@
"syntax": [".time(delayTime)"],
"returns": "void",
"type": "method",
- "category": "delay",
- "subcategory": "",
+ "category": "Effects",
+ "subcategory": "Delay",
"classanchor": "Delay",
"parameters": [
{
diff --git a/content/references/translations/en/sound/Env.json b/content/references/translations/en/sound/Env.json
index 1fc7bd13..526d3955 100644
--- a/content/references/translations/en/sound/Env.json
+++ b/content/references/translations/en/sound/Env.json
@@ -16,7 +16,7 @@
"related": [],
"name": "Env",
"classanchor": "sound/Env",
- "category": "envelopes",
+ "category": "Envelopes",
"subcategory": "",
"parameters": []
}
diff --git a/content/references/translations/en/sound/Env_play_.json b/content/references/translations/en/sound/Env_play_.json
index 7444ad50..dba16326 100644
--- a/content/references/translations/en/sound/Env_play_.json
+++ b/content/references/translations/en/sound/Env_play_.json
@@ -8,7 +8,7 @@
],
"returns": "void",
"type": "method",
- "category": "env",
+ "category": "Envelopes",
"subcategory": "",
"classanchor": "Env",
"parameters": [
diff --git a/content/references/translations/en/sound/FFT.json b/content/references/translations/en/sound/FFT.json
index 710a81d0..ad61e2a0 100644
--- a/content/references/translations/en/sound/FFT.json
+++ b/content/references/translations/en/sound/FFT.json
@@ -6,6 +6,11 @@
"name": "analyze()",
"desc": "Calculates the current frequency spectrum and returns it as an array with as many elements as frequency bands."
},
+ {
+ "anchor": "FFT_analyzeSample_",
+ "name": "analyzeSample()",
+ "desc": "Calculates the frequency spectrum of the given sample, returning an array of magnitudes."
+ },
{
"anchor": "FFT_input_",
"name": "input()",
@@ -17,22 +22,29 @@
"classFields": [],
"description": "This is a Fast Fourier Transform (FFT) analyzer. It calculates the normalized\n power spectrum of an audio stream the moment it is queried with the analyze()\n method.",
"type": "class",
- "constructors": ["FFT(parent)", "FFT(parent, bands)"],
+ "constructors": [
+ "FFT(parent)",
+ "FFT(parent, bands)"
+ ],
"related": [],
"name": "FFT",
"classanchor": "sound/FFT",
- "category": "analysis",
- "subcategory": "",
+ "category": "Analysis",
+ "subcategory": "FFT",
"parameters": [
{
"name": "parent",
"description": "typically use \"this\"",
- "type": ["PApplet"]
+ "type": [
+ "PApplet"
+ ]
},
{
"name": "bands",
"description": "number of frequency bands for the FFT as an integer (default 512).\n This parameter needs to be a power of 2 (e.g. 16, 32, 64, 128,\n ...).",
- "type": ["int"]
+ "type": [
+ "int"
+ ]
}
]
}
diff --git a/content/references/translations/en/sound/FFT_analyzeSample_.json b/content/references/translations/en/sound/FFT_analyzeSample_.json
new file mode 100644
index 00000000..41c64c7f
--- /dev/null
+++ b/content/references/translations/en/sound/FFT_analyzeSample_.json
@@ -0,0 +1,24 @@
+{
+ "brief": "Calculates the frequency spectrum of the given sample, returning an array of magnitudes.",
+ "related": [],
+ "name": "analyzeSample()",
+ "description": "Calculates the frequency spectrum of the given sample and returns an array of magnitudes, one\n for each frequency band.\n\n This version is intended to be used in non-real time processing, particularly when you are\n creating an animation in non-real time and want to get the FFT for a particular chunk of an audio sample.\n\n For stereo samples, you can call this function once for each channel, so you can display the left and right\n fft values separately.",
+ "syntax": [".analyzeSample(sample, numBands)"],
+ "returns": "float[]",
+ "type": "method",
+ "category": "Analysis",
+ "subcategory": "FFT",
+ "classanchor": "FFT",
+ "parameters": [
+ {
+ "name": "sample",
+ "description": "an array with sound samples",
+ "type": ["float[]"]
+ },
+ {
+ "name": "numBands",
+ "description": "the number of fft bands requested. Must be a power of 2 (one of 2, 4, 8, 16 etc.)",
+ "type": ["int"]
+ }
+ ]
+}
diff --git a/content/references/translations/en/sound/FFT_analyze_.json b/content/references/translations/en/sound/FFT_analyze_.json
index d0d2b6b8..62d57e0d 100644
--- a/content/references/translations/en/sound/FFT_analyze_.json
+++ b/content/references/translations/en/sound/FFT_analyze_.json
@@ -2,12 +2,12 @@
"brief": "Calculates the current frequency spectrum and returns it as an array with as many elements as frequency bands.",
"related": [],
"name": "analyze()",
- "description": "Calculates the current frequency spectrum and returns it as an array with as many elements as frequency bands.",
+ "description": "Calculates the current frequency spectrum from the input source and returns\n it as an array with as many elements as frequency bands.",
"syntax": [".analyze()", ".analyze(value)"],
"returns": "float[]",
"type": "method",
- "category": "fft",
- "subcategory": "",
+ "category": "Analysis",
+ "subcategory": "FFT",
"classanchor": "FFT",
"parameters": [
{
diff --git a/content/references/translations/en/sound/FFT_input_.json b/content/references/translations/en/sound/FFT_input_.json
index e0fc1a30..545ed0bc 100644
--- a/content/references/translations/en/sound/FFT_input_.json
+++ b/content/references/translations/en/sound/FFT_input_.json
@@ -6,13 +6,13 @@
"syntax": [".input(input)"],
"returns": "void",
"type": "method",
- "category": "fft",
- "subcategory": "",
+ "category": "Analysis",
+ "subcategory": "FFT",
"classanchor": "FFT",
"parameters": [
{
"name": "input",
- "description": "the input sound source. Can be an oscillator, noise generator,\n SoundFile or AudioIn.",
+ "description": "The input sound source",
"type": ["SoundObject"]
}
]
diff --git a/content/references/translations/en/sound/FFT_stop_.json b/content/references/translations/en/sound/FFT_stop_.json
deleted file mode 100644
index 353f9db1..00000000
--- a/content/references/translations/en/sound/FFT_stop_.json
+++ /dev/null
@@ -1,13 +0,0 @@
-{
- "brief": "Stops the FFT.",
- "related": [],
- "name": "stop()",
- "description": "Stops the FFT.",
- "syntax": [".stop()"],
- "returns": "void",
- "type": "method",
- "category": "analysis",
- "subcategory": "FFT",
- "classanchor": "FFT",
- "parameters": []
-}
diff --git a/content/references/translations/en/sound/HighPass.json b/content/references/translations/en/sound/HighPass.json
index d276ab5c..707b051f 100644
--- a/content/references/translations/en/sound/HighPass.json
+++ b/content/references/translations/en/sound/HighPass.json
@@ -5,6 +5,16 @@
"anchor": "HighPass_freq_",
"name": "freq()",
"desc": "Set the cut off frequency for the filter."
+ },
+ {
+ "anchor": "HighPass_process_",
+ "name": "process()",
+ "desc": "Start applying this highpass filter to an input signal."
+ },
+ {
+ "anchor": "HighPass_stop_",
+ "name": "stop()",
+ "desc": "Stop the effect."
}
],
"csspath": "../../",
@@ -12,11 +22,13 @@
"classFields": [],
"description": "This is a high pass filter.",
"type": "class",
- "constructors": ["HighPass(parent)"],
+ "constructors": [
+ "HighPass(parent)"
+ ],
"related": [],
"name": "HighPass",
"classanchor": "sound/HighPass",
- "category": "effects",
- "subcategory": "",
+ "category": "Effects",
+ "subcategory": "HighPass",
"parameters": []
}
diff --git a/content/references/translations/en/sound/HighPass_freq_.json b/content/references/translations/en/sound/HighPass_freq_.json
index 060e7d2a..2a852e0e 100644
--- a/content/references/translations/en/sound/HighPass_freq_.json
+++ b/content/references/translations/en/sound/HighPass_freq_.json
@@ -6,8 +6,8 @@
"syntax": [".freq(freq)"],
"returns": "void",
"type": "method",
- "category": "highpass",
- "subcategory": "",
+ "category": "Effects",
+ "subcategory": "HighPass",
"classanchor": "HighPass",
"parameters": [
{
diff --git a/content/references/translations/en/sound/HighPass_process_.json b/content/references/translations/en/sound/HighPass_process_.json
index 02ca8556..cc766245 100644
--- a/content/references/translations/en/sound/HighPass_process_.json
+++ b/content/references/translations/en/sound/HighPass_process_.json
@@ -1,19 +1,20 @@
{
- "brief": "Start the filter.",
+ "brief": "Start applying this highpass filter to an input signal.",
"related": [],
"name": "process()",
- "description": "Start the filter.",
- "syntax": [".process(input)"],
+ "description": "Start applying this highpass filter to an input signal.",
+ "syntax": [".process(input, freq)"],
"returns": "void",
"type": "method",
- "category": "effects",
+ "category": "Effects",
"subcategory": "HighPass",
"classanchor": "HighPass",
"parameters": [
{
"name": "input",
- "description": "Input audio source",
+ "description": "the sound source to apply the filter to",
"type": ["SoundObject"]
- }
+ },
+ { "name": "freq", "description": "cutoff frequency", "type": ["float"] }
]
}
diff --git a/content/references/translations/en/sound/HighPass_stop_.json b/content/references/translations/en/sound/HighPass_stop_.json
index ee2bf7a8..63ccb53e 100644
--- a/content/references/translations/en/sound/HighPass_stop_.json
+++ b/content/references/translations/en/sound/HighPass_stop_.json
@@ -1,12 +1,12 @@
{
- "brief": "Stops the Filter.",
+ "brief": "Stop the effect.",
"related": [],
"name": "stop()",
- "description": "Stops the Filter.",
+ "description": "Stop the effect.",
"syntax": [".stop()"],
"returns": "void",
"type": "method",
- "category": "effects",
+ "category": "Effects",
"subcategory": "HighPass",
"classanchor": "HighPass",
"parameters": []
diff --git a/content/references/translations/en/sound/LowPass.json b/content/references/translations/en/sound/LowPass.json
index a59754fa..9352a396 100644
--- a/content/references/translations/en/sound/LowPass.json
+++ b/content/references/translations/en/sound/LowPass.json
@@ -5,6 +5,16 @@
"anchor": "LowPass_freq_",
"name": "freq()",
"desc": "Set the cut off frequency for the filter."
+ },
+ {
+ "anchor": "LowPass_process_",
+ "name": "process()",
+ "desc": "Start applying this highpass filter to an input signal."
+ },
+ {
+ "anchor": "LowPass_stop_",
+ "name": "stop()",
+ "desc": "Stop the effect."
}
],
"csspath": "../../",
@@ -12,11 +22,13 @@
"classFields": [],
"description": "This is a low pass filter.",
"type": "class",
- "constructors": ["LowPass(parent)"],
+ "constructors": [
+ "LowPass(parent)"
+ ],
"related": [],
"name": "LowPass",
"classanchor": "sound/LowPass",
- "category": "effects",
- "subcategory": "",
+ "category": "Effects",
+ "subcategory": "LowPass",
"parameters": []
}
diff --git a/content/references/translations/en/sound/LowPass_freq_.json b/content/references/translations/en/sound/LowPass_freq_.json
index 9fd950b4..1607e7c0 100644
--- a/content/references/translations/en/sound/LowPass_freq_.json
+++ b/content/references/translations/en/sound/LowPass_freq_.json
@@ -6,8 +6,8 @@
"syntax": [".freq(freq)"],
"returns": "void",
"type": "method",
- "category": "lowpass",
- "subcategory": "",
+ "category": "Effects",
+ "subcategory": "LowPass",
"classanchor": "LowPass",
"parameters": [
{
diff --git a/content/references/translations/en/sound/LowPass_process_.json b/content/references/translations/en/sound/LowPass_process_.json
new file mode 100644
index 00000000..eea883d6
--- /dev/null
+++ b/content/references/translations/en/sound/LowPass_process_.json
@@ -0,0 +1,20 @@
+{
+ "brief": "Start applying this highpass filter to an input signal.",
+ "related": [],
+ "name": "process()",
+ "description": "Start applying this highpass filter to an input signal.",
+ "syntax": [".process(input, freq)"],
+ "returns": "void",
+ "type": "method",
+ "category": "Effects",
+ "subcategory": "LowPass",
+ "classanchor": "LowPass",
+ "parameters": [
+ {
+ "name": "input",
+ "description": "the sound source to apply the filter to",
+ "type": ["SoundObject"]
+ },
+ { "name": "freq", "description": "cutoff frequency", "type": ["float"] }
+ ]
+}
diff --git a/content/references/translations/en/sound/LowPass_stop_.json b/content/references/translations/en/sound/LowPass_stop_.json
new file mode 100644
index 00000000..e8984403
--- /dev/null
+++ b/content/references/translations/en/sound/LowPass_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": "LowPass",
+ "classanchor": "LowPass",
+ "parameters": []
+}
diff --git a/content/references/translations/en/sound/PinkNoise.json b/content/references/translations/en/sound/PinkNoise.json
index 722d31bf..d036804f 100644
--- a/content/references/translations/en/sound/PinkNoise.json
+++ b/content/references/translations/en/sound/PinkNoise.json
@@ -1,35 +1,30 @@
{
"brief": "This is a pink noise generator.",
"methods": [
- {
- "anchor": "PinkNoise_play_",
- "name": "play()",
- "desc": "Start the generator."
- },
- {
- "anchor": "PinkNoise_set_",
- "name": "set()",
- "desc": "Sets amplitude, add and pan position with one method."
- },
{
"anchor": "PinkNoise_amp_",
"name": "amp()",
"desc": "Change the amplitude/volume of this sound."
},
- {
- "anchor": "PinkNoise_add_",
- "name": "add()",
- "desc": "Offset the output of this generator by a fixed value."
- },
{
"anchor": "PinkNoise_pan_",
"name": "pan()",
- "desc": "Pan the generator in a stereo panorama."
+ "desc": "Move the sound in a stereo panorama."
+ },
+ {
+ "anchor": "PinkNoise_play_",
+ "name": "play()",
+ "desc": "Starts the noise"
+ },
+ {
+ "anchor": "PinkNoise_set_",
+ "name": "set()",
+ "desc": "Set the amplitude and panoramic position with one method."
},
{
"anchor": "PinkNoise_stop_",
"name": "stop()",
- "desc": "Stops the Pink Noise generator."
+ "desc": "Stop the noise from playing back"
}
],
"csspath": "../../",
@@ -37,17 +32,21 @@
"classFields": [],
"description": "This is a pink noise generator. Pink Noise has a decrease of 3dB per octave.",
"type": "class",
- "constructors": ["PinkNoise(parent)"],
+ "constructors": [
+ "PinkNoise(parent)"
+ ],
"related": [],
"name": "PinkNoise",
"classanchor": "sound/PinkNoise",
- "category": "noise",
- "subcategory": "",
+ "category": "Noise",
+ "subcategory": "PinkNoise",
"parameters": [
{
"name": "parent",
"description": "typically use \"this\"",
- "type": ["PApplet"]
+ "type": [
+ "PApplet"
+ ]
}
]
}
diff --git a/content/references/translations/en/sound/PinkNoise_add_.json b/content/references/translations/en/sound/PinkNoise_add_.json
deleted file mode 100644
index e73f2ebb..00000000
--- a/content/references/translations/en/sound/PinkNoise_add_.json
+++ /dev/null
@@ -1,19 +0,0 @@
-{
- "brief": "Offset the output of this generator by a fixed value.",
- "related": [],
- "name": "add()",
- "description": "Offset the output of this generator by a fixed value.",
- "syntax": [".add(add)"],
- "returns": "void",
- "type": "method",
- "category": "pinknoise",
- "subcategory": "",
- "classanchor": "PinkNoise",
- "parameters": [
- {
- "name": "add",
- "description": "offset the output of the generator by the given value",
- "type": ["float"]
- }
- ]
-}
diff --git a/content/references/translations/en/sound/PinkNoise_amp_.json b/content/references/translations/en/sound/PinkNoise_amp_.json
index 31d911d6..c15325cd 100644
--- a/content/references/translations/en/sound/PinkNoise_amp_.json
+++ b/content/references/translations/en/sound/PinkNoise_amp_.json
@@ -6,13 +6,13 @@
"syntax": [".amp(amp)"],
"returns": "void",
"type": "method",
- "category": "pinknoise",
- "subcategory": "",
+ "category": "Noise",
+ "subcategory": "PinkNoise",
"classanchor": "PinkNoise",
"parameters": [
{
"name": "amp",
- "description": "the amplitude of the noise 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"]
}
]
diff --git a/content/references/translations/en/sound/PinkNoise_pan_.json b/content/references/translations/en/sound/PinkNoise_pan_.json
index 880ed1ce..e71b985b 100644
--- a/content/references/translations/en/sound/PinkNoise_pan_.json
+++ b/content/references/translations/en/sound/PinkNoise_pan_.json
@@ -1,18 +1,18 @@
{
- "brief": "Pan the generator in a stereo panorama.",
+ "brief": "Move the sound in a stereo panorama.",
"related": [],
"name": "pan()",
- "description": "Pan the generator 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",
- "category": "pinknoise",
- "subcategory": "",
+ "category": "Noise",
+ "subcategory": "PinkNoise",
"classanchor": "PinkNoise",
"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"]
}
]
diff --git a/content/references/translations/en/sound/PinkNoise_play_.json b/content/references/translations/en/sound/PinkNoise_play_.json
index d5998cc1..dd638653 100644
--- a/content/references/translations/en/sound/PinkNoise_play_.json
+++ b/content/references/translations/en/sound/PinkNoise_play_.json
@@ -1,33 +1,23 @@
{
- "brief": "Start the generator.",
+ "brief": "Starts the noise",
"related": [],
"name": "play()",
- "description": "Start the generator.",
- "syntax": [
- ".play()",
- ".play(amp)",
- ".play(amp, pos)",
- ".play(amp, add, pos)"
- ],
+ "description": "Starts the noise",
+ "syntax": [".play(amp)", ".play(amp, pos)", ".play(amp, add, pos)"],
"returns": "void",
"type": "method",
- "category": "pinknoise",
- "subcategory": "",
+ "category": "Noise",
+ "subcategory": "PinkNoise",
"classanchor": "PinkNoise",
"parameters": [
{
"name": "amp",
- "description": "the amplitude of the noise as a value from 0.0 (complete silence) to 1.0 (full volume)",
- "type": ["float"]
- },
- {
- "name": "add",
- "description": "offset the output of the noise by given value",
+ "description": "The amplitude of the noise as a value between 0.0 and 1.0.",
"type": ["float"]
},
{
"name": "pos",
- "description": "pan the generator in stereo panorama. Allowed values are between -1.0 and 1.0.",
+ "description": "The panoramic position of the noise as a float from -1.0 to 1.0.",
"type": ["float"]
}
]
diff --git a/content/references/translations/en/sound/PinkNoise_set_.json b/content/references/translations/en/sound/PinkNoise_set_.json
index addff01b..0b70c142 100644
--- a/content/references/translations/en/sound/PinkNoise_set_.json
+++ b/content/references/translations/en/sound/PinkNoise_set_.json
@@ -1,28 +1,23 @@
{
- "brief": "Sets amplitude, add and pan position with one method.",
+ "brief": "Set the amplitude and panoramic position with one method.",
"related": [],
"name": "set()",
- "description": "Sets amplitude, add and pan position with one method.",
- "syntax": [".set(amp, add, pos)"],
+ "description": "Set the amplitude and panoramic position with one method.",
+ "syntax": [".set(amp, pos)"],
"returns": "void",
"type": "method",
- "category": "pinknoise",
- "subcategory": "",
+ "category": "Noise",
+ "subcategory": "PinkNoise",
"classanchor": "PinkNoise",
"parameters": [
{
"name": "amp",
- "description": "the amplitude of the noise as a value from 0.0 (complete silence) to 1.0 (full volume)",
- "type": ["float"]
- },
- {
- "name": "add",
- "description": "offset the output of the noise by given value",
+ "description": "The amplitude of the noise as a value between 0.0 and 1.0.",
"type": ["float"]
},
{
"name": "pos",
- "description": "pan the generator in stereo panorama. Allowed values are between -1.0 and 1.0.",
+ "description": "The panoramic position of the noise as a float from -1.0 to 1.0.",
"type": ["float"]
}
]
diff --git a/content/references/translations/en/sound/PinkNoise_stop_.json b/content/references/translations/en/sound/PinkNoise_stop_.json
index 2e0750eb..98eb7cdb 100644
--- a/content/references/translations/en/sound/PinkNoise_stop_.json
+++ b/content/references/translations/en/sound/PinkNoise_stop_.json
@@ -1,13 +1,13 @@
{
- "brief": "Stops the Pink Noise generator.",
+ "brief": "Stop the noise from playing back",
"related": [],
"name": "stop()",
- "description": "Stops the Pink Noise generator.",
+ "description": "Stop the noise from playing back",
"syntax": [".stop()"],
"returns": "void",
"type": "method",
- "category": "pinknoise",
- "subcategory": "",
+ "category": "Noise",
+ "subcategory": "PinkNoise",
"classanchor": "PinkNoise",
"parameters": []
}
diff --git a/content/references/translations/en/sound/Pulse.json b/content/references/translations/en/sound/Pulse.json
index 4a158344..693df327 100644
--- a/content/references/translations/en/sound/Pulse.json
+++ b/content/references/translations/en/sound/Pulse.json
@@ -2,44 +2,39 @@
"brief": "This is a simple Pulse oscillator.",
"methods": [
{
- "anchor": "Pulse_width_",
- "name": "width()",
- "desc": "Changes the pulse width of the pulse oscillator."
- },
- {
- "anchor": "Pulse_set_",
- "name": "set()",
- "desc": "Set multiple parameters at once"
- },
- {
- "anchor": "Pulse_play_",
- "name": "play()",
- "desc": "Starts the oscillator"
+ "anchor": "Pulse_amp_",
+ "name": "amp()",
+ "desc": "Change the amplitude/volume of this sound."
},
{
"anchor": "Pulse_freq_",
"name": "freq()",
- "desc": "Changes the frequency of the pulse oscillator in Hz."
+ "desc": "Set the frequency of the oscillator in Hz."
},
{
- "anchor": "Pulse_amp_",
- "name": "amp()",
- "desc": "Changes the amplitude/volume of the pulse oscillator."
+ "anchor": "Pulse_pan_",
+ "name": "pan()",
+ "desc": "Move the sound in a stereo panorama."
},
{
- "anchor": "Pulse_add_",
- "name": "add()",
- "desc": "Offset the output of this generator by given value."
+ "anchor": "Pulse_play_",
+ "name": "play()",
+ "desc": "Starts the oscillator"
},
{
- "anchor": "Pulse_pan_",
- "name": "pan()",
- "desc": "Pan the oscillator in a stereo panorama."
+ "anchor": "Pulse_set_",
+ "name": "set()",
+ "desc": "Set multiple parameters at once"
},
{
"anchor": "Pulse_stop_",
"name": "stop()",
- "desc": "Stops the Sine Oscillator generator."
+ "desc": "Stop the oscillator from playing back"
+ },
+ {
+ "anchor": "Pulse_width_",
+ "name": "width()",
+ "desc": "Changes the pulse width of the pulse oscillator."
}
],
"csspath": "../../",
@@ -47,17 +42,21 @@
"classFields": [],
"description": "This is a simple Pulse oscillator.",
"type": "class",
- "constructors": ["Pulse(parent)"],
+ "constructors": [
+ "Pulse(parent)"
+ ],
"related": [],
"name": "Pulse",
"classanchor": "sound/Pulse",
- "category": "oscillators",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "Pulse",
"parameters": [
{
"name": "parent",
"description": "typically use \"this\"",
- "type": ["PApplet"]
+ "type": [
+ "PApplet"
+ ]
}
]
}
diff --git a/content/references/translations/en/sound/Pulse_add_.json b/content/references/translations/en/sound/Pulse_add_.json
deleted file mode 100644
index cf8f24c4..00000000
--- a/content/references/translations/en/sound/Pulse_add_.json
+++ /dev/null
@@ -1,19 +0,0 @@
-{
- "brief": "Offset the output of this generator by given value.",
- "related": [],
- "name": "add()",
- "description": "Offset the output of this generator by given value.",
- "syntax": [".add(add)"],
- "returns": "void",
- "type": "method",
- "category": "pulse",
- "subcategory": "",
- "classanchor": "Pulse",
- "parameters": [
- {
- "name": "add",
- "description": "Offset the output of the oscillator by given value",
- "type": ["float"]
- }
- ]
-}
diff --git a/content/references/translations/en/sound/Pulse_amp_.json b/content/references/translations/en/sound/Pulse_amp_.json
index 2784bb4d..0826790a 100644
--- a/content/references/translations/en/sound/Pulse_amp_.json
+++ b/content/references/translations/en/sound/Pulse_amp_.json
@@ -1,13 +1,13 @@
{
- "brief": "Changes the amplitude/volume of the pulse oscillator.",
+ "brief": "Change the amplitude/volume of this sound.",
"related": [],
"name": "amp()",
- "description": "Changes the amplitude/volume of the pulse oscillator. Allowed values are between 0.0 and 1.0.",
+ "description": "Change the amplitude/volume of this sound.",
"syntax": [".amp(amp)"],
"returns": "void",
"type": "method",
- "category": "pulse",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "Pulse",
"classanchor": "Pulse",
"parameters": [
{
diff --git a/content/references/translations/en/sound/Pulse_freq_.json b/content/references/translations/en/sound/Pulse_freq_.json
index ade28f80..aa295258 100644
--- a/content/references/translations/en/sound/Pulse_freq_.json
+++ b/content/references/translations/en/sound/Pulse_freq_.json
@@ -1,13 +1,13 @@
{
- "brief": "Changes the frequency of the pulse oscillator in Hz.",
+ "brief": "Set the frequency of the oscillator in Hz.",
"related": [],
"name": "freq()",
- "description": "Changes the frequency of the pulse oscillator in Hz.",
+ "description": "Set the frequency of the oscillator in Hz.",
"syntax": [".freq(freq)"],
"returns": "void",
"type": "method",
- "category": "pulse",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "Pulse",
"classanchor": "Pulse",
"parameters": [
{
diff --git a/content/references/translations/en/sound/Pulse_pan_.json b/content/references/translations/en/sound/Pulse_pan_.json
index 0aa283ab..35dc8f74 100644
--- a/content/references/translations/en/sound/Pulse_pan_.json
+++ b/content/references/translations/en/sound/Pulse_pan_.json
@@ -1,13 +1,13 @@
{
- "brief": "Pan the oscillator in a stereo panorama.",
+ "brief": "Move the sound in a stereo panorama.",
"related": [],
"name": "pan()",
- "description": "Pan the oscillator 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",
- "category": "pulse",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "Pulse",
"classanchor": "Pulse",
"parameters": [
{
diff --git a/content/references/translations/en/sound/Pulse_play_.json b/content/references/translations/en/sound/Pulse_play_.json
index a573e5fc..46078b5e 100644
--- a/content/references/translations/en/sound/Pulse_play_.json
+++ b/content/references/translations/en/sound/Pulse_play_.json
@@ -2,7 +2,7 @@
"brief": "Starts the oscillator",
"related": [],
"name": "play()",
- "description": "Starts the oscillator.",
+ "description": "Starts the oscillator",
"syntax": [
".play()",
".play(freq, amp)",
@@ -11,8 +11,8 @@
],
"returns": "void",
"type": "method",
- "category": "pulse",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "Pulse",
"classanchor": "Pulse",
"parameters": [
{
@@ -25,11 +25,6 @@
"description": "The amplitude of the oscillator as a value between 0.0 and 1.0.",
"type": ["float"]
},
- {
- "name": "add",
- "description": "Offset the output of the oscillator by given value",
- "type": ["float"]
- },
{
"name": "pos",
"description": "The panoramic position of the oscillator as a float from -1.0 to 1.0.",
diff --git a/content/references/translations/en/sound/Pulse_set_.json b/content/references/translations/en/sound/Pulse_set_.json
index d7adec3b..5eb4d69b 100644
--- a/content/references/translations/en/sound/Pulse_set_.json
+++ b/content/references/translations/en/sound/Pulse_set_.json
@@ -3,11 +3,11 @@
"related": [],
"name": "set()",
"description": "Set multiple parameters at once",
- "syntax": [".set(freq, width, amp, add, pos)", ".set(freq, amp, add, pos)"],
+ "syntax": [".set(freq, width, amp, add, pos)"],
"returns": "void",
"type": "method",
- "category": "pulse",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "Pulse",
"classanchor": "Pulse",
"parameters": [
{
diff --git a/content/references/translations/en/sound/Pulse_stop_.json b/content/references/translations/en/sound/Pulse_stop_.json
index d107fc7b..8599c060 100644
--- a/content/references/translations/en/sound/Pulse_stop_.json
+++ b/content/references/translations/en/sound/Pulse_stop_.json
@@ -1,13 +1,13 @@
{
- "brief": "Stops the Sine Oscillator generator.",
+ "brief": "Stop the oscillator from playing back",
"related": [],
"name": "stop()",
- "description": "Stops the Sine Oscillator generator.",
+ "description": "Stop the oscillator from playing back",
"syntax": [".stop()"],
"returns": "void",
"type": "method",
- "category": "pulse",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "Pulse",
"classanchor": "Pulse",
"parameters": []
}
diff --git a/content/references/translations/en/sound/Pulse_width_.json b/content/references/translations/en/sound/Pulse_width_.json
index 15147603..09e173b9 100644
--- a/content/references/translations/en/sound/Pulse_width_.json
+++ b/content/references/translations/en/sound/Pulse_width_.json
@@ -6,8 +6,8 @@
"syntax": [".width(width)"],
"returns": "void",
"type": "method",
- "category": "pulse",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "Pulse",
"classanchor": "Pulse",
"parameters": [
{
diff --git a/content/references/translations/en/sound/Reverb.json b/content/references/translations/en/sound/Reverb.json
index 78112b15..5dc08b27 100644
--- a/content/references/translations/en/sound/Reverb.json
+++ b/content/references/translations/en/sound/Reverb.json
@@ -6,6 +6,11 @@
"name": "damp()",
"desc": "Changes the damping factor of the reverb effect."
},
+ {
+ "anchor": "Reverb_process_",
+ "name": "process()",
+ "desc": "Start the effect."
+ },
{
"anchor": "Reverb_room_",
"name": "room()",
@@ -16,6 +21,11 @@
"name": "set()",
"desc": "Set multiple parameters of the reverb."
},
+ {
+ "anchor": "Reverb_stop_",
+ "name": "stop()",
+ "desc": "Stop the effect."
+ },
{
"anchor": "Reverb_wet_",
"name": "wet()",
@@ -27,11 +37,13 @@
"classFields": [],
"description": "This is a simple reverb effect.",
"type": "class",
- "constructors": ["Reverb(parent)"],
+ "constructors": [
+ "Reverb(parent)"
+ ],
"related": [],
"name": "Reverb",
"classanchor": "sound/Reverb",
- "category": "effects",
- "subcategory": "",
+ "category": "Effects",
+ "subcategory": "Reverb",
"parameters": []
}
diff --git a/content/references/translations/en/sound/Reverb_damp_.json b/content/references/translations/en/sound/Reverb_damp_.json
index 41d83a9e..ce3b255d 100644
--- a/content/references/translations/en/sound/Reverb_damp_.json
+++ b/content/references/translations/en/sound/Reverb_damp_.json
@@ -6,8 +6,8 @@
"syntax": [".damp(damp)"],
"returns": "void",
"type": "method",
- "category": "reverb",
- "subcategory": "",
+ "category": "Effects",
+ "subcategory": "Reverb",
"classanchor": "Reverb",
"parameters": [
{
diff --git a/content/references/translations/en/sound/Reverb_process_.json b/content/references/translations/en/sound/Reverb_process_.json
index c781a139..bf657ba1 100644
--- a/content/references/translations/en/sound/Reverb_process_.json
+++ b/content/references/translations/en/sound/Reverb_process_.json
@@ -1,18 +1,18 @@
{
- "brief": "Start the filter.",
+ "brief": "Start the effect.",
"related": [],
"name": "process()",
- "description": "Start the filter.",
+ "description": "Start the effect.",
"syntax": [".process(input)"],
"returns": "void",
"type": "method",
- "category": "effects",
+ "category": "Effects",
"subcategory": "Reverb",
"classanchor": "Reverb",
"parameters": [
{
"name": "input",
- "description": "Input audio source",
+ "description": "Input sound source",
"type": ["SoundObject"]
}
]
diff --git a/content/references/translations/en/sound/Reverb_room_.json b/content/references/translations/en/sound/Reverb_room_.json
index 81220e9c..e3ab789f 100644
--- a/content/references/translations/en/sound/Reverb_room_.json
+++ b/content/references/translations/en/sound/Reverb_room_.json
@@ -6,8 +6,8 @@
"syntax": [".room(room)"],
"returns": "void",
"type": "method",
- "category": "reverb",
- "subcategory": "",
+ "category": "Effects",
+ "subcategory": "Reverb",
"classanchor": "Reverb",
"parameters": [
{
diff --git a/content/references/translations/en/sound/Reverb_set_.json b/content/references/translations/en/sound/Reverb_set_.json
index 8e96670e..9be3ad44 100644
--- a/content/references/translations/en/sound/Reverb_set_.json
+++ b/content/references/translations/en/sound/Reverb_set_.json
@@ -6,8 +6,8 @@
"syntax": [".set(room, damp, wet)"],
"returns": "void",
"type": "method",
- "category": "reverb",
- "subcategory": "",
+ "category": "Effects",
+ "subcategory": "Reverb",
"classanchor": "Reverb",
"parameters": [
{
diff --git a/content/references/translations/en/sound/Reverb_stop_.json b/content/references/translations/en/sound/Reverb_stop_.json
index a04071ba..de5899d9 100644
--- a/content/references/translations/en/sound/Reverb_stop_.json
+++ b/content/references/translations/en/sound/Reverb_stop_.json
@@ -1,12 +1,12 @@
{
- "brief": "Stops the reverb.",
+ "brief": "Stop the effect.",
"related": [],
"name": "stop()",
- "description": "Stops the reverb.",
+ "description": "Stop the effect.",
"syntax": [".stop()"],
"returns": "void",
"type": "method",
- "category": "effects",
+ "category": "Effects",
"subcategory": "Reverb",
"classanchor": "Reverb",
"parameters": []
diff --git a/content/references/translations/en/sound/Reverb_wet_.json b/content/references/translations/en/sound/Reverb_wet_.json
index 5b84a900..d077ea8a 100644
--- a/content/references/translations/en/sound/Reverb_wet_.json
+++ b/content/references/translations/en/sound/Reverb_wet_.json
@@ -6,8 +6,8 @@
"syntax": [".wet(wet)"],
"returns": "void",
"type": "method",
- "category": "reverb",
- "subcategory": "",
+ "category": "Effects",
+ "subcategory": "Reverb",
"classanchor": "Reverb",
"parameters": [
{
diff --git a/content/references/translations/en/sound/SawOsc.json b/content/references/translations/en/sound/SawOsc.json
index 87761192..58a053f8 100644
--- a/content/references/translations/en/sound/SawOsc.json
+++ b/content/references/translations/en/sound/SawOsc.json
@@ -2,14 +2,9 @@
"brief": "This is a simple Saw Wave Oscillator.",
"methods": [
{
- "anchor": "SawOsc_play_",
- "name": "play()",
- "desc": "Starts the oscillator."
- },
- {
- "anchor": "SawOsc_set_",
- "name": "set()",
- "desc": "Set multiple parameters at once."
+ "anchor": "SawOsc_amp_",
+ "name": "amp()",
+ "desc": "Change the amplitude/volume of this sound."
},
{
"anchor": "SawOsc_freq_",
@@ -17,24 +12,24 @@
"desc": "Set the frequency of the oscillator in Hz."
},
{
- "anchor": "SawOsc_amp_",
- "name": "amp()",
- "desc": "Changes the amplitude/volume of the saw oscillator."
+ "anchor": "SawOsc_pan_",
+ "name": "pan()",
+ "desc": "Move the sound in a stereo panorama."
},
{
- "anchor": "SawOsc_add_",
- "name": "add()",
- "desc": "Offset the output of this generator by given value."
+ "anchor": "SawOsc_play_",
+ "name": "play()",
+ "desc": "Starts the oscillator"
},
{
- "anchor": "SawOsc_pan_",
- "name": "pan()",
- "desc": "Move the sound in a stereo panorama."
+ "anchor": "SawOsc_set_",
+ "name": "set()",
+ "desc": "Set multiple parameters at once"
},
{
"anchor": "SawOsc_stop_",
"name": "stop()",
- "desc": "Move the sound in a stereo panorama."
+ "desc": "Stop the oscillator from playing back"
}
],
"csspath": "../../",
@@ -42,17 +37,21 @@
"classFields": [],
"description": "This is a simple Saw Wave Oscillator.",
"type": "class",
- "constructors": ["SawOsc(parent)"],
+ "constructors": [
+ "SawOsc(parent)"
+ ],
"related": [],
"name": "SawOsc",
"classanchor": "sound/SawOsc",
- "category": "oscillators",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "SawOsc",
"parameters": [
{
"name": "parent",
"description": "typically use \"this\"",
- "type": ["PApplet"]
+ "type": [
+ "PApplet"
+ ]
}
]
}
diff --git a/content/references/translations/en/sound/SawOsc_add_.json b/content/references/translations/en/sound/SawOsc_add_.json
deleted file mode 100644
index 51bcf479..00000000
--- a/content/references/translations/en/sound/SawOsc_add_.json
+++ /dev/null
@@ -1,19 +0,0 @@
-{
- "brief": "Offset the output of this generator by given value.",
- "related": [],
- "name": "add()",
- "description": "Offset the output of this generator by given value.",
- "syntax": [".add(add)"],
- "returns": "void",
- "type": "method",
- "category": "sawosc",
- "subcategory": "",
- "classanchor": "SawOsc",
- "parameters": [
- {
- "name": "add",
- "description": "Offset the output of the oscillator by given value",
- "type": ["float"]
- }
- ]
-}
diff --git a/content/references/translations/en/sound/SawOsc_amp_.json b/content/references/translations/en/sound/SawOsc_amp_.json
index 4f83e692..e1555f40 100644
--- a/content/references/translations/en/sound/SawOsc_amp_.json
+++ b/content/references/translations/en/sound/SawOsc_amp_.json
@@ -1,13 +1,13 @@
{
- "brief": "Changes the amplitude/volume of the saw oscillator.",
+ "brief": "Change the amplitude/volume of this sound.",
"related": [],
"name": "amp()",
- "description": "Changes the amplitude/volume of the saw oscillator. Allowed values are between 0.0 and 1.0.",
+ "description": "Change the amplitude/volume of this sound.",
"syntax": [".amp(amp)"],
"returns": "void",
"type": "method",
- "category": "sawosc",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "SawOsc",
"classanchor": "SawOsc",
"parameters": [
{
diff --git a/content/references/translations/en/sound/SawOsc_freq_.json b/content/references/translations/en/sound/SawOsc_freq_.json
index f06dc457..6c90ef5d 100644
--- a/content/references/translations/en/sound/SawOsc_freq_.json
+++ b/content/references/translations/en/sound/SawOsc_freq_.json
@@ -6,8 +6,8 @@
"syntax": [".freq(freq)"],
"returns": "void",
"type": "method",
- "category": "sawosc",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "SawOsc",
"classanchor": "SawOsc",
"parameters": [
{
diff --git a/content/references/translations/en/sound/SawOsc_pan_.json b/content/references/translations/en/sound/SawOsc_pan_.json
index f28a648b..0f7582ad 100644
--- a/content/references/translations/en/sound/SawOsc_pan_.json
+++ b/content/references/translations/en/sound/SawOsc_pan_.json
@@ -6,13 +6,13 @@
"syntax": [".pan(pos)"],
"returns": "void",
"type": "method",
- "category": "sawosc",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "SawOsc",
"classanchor": "SawOsc",
"parameters": [
{
"name": "pos",
- "description": "Move the sound in a stereo panorama.\n The panoramic position of this sound unit as a float from -1.0\n (left) to 1.0 (right).",
+ "description": "The panoramic position of this sound unit as a float from -1.0\n (left) to 1.0 (right).",
"type": ["float"]
}
]
diff --git a/content/references/translations/en/sound/SawOsc_play_.json b/content/references/translations/en/sound/SawOsc_play_.json
index 3c4f3a2a..973af5aa 100644
--- a/content/references/translations/en/sound/SawOsc_play_.json
+++ b/content/references/translations/en/sound/SawOsc_play_.json
@@ -1,8 +1,8 @@
{
- "brief": "Starts the oscillator.",
+ "brief": "Starts the oscillator",
"related": [],
"name": "play()",
- "description": "Starts the oscillator.",
+ "description": "Starts the oscillator",
"syntax": [
".play()",
".play(freq, amp)",
@@ -11,8 +11,8 @@
],
"returns": "void",
"type": "method",
- "category": "sawosc",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "SawOsc",
"classanchor": "SawOsc",
"parameters": [
{
@@ -25,11 +25,6 @@
"description": "The amplitude of the oscillator as a value between 0.0 and 1.0.",
"type": ["float"]
},
- {
- "name": "add",
- "description": "Offset the output of the oscillator by given value",
- "type": ["float"]
- },
{
"name": "pos",
"description": "The panoramic position of the oscillator as a float from -1.0 to 1.0.",
diff --git a/content/references/translations/en/sound/SawOsc_set_.json b/content/references/translations/en/sound/SawOsc_set_.json
index 401150b5..cb7fb698 100644
--- a/content/references/translations/en/sound/SawOsc_set_.json
+++ b/content/references/translations/en/sound/SawOsc_set_.json
@@ -1,13 +1,13 @@
{
- "brief": "Set multiple parameters at once.",
+ "brief": "Set multiple parameters at once",
"related": [],
"name": "set()",
- "description": "Set multiple parameters at once.",
- "syntax": [".set(freq, amp, add, pos)"],
+ "description": "Set multiple parameters at once",
+ "syntax": [".set(freq, amp, pos)"],
"returns": "void",
"type": "method",
- "category": "sawosc",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "SawOsc",
"classanchor": "SawOsc",
"parameters": [
{
@@ -20,11 +20,6 @@
"description": "The amplitude of the oscillator as a value between 0.0 and 1.0.",
"type": ["float"]
},
- {
- "name": "add",
- "description": "Offset the output of the oscillator by given value",
- "type": ["float"]
- },
{
"name": "pos",
"description": "The panoramic position of the oscillator as a float from -1.0 to 1.0.",
diff --git a/content/references/translations/en/sound/SawOsc_stop_.json b/content/references/translations/en/sound/SawOsc_stop_.json
index e4084af9..39114a39 100644
--- a/content/references/translations/en/sound/SawOsc_stop_.json
+++ b/content/references/translations/en/sound/SawOsc_stop_.json
@@ -1,13 +1,13 @@
{
- "brief": "Move the sound in a stereo panorama.",
+ "brief": "Stop the oscillator from playing back",
"related": [],
"name": "stop()",
- "description": "Stop the oscillator.",
+ "description": "Stop the oscillator from playing back",
"syntax": [".stop()"],
"returns": "void",
"type": "method",
- "category": "sawosc",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "SawOsc",
"classanchor": "SawOsc",
"parameters": []
}
diff --git a/content/references/translations/en/sound/SinOsc.json b/content/references/translations/en/sound/SinOsc.json
index b697a54b..20c0ad67 100644
--- a/content/references/translations/en/sound/SinOsc.json
+++ b/content/references/translations/en/sound/SinOsc.json
@@ -2,14 +2,9 @@
"brief": "This is a simple Sine Wave Oscillator.",
"methods": [
{
- "anchor": "SinOsc_play_",
- "name": "play()",
- "desc": "Starts the oscillator."
- },
- {
- "anchor": "SinOsc_set_",
- "name": "set()",
- "desc": "Set multiple parameters at once."
+ "anchor": "SinOsc_amp_",
+ "name": "amp()",
+ "desc": "Change the amplitude/volume of this sound."
},
{
"anchor": "SinOsc_freq_",
@@ -17,24 +12,24 @@
"desc": "Set the frequency of the oscillator in Hz."
},
{
- "anchor": "SinOsc_amp_",
- "name": "amp()",
- "desc": "Changes the amplitude/volume of the sine oscillator."
+ "anchor": "SinOsc_pan_",
+ "name": "pan()",
+ "desc": "Move the sound in a stereo panorama."
},
{
- "anchor": "SinOsc_add_",
- "name": "add()",
- "desc": "Offset the output of this generator by given value."
+ "anchor": "SinOsc_play_",
+ "name": "play()",
+ "desc": "Starts the oscillator"
},
{
- "anchor": "SinOsc_pan_",
- "name": "pan()",
- "desc": "Pan the oscillator in a stereo panorama."
+ "anchor": "SinOsc_set_",
+ "name": "set()",
+ "desc": "Set multiple parameters at once"
},
{
"anchor": "SinOsc_stop_",
"name": "stop()",
- "desc": "Stops the oscillator."
+ "desc": "Stop the oscillator from playing back"
}
],
"csspath": "../../",
@@ -42,17 +37,21 @@
"classFields": [],
"description": "This is a simple Sine Wave Oscillator.",
"type": "class",
- "constructors": ["SinOsc(parent)"],
+ "constructors": [
+ "SinOsc(parent)"
+ ],
"related": [],
"name": "SinOsc",
"classanchor": "sound/SinOsc",
- "category": "oscillators",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "SinOsc",
"parameters": [
{
"name": "parent",
"description": "typically use \"this\"",
- "type": ["PApplet"]
+ "type": [
+ "PApplet"
+ ]
}
]
}
diff --git a/content/references/translations/en/sound/SinOsc_add_.json b/content/references/translations/en/sound/SinOsc_add_.json
deleted file mode 100644
index e6a3f00a..00000000
--- a/content/references/translations/en/sound/SinOsc_add_.json
+++ /dev/null
@@ -1,19 +0,0 @@
-{
- "brief": "Offset the output of this generator by given value.",
- "related": [],
- "name": "add()",
- "description": "Offset the output of this generator by given value.",
- "syntax": [".add(add)"],
- "returns": "void",
- "type": "method",
- "category": "sinosc",
- "subcategory": "",
- "classanchor": "SinOsc",
- "parameters": [
- {
- "name": "add",
- "description": "Offset the output of the oscillator by given value",
- "type": ["float"]
- }
- ]
-}
diff --git a/content/references/translations/en/sound/SinOsc_amp_.json b/content/references/translations/en/sound/SinOsc_amp_.json
index bcef5485..ff3cc805 100644
--- a/content/references/translations/en/sound/SinOsc_amp_.json
+++ b/content/references/translations/en/sound/SinOsc_amp_.json
@@ -1,13 +1,13 @@
{
- "brief": "Changes the amplitude/volume of the sine oscillator.",
+ "brief": "Change the amplitude/volume of this sound.",
"related": [],
"name": "amp()",
- "description": "Changes the amplitude/volume of the sine oscillator. Allowed values are between 0.0 and 1.0.",
+ "description": "Change the amplitude/volume of this sound.",
"syntax": [".amp(amp)"],
"returns": "void",
"type": "method",
- "category": "sinosc",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "SinOsc",
"classanchor": "SinOsc",
"parameters": [
{
diff --git a/content/references/translations/en/sound/SinOsc_freq_.json b/content/references/translations/en/sound/SinOsc_freq_.json
index 83e4829e..ef45095f 100644
--- a/content/references/translations/en/sound/SinOsc_freq_.json
+++ b/content/references/translations/en/sound/SinOsc_freq_.json
@@ -6,8 +6,8 @@
"syntax": [".freq(freq)"],
"returns": "void",
"type": "method",
- "category": "sinosc",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "SinOsc",
"classanchor": "SinOsc",
"parameters": [
{
diff --git a/content/references/translations/en/sound/SinOsc_pan_.json b/content/references/translations/en/sound/SinOsc_pan_.json
index ae4372dc..47611e40 100644
--- a/content/references/translations/en/sound/SinOsc_pan_.json
+++ b/content/references/translations/en/sound/SinOsc_pan_.json
@@ -1,18 +1,18 @@
{
- "brief": "Pan the oscillator in a stereo panorama.",
+ "brief": "Move the sound in a stereo panorama.",
"related": [],
"name": "pan()",
- "description": "Pan the oscillator 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",
- "category": "sinosc",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "SinOsc",
"classanchor": "SinOsc",
"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"]
}
]
diff --git a/content/references/translations/en/sound/SinOsc_play_.json b/content/references/translations/en/sound/SinOsc_play_.json
index bc069e71..1167a180 100644
--- a/content/references/translations/en/sound/SinOsc_play_.json
+++ b/content/references/translations/en/sound/SinOsc_play_.json
@@ -1,8 +1,8 @@
{
- "brief": "Starts the oscillator.",
+ "brief": "Starts the oscillator",
"related": [],
"name": "play()",
- "description": "Starts the oscillator.",
+ "description": "Starts the oscillator",
"syntax": [
".play()",
".play(freq, amp)",
@@ -11,8 +11,8 @@
],
"returns": "void",
"type": "method",
- "category": "sinosc",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "SinOsc",
"classanchor": "SinOsc",
"parameters": [
{
@@ -25,14 +25,9 @@
"description": "The amplitude of the oscillator as a value between 0.0 and 1.0.",
"type": ["float"]
},
- {
- "name": "add",
- "description": "Offset the output of the oscillator by given value",
- "type": ["float"]
- },
{
"name": "pos",
- "description": "The panoramic position of the oscillator as a float from -1.0 to\n 1.0.",
+ "description": "The panoramic position of the oscillator as a float from -1.0 to 1.0.",
"type": ["float"]
}
]
diff --git a/content/references/translations/en/sound/SinOsc_set_.json b/content/references/translations/en/sound/SinOsc_set_.json
index bca2e99e..750322ee 100644
--- a/content/references/translations/en/sound/SinOsc_set_.json
+++ b/content/references/translations/en/sound/SinOsc_set_.json
@@ -1,13 +1,13 @@
{
- "brief": "Set multiple parameters at once.",
+ "brief": "Set multiple parameters at once",
"related": [],
"name": "set()",
- "description": "Set multiple parameters at once.",
- "syntax": [".set(freq, amp, add, pos)"],
+ "description": "Set multiple parameters at once",
+ "syntax": [".set(freq, amp, pos)"],
"returns": "void",
"type": "method",
- "category": "sinosc",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "SinOsc",
"classanchor": "SinOsc",
"parameters": [
{
@@ -20,14 +20,9 @@
"description": "The amplitude of the oscillator as a value between 0.0 and 1.0.",
"type": ["float"]
},
- {
- "name": "add",
- "description": "Offset the output of the oscillator by given value",
- "type": ["float"]
- },
{
"name": "pos",
- "description": "The panoramic position of the oscillator as a float from -1.0 to\n 1.0.",
+ "description": "The panoramic position of the oscillator as a float from -1.0 to 1.0.",
"type": ["float"]
}
]
diff --git a/content/references/translations/en/sound/SinOsc_stop_.json b/content/references/translations/en/sound/SinOsc_stop_.json
index e9640bcc..3eece936 100644
--- a/content/references/translations/en/sound/SinOsc_stop_.json
+++ b/content/references/translations/en/sound/SinOsc_stop_.json
@@ -1,13 +1,13 @@
{
- "brief": "Stops the oscillator.",
+ "brief": "Stop the oscillator from playing back",
"related": [],
"name": "stop()",
- "description": "Stop the oscillator.",
+ "description": "Stop the oscillator from playing back",
"syntax": [".stop()"],
"returns": "void",
"type": "method",
- "category": "sinosc",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "SinOsc",
"classanchor": "SinOsc",
"parameters": []
}
diff --git a/content/references/translations/en/sound/Sound.json b/content/references/translations/en/sound/Sound.json
index f4f7c7ff..52cfdd41 100644
--- a/content/references/translations/en/sound/Sound.json
+++ b/content/references/translations/en/sound/Sound.json
@@ -39,8 +39,8 @@
"related": [],
"name": "Sound",
"classanchor": "sound/Sound",
- "category": "configuration",
- "subcategory": "",
+ "category": "Configuration",
+ "subcategory": "Sound",
"parameters": [
{
"name": "parent",
diff --git a/content/references/translations/en/sound/SoundFile.json b/content/references/translations/en/sound/SoundFile.json
index 4c9e12a9..2f7e22bd 100644
--- a/content/references/translations/en/sound/SoundFile.json
+++ b/content/references/translations/en/sound/SoundFile.json
@@ -65,11 +65,6 @@
"anchor": "SoundFile_rate_",
"name": "rate()",
"desc": "Set the playback rate of the soundfile."
- },
- {
- "anchor": "SoundFile_stop_",
- "name": "stop()",
- "desc": "Stops the playback."
}
],
"csspath": "../../",
@@ -81,8 +76,8 @@
"related": [],
"name": "SoundFile",
"classanchor": "sound/SoundFile",
- "category": "sampling",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "SoundFile",
"parameters": [
{
"name": "parent",
diff --git a/content/references/translations/en/sound/SoundFile_add_.json b/content/references/translations/en/sound/SoundFile_add_.json
deleted file mode 100644
index 00915f93..00000000
--- a/content/references/translations/en/sound/SoundFile_add_.json
+++ /dev/null
@@ -1,19 +0,0 @@
-{
- "brief": "Offset the output of the player by the given value.",
- "related": [],
- "name": "add()",
- "description": "Offset the output of the player by the given value.",
- "syntax": [".add(add)"],
- "returns": "void",
- "type": "method",
- "category": "sampling",
- "subcategory": "SoundFile",
- "classanchor": "SoundFile",
- "parameters": [
- {
- "name": "add",
- "description": "offset the output of the player by the given value",
- "type": ["float"]
- }
- ]
-}
diff --git a/content/references/translations/en/sound/SoundFile_amp_.json b/content/references/translations/en/sound/SoundFile_amp_.json
index 2145e739..e707ee48 100644
--- a/content/references/translations/en/sound/SoundFile_amp_.json
+++ b/content/references/translations/en/sound/SoundFile_amp_.json
@@ -6,8 +6,8 @@
"syntax": [".amp(amp)"],
"returns": "void",
"type": "method",
- "category": "soundfile",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "SoundFile",
"classanchor": "SoundFile",
"parameters": [
{
diff --git a/content/references/translations/en/sound/SoundFile_channels_.json b/content/references/translations/en/sound/SoundFile_channels_.json
index af91ddc7..17be84cf 100644
--- a/content/references/translations/en/sound/SoundFile_channels_.json
+++ b/content/references/translations/en/sound/SoundFile_channels_.json
@@ -6,8 +6,8 @@
"syntax": [".channels()"],
"returns": "int",
"type": "method",
- "category": "soundfile",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "SoundFile",
"classanchor": "SoundFile",
"parameters": []
}
diff --git a/content/references/translations/en/sound/SoundFile_cue_.json b/content/references/translations/en/sound/SoundFile_cue_.json
index d2bcc4fa..ca0b5ffe 100644
--- a/content/references/translations/en/sound/SoundFile_cue_.json
+++ b/content/references/translations/en/sound/SoundFile_cue_.json
@@ -6,8 +6,8 @@
"syntax": [".cue(time)"],
"returns": "void",
"type": "method",
- "category": "soundfile",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "SoundFile",
"classanchor": "SoundFile",
"parameters": [
{
diff --git a/content/references/translations/en/sound/SoundFile_duration_.json b/content/references/translations/en/sound/SoundFile_duration_.json
index 60501b0e..7549f22d 100644
--- a/content/references/translations/en/sound/SoundFile_duration_.json
+++ b/content/references/translations/en/sound/SoundFile_duration_.json
@@ -6,8 +6,8 @@
"syntax": [".duration()"],
"returns": "float",
"type": "method",
- "category": "soundfile",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "SoundFile",
"classanchor": "SoundFile",
"parameters": []
}
diff --git a/content/references/translations/en/sound/SoundFile_frames_.json b/content/references/translations/en/sound/SoundFile_frames_.json
index f6e13d78..4a6c6db6 100644
--- a/content/references/translations/en/sound/SoundFile_frames_.json
+++ b/content/references/translations/en/sound/SoundFile_frames_.json
@@ -6,8 +6,8 @@
"syntax": [".frames()"],
"returns": "int",
"type": "method",
- "category": "soundfile",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "SoundFile",
"classanchor": "SoundFile",
"parameters": []
}
diff --git a/content/references/translations/en/sound/SoundFile_isPlaying_.json b/content/references/translations/en/sound/SoundFile_isPlaying_.json
index a9decbd8..baa98e72 100644
--- a/content/references/translations/en/sound/SoundFile_isPlaying_.json
+++ b/content/references/translations/en/sound/SoundFile_isPlaying_.json
@@ -6,8 +6,8 @@
"syntax": [".isPlaying()"],
"returns": "boolean",
"type": "method",
- "category": "soundfile",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "SoundFile",
"classanchor": "SoundFile",
"parameters": []
}
diff --git a/content/references/translations/en/sound/SoundFile_jump_.json b/content/references/translations/en/sound/SoundFile_jump_.json
index 3cb241ba..35cc8073 100644
--- a/content/references/translations/en/sound/SoundFile_jump_.json
+++ b/content/references/translations/en/sound/SoundFile_jump_.json
@@ -6,8 +6,8 @@
"syntax": [".jump(time)"],
"returns": "void",
"type": "method",
- "category": "soundfile",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "SoundFile",
"classanchor": "SoundFile",
"parameters": [
{
diff --git a/content/references/translations/en/sound/SoundFile_loop_.json b/content/references/translations/en/sound/SoundFile_loop_.json
index d9531214..9d71759b 100644
--- a/content/references/translations/en/sound/SoundFile_loop_.json
+++ b/content/references/translations/en/sound/SoundFile_loop_.json
@@ -12,8 +12,8 @@
],
"returns": "void",
"type": "method",
- "category": "soundfile",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "SoundFile",
"classanchor": "SoundFile",
"parameters": [
{
diff --git a/content/references/translations/en/sound/SoundFile_pan_.json b/content/references/translations/en/sound/SoundFile_pan_.json
index e915135a..01f2d8c3 100644
--- a/content/references/translations/en/sound/SoundFile_pan_.json
+++ b/content/references/translations/en/sound/SoundFile_pan_.json
@@ -6,8 +6,8 @@
"syntax": [".pan(pos)"],
"returns": "void",
"type": "method",
- "category": "soundfile",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "SoundFile",
"classanchor": "SoundFile",
"parameters": [
{
diff --git a/content/references/translations/en/sound/SoundFile_pause_.json b/content/references/translations/en/sound/SoundFile_pause_.json
index ef21b653..b4041dc8 100644
--- a/content/references/translations/en/sound/SoundFile_pause_.json
+++ b/content/references/translations/en/sound/SoundFile_pause_.json
@@ -6,8 +6,8 @@
"syntax": [".pause()"],
"returns": "void",
"type": "method",
- "category": "soundfile",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "SoundFile",
"classanchor": "SoundFile",
"parameters": []
}
diff --git a/content/references/translations/en/sound/SoundFile_play_.json b/content/references/translations/en/sound/SoundFile_play_.json
index 5bd5b0df..da72c14a 100644
--- a/content/references/translations/en/sound/SoundFile_play_.json
+++ b/content/references/translations/en/sound/SoundFile_play_.json
@@ -13,8 +13,8 @@
],
"returns": "void",
"type": "method",
- "category": "soundfile",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "SoundFile",
"classanchor": "SoundFile",
"parameters": [
{
diff --git a/content/references/translations/en/sound/SoundFile_rate_.json b/content/references/translations/en/sound/SoundFile_rate_.json
index 8bbedeab..cf5aefad 100644
--- a/content/references/translations/en/sound/SoundFile_rate_.json
+++ b/content/references/translations/en/sound/SoundFile_rate_.json
@@ -6,8 +6,8 @@
"syntax": [".rate(rate)"],
"returns": "void",
"type": "method",
- "category": "soundfile",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "SoundFile",
"classanchor": "SoundFile",
"parameters": [
{
diff --git a/content/references/translations/en/sound/SoundFile_removeFromCache_.json b/content/references/translations/en/sound/SoundFile_removeFromCache_.json
index 63bc27cf..20db19d7 100644
--- a/content/references/translations/en/sound/SoundFile_removeFromCache_.json
+++ b/content/references/translations/en/sound/SoundFile_removeFromCache_.json
@@ -6,8 +6,8 @@
"syntax": [".removeFromCache()"],
"returns": "boolean",
"type": "method",
- "category": "soundfile",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "SoundFile",
"classanchor": "SoundFile",
"parameters": []
}
diff --git a/content/references/translations/en/sound/SoundFile_set_.json b/content/references/translations/en/sound/SoundFile_set_.json
deleted file mode 100644
index 0ad035fe..00000000
--- a/content/references/translations/en/sound/SoundFile_set_.json
+++ /dev/null
@@ -1,34 +0,0 @@
-{
- "brief": "Set multiple playback parameters of the soundfile at once.",
- "related": [],
- "name": "set()",
- "description": "Set multiple playback parameters of the soundfile at once.",
- "syntax": [".set(rate, pos, amp, add)"],
- "returns": "void",
- "type": "method",
- "category": "sampling",
- "subcategory": "SoundFile",
- "classanchor": "SoundFile",
- "parameters": [
- {
- "name": "rate",
- "description": "relative playback rate to use. 1 is the original speed. 0.5 is half speed and one octave down. 2 is double the speed and one octave up.",
- "type": ["float"]
- },
- {
- "name": "pos",
- "description": "the panoramic position of this sound unit from -1.0 (left) to 1.0 (right).",
- "type": ["float"]
- },
- {
- "name": "amp",
- "description": "the desired playback amplitude of the audiosample as a value from 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"]
- }
- ]
-}
diff --git a/content/references/translations/en/sound/SoundFile_stop_.json b/content/references/translations/en/sound/SoundFile_stop_.json
index 3a2d682e..04e44729 100644
--- a/content/references/translations/en/sound/SoundFile_stop_.json
+++ b/content/references/translations/en/sound/SoundFile_stop_.json
@@ -1,13 +1,13 @@
{
- "brief": "Stops the playback.",
+ "brief": "Stops the playback, and sets the cue back to the start of the sample.",
"related": [],
"name": "stop()",
- "description": "Stops the playback.",
+ "description": "Stops the playback, and sets the cue back to the start of the sample.",
"syntax": [".stop()"],
"returns": "void",
"type": "method",
- "category": "soundfile",
- "subcategory": "",
+ "category": "Sampling",
+ "subcategory": "SoundFile",
"classanchor": "SoundFile",
"parameters": []
}
diff --git a/content/references/translations/en/sound/Sound_inputDevice_.json b/content/references/translations/en/sound/Sound_inputDevice_.json
index 8acf49ff..1645bf2f 100644
--- a/content/references/translations/en/sound/Sound_inputDevice_.json
+++ b/content/references/translations/en/sound/Sound_inputDevice_.json
@@ -6,8 +6,8 @@
"syntax": [".inputDevice(deviceId)"],
"returns": "void",
"type": "method",
- "category": "sound",
- "subcategory": "",
+ "category": "Configuration",
+ "subcategory": "Sound",
"classanchor": "Sound",
"parameters": [
{
diff --git a/content/references/translations/en/sound/Sound_list_.json b/content/references/translations/en/sound/Sound_list_.json
index 02e3cccb..3116b6bb 100644
--- a/content/references/translations/en/sound/Sound_list_.json
+++ b/content/references/translations/en/sound/Sound_list_.json
@@ -6,8 +6,8 @@
"syntax": [".list()"],
"returns": "String[]",
"type": "method",
- "category": "sound",
- "subcategory": "",
+ "category": "Configuration",
+ "subcategory": "Sound",
"classanchor": "Sound",
"parameters": []
}
diff --git a/content/references/translations/en/sound/Sound_outputDevice_.json b/content/references/translations/en/sound/Sound_outputDevice_.json
index 5d5e356e..8aa41491 100644
--- a/content/references/translations/en/sound/Sound_outputDevice_.json
+++ b/content/references/translations/en/sound/Sound_outputDevice_.json
@@ -6,8 +6,8 @@
"syntax": [".outputDevice(deviceId)"],
"returns": "void",
"type": "method",
- "category": "sound",
- "subcategory": "",
+ "category": "Configuration",
+ "subcategory": "Sound",
"classanchor": "Sound",
"parameters": [
{
diff --git a/content/references/translations/en/sound/Sound_sampleRate_.json b/content/references/translations/en/sound/Sound_sampleRate_.json
index 40e62bcf..167300a1 100644
--- a/content/references/translations/en/sound/Sound_sampleRate_.json
+++ b/content/references/translations/en/sound/Sound_sampleRate_.json
@@ -6,8 +6,8 @@
"syntax": [".sampleRate()", ".sampleRate(sampleRate)"],
"returns": "int",
"type": "method",
- "category": "sound",
- "subcategory": "",
+ "category": "Configuration",
+ "subcategory": "Sound",
"classanchor": "Sound",
"parameters": [
{
diff --git a/content/references/translations/en/sound/Sound_volume_.json b/content/references/translations/en/sound/Sound_volume_.json
index 9a75245f..c04f61e4 100644
--- a/content/references/translations/en/sound/Sound_volume_.json
+++ b/content/references/translations/en/sound/Sound_volume_.json
@@ -6,8 +6,8 @@
"syntax": [".volume(volume)"],
"returns": "void",
"type": "method",
- "category": "sound",
- "subcategory": "",
+ "category": "Configuration",
+ "subcategory": "Sound",
"classanchor": "Sound",
"parameters": [
{
diff --git a/content/references/translations/en/sound/SqrOsc.json b/content/references/translations/en/sound/SqrOsc.json
index 78f81851..0dd083b9 100644
--- a/content/references/translations/en/sound/SqrOsc.json
+++ b/content/references/translations/en/sound/SqrOsc.json
@@ -2,14 +2,9 @@
"brief": "This is a simple Square Wave Oscillator.",
"methods": [
{
- "anchor": "SqrOsc_play_",
- "name": "play()",
- "desc": "Starts the oscillator."
- },
- {
- "anchor": "SqrOsc_set_",
- "name": "set()",
- "desc": "Set multiple parameters at once."
+ "anchor": "SqrOsc_amp_",
+ "name": "amp()",
+ "desc": "Change the amplitude/volume of this sound."
},
{
"anchor": "SqrOsc_freq_",
@@ -17,24 +12,24 @@
"desc": "Set the frequency of the oscillator in Hz."
},
{
- "anchor": "SqrOsc_amp_",
- "name": "amp()",
- "desc": "Change the amplitude/volume of of the square oscillator."
+ "anchor": "SqrOsc_pan_",
+ "name": "pan()",
+ "desc": "Move the sound in a stereo panorama."
},
{
- "anchor": "SqrOsc_add_",
- "name": "add()",
- "desc": "Offset the output of this generator by given value."
+ "anchor": "SqrOsc_play_",
+ "name": "play()",
+ "desc": "Starts the oscillator"
},
{
- "anchor": "SqrOsc_pan_",
- "name": "pan()",
- "desc": "Move the sound in a stereo panorama."
+ "anchor": "SqrOsc_set_",
+ "name": "set()",
+ "desc": "Set multiple parameters at once"
},
{
"anchor": "SqrOsc_stop_",
"name": "stop()",
- "desc": "Stop the oscillator."
+ "desc": "Stop the oscillator from playing back"
}
],
"csspath": "../../",
@@ -42,17 +37,21 @@
"classFields": [],
"description": "This is a simple Square Wave Oscillator.",
"type": "class",
- "constructors": ["SqrOsc(parent)"],
+ "constructors": [
+ "SqrOsc(parent)"
+ ],
"related": [],
"name": "SqrOsc",
"classanchor": "sound/SqrOsc",
- "category": "oscillators",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "SqrOsc",
"parameters": [
{
"name": "parent",
"description": "typically use \"this\"",
- "type": ["PApplet"]
+ "type": [
+ "PApplet"
+ ]
}
]
}
diff --git a/content/references/translations/en/sound/SqrOsc_add_.json b/content/references/translations/en/sound/SqrOsc_add_.json
deleted file mode 100644
index 9f852bd2..00000000
--- a/content/references/translations/en/sound/SqrOsc_add_.json
+++ /dev/null
@@ -1,19 +0,0 @@
-{
- "brief": "Offset the output of this generator by given value.",
- "related": [],
- "name": "add()",
- "description": "Offset the output of this generator by given value.",
- "syntax": [".add(add)"],
- "returns": "void",
- "type": "method",
- "category": "sqrosc",
- "subcategory": "",
- "classanchor": "SqrOsc",
- "parameters": [
- {
- "name": "add",
- "description": "Offset the output of the oscillator by given value",
- "type": ["float"]
- }
- ]
-}
diff --git a/content/references/translations/en/sound/SqrOsc_amp_.json b/content/references/translations/en/sound/SqrOsc_amp_.json
index 9d0d9676..a3cfbaca 100644
--- a/content/references/translations/en/sound/SqrOsc_amp_.json
+++ b/content/references/translations/en/sound/SqrOsc_amp_.json
@@ -1,13 +1,13 @@
{
- "brief": "Change the amplitude/volume of of the square oscillator.",
+ "brief": "Change the amplitude/volume of this sound.",
"related": [],
"name": "amp()",
- "description": "Change the amplitude/volume of of the square oscillator. \n Allowed values are between 0.0 and 1.0.",
+ "description": "Change the amplitude/volume of this sound.",
"syntax": [".amp(amp)"],
"returns": "void",
"type": "method",
- "category": "sqrosc",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "SqrOsc",
"classanchor": "SqrOsc",
"parameters": [
{
diff --git a/content/references/translations/en/sound/SqrOsc_freq_.json b/content/references/translations/en/sound/SqrOsc_freq_.json
index 2e8ae43d..f4db0abf 100644
--- a/content/references/translations/en/sound/SqrOsc_freq_.json
+++ b/content/references/translations/en/sound/SqrOsc_freq_.json
@@ -6,8 +6,8 @@
"syntax": [".freq(freq)"],
"returns": "void",
"type": "method",
- "category": "sqrosc",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "SqrOsc",
"classanchor": "SqrOsc",
"parameters": [
{
diff --git a/content/references/translations/en/sound/SqrOsc_pan_.json b/content/references/translations/en/sound/SqrOsc_pan_.json
index dd9affe1..bcde0ea2 100644
--- a/content/references/translations/en/sound/SqrOsc_pan_.json
+++ b/content/references/translations/en/sound/SqrOsc_pan_.json
@@ -6,8 +6,8 @@
"syntax": [".pan(pos)"],
"returns": "void",
"type": "method",
- "category": "sqrosc",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "SqrOsc",
"classanchor": "SqrOsc",
"parameters": [
{
diff --git a/content/references/translations/en/sound/SqrOsc_play_.json b/content/references/translations/en/sound/SqrOsc_play_.json
index 74b229d1..d09f670f 100644
--- a/content/references/translations/en/sound/SqrOsc_play_.json
+++ b/content/references/translations/en/sound/SqrOsc_play_.json
@@ -1,8 +1,8 @@
{
- "brief": "Starts the oscillator.",
+ "brief": "Starts the oscillator",
"related": [],
"name": "play()",
- "description": "Starts the oscillator.",
+ "description": "Starts the oscillator",
"syntax": [
".play()",
".play(freq, amp)",
@@ -11,8 +11,8 @@
],
"returns": "void",
"type": "method",
- "category": "sqrosc",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "SqrOsc",
"classanchor": "SqrOsc",
"parameters": [
{
@@ -25,11 +25,6 @@
"description": "The amplitude of the oscillator as a value between 0.0 and 1.0.",
"type": ["float"]
},
- {
- "name": "add",
- "description": "Offset the output of the oscillator by given value",
- "type": ["float"]
- },
{
"name": "pos",
"description": "The panoramic position of the oscillator as a float from -1.0 to 1.0.",
diff --git a/content/references/translations/en/sound/SqrOsc_set_.json b/content/references/translations/en/sound/SqrOsc_set_.json
index 656c7d8e..3a1f98e5 100644
--- a/content/references/translations/en/sound/SqrOsc_set_.json
+++ b/content/references/translations/en/sound/SqrOsc_set_.json
@@ -1,13 +1,13 @@
{
- "brief": "Set multiple parameters at once.",
+ "brief": "Set multiple parameters at once",
"related": [],
"name": "set()",
- "description": "Set multiple parameters at once.",
- "syntax": [".set(freq, amp, add, pos)"],
+ "description": "Set multiple parameters at once",
+ "syntax": [".set(freq, amp, pos)"],
"returns": "void",
"type": "method",
- "category": "sqrosc",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "SqrOsc",
"classanchor": "SqrOsc",
"parameters": [
{
@@ -20,11 +20,6 @@
"description": "The amplitude of the oscillator as a value between 0.0 and 1.0.",
"type": ["float"]
},
- {
- "name": "add",
- "description": "Offset the output of the oscillator by given value",
- "type": ["float"]
- },
{
"name": "pos",
"description": "The panoramic position of the oscillator as a float from -1.0 to 1.0.",
diff --git a/content/references/translations/en/sound/SqrOsc_stop_.json b/content/references/translations/en/sound/SqrOsc_stop_.json
index 7a8a3ffc..bbbe1a03 100644
--- a/content/references/translations/en/sound/SqrOsc_stop_.json
+++ b/content/references/translations/en/sound/SqrOsc_stop_.json
@@ -1,13 +1,13 @@
{
- "brief": "Stop the oscillator.",
+ "brief": "Stop the oscillator from playing back",
"related": [],
"name": "stop()",
- "description": "Stop the oscillator.",
+ "description": "Stop the oscillator from playing back",
"syntax": [".stop()"],
"returns": "void",
"type": "method",
- "category": "sqrosc",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "SqrOsc",
"classanchor": "SqrOsc",
"parameters": []
}
diff --git a/content/references/translations/en/sound/TriOsc.json b/content/references/translations/en/sound/TriOsc.json
index 3220be28..afb45a0d 100644
--- a/content/references/translations/en/sound/TriOsc.json
+++ b/content/references/translations/en/sound/TriOsc.json
@@ -1,15 +1,10 @@
{
- "brief": "This is a simple triangle (or \"saw\") wave oscillator.",
+ "brief": "This is a simple triangle wave oscillator.",
"methods": [
{
- "anchor": "TriOsc_play_",
- "name": "play()",
- "desc": "Starts the oscillator."
- },
- {
- "anchor": "TriOsc_set_",
- "name": "set()",
- "desc": "Set multiple parameters at once."
+ "anchor": "TriOsc_amp_",
+ "name": "amp()",
+ "desc": "Change the amplitude/volume of this sound."
},
{
"anchor": "TriOsc_freq_",
@@ -17,42 +12,46 @@
"desc": "Set the frequency of the oscillator in Hz."
},
{
- "anchor": "TriOsc_amp_",
- "name": "amp()",
- "desc": "Changes the amplitude/volume of the triangle oscillator."
+ "anchor": "TriOsc_pan_",
+ "name": "pan()",
+ "desc": "Move the sound in a stereo panorama."
},
{
- "anchor": "TriOsc_add_",
- "name": "add()",
- "desc": "Offset the output of this generator by given value."
+ "anchor": "TriOsc_play_",
+ "name": "play()",
+ "desc": "Starts the oscillator"
},
{
- "anchor": "TriOsc_pan_",
- "name": "pan()",
- "desc": "Move the sound in a stereo panorama."
+ "anchor": "TriOsc_set_",
+ "name": "set()",
+ "desc": "Set multiple parameters at once"
},
{
"anchor": "TriOsc_stop_",
"name": "stop()",
- "desc": "Stop the oscillator."
+ "desc": "Stop the oscillator from playing back"
}
],
"csspath": "../../",
"isLibrary": "true",
"classFields": [],
- "description": "This is a simple triangle (or \"saw\") wave oscillator.",
+ "description": "This is a simple triangle wave oscillator.",
"type": "class",
- "constructors": ["TriOsc(parent)"],
+ "constructors": [
+ "TriOsc(parent)"
+ ],
"related": [],
"name": "TriOsc",
"classanchor": "sound/TriOsc",
- "category": "oscillators",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "TriOsc",
"parameters": [
{
"name": "parent",
"description": "typically use \"this\"",
- "type": ["PApplet"]
+ "type": [
+ "PApplet"
+ ]
}
]
}
diff --git a/content/references/translations/en/sound/TriOsc_add_.json b/content/references/translations/en/sound/TriOsc_add_.json
deleted file mode 100644
index 2c3f75b6..00000000
--- a/content/references/translations/en/sound/TriOsc_add_.json
+++ /dev/null
@@ -1,19 +0,0 @@
-{
- "brief": "Offset the output of this generator by given value.",
- "related": [],
- "name": "add()",
- "description": "Offset the output of this generator by given value.",
- "syntax": [".add(add)"],
- "returns": "void",
- "type": "method",
- "category": "triosc",
- "subcategory": "",
- "classanchor": "TriOsc",
- "parameters": [
- {
- "name": "add",
- "description": "Offset the output of the oscillator by given value",
- "type": ["float"]
- }
- ]
-}
diff --git a/content/references/translations/en/sound/TriOsc_amp_.json b/content/references/translations/en/sound/TriOsc_amp_.json
index beba179c..f5ce1a64 100644
--- a/content/references/translations/en/sound/TriOsc_amp_.json
+++ b/content/references/translations/en/sound/TriOsc_amp_.json
@@ -1,13 +1,13 @@
{
- "brief": "Changes the amplitude/volume of the triangle oscillator.",
+ "brief": "Change the amplitude/volume of this sound.",
"related": [],
"name": "amp()",
- "description": "Changes the amplitude/volume of the triangle oscillator. \n Allowed values are between 0.0 and 1.0.",
+ "description": "Change the amplitude/volume of this sound.",
"syntax": [".amp(amp)"],
"returns": "void",
"type": "method",
- "category": "triosc",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "TriOsc",
"classanchor": "TriOsc",
"parameters": [
{
diff --git a/content/references/translations/en/sound/TriOsc_freq_.json b/content/references/translations/en/sound/TriOsc_freq_.json
index 04fecc6c..f182e39f 100644
--- a/content/references/translations/en/sound/TriOsc_freq_.json
+++ b/content/references/translations/en/sound/TriOsc_freq_.json
@@ -6,8 +6,8 @@
"syntax": [".freq(freq)"],
"returns": "void",
"type": "method",
- "category": "triosc",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "TriOsc",
"classanchor": "TriOsc",
"parameters": [
{
diff --git a/content/references/translations/en/sound/TriOsc_pan_.json b/content/references/translations/en/sound/TriOsc_pan_.json
index 50835ffb..375b836f 100644
--- a/content/references/translations/en/sound/TriOsc_pan_.json
+++ b/content/references/translations/en/sound/TriOsc_pan_.json
@@ -2,12 +2,12 @@
"brief": "Move the sound in a stereo panorama.",
"related": [],
"name": "pan()",
- "description": "Move the sound 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",
- "category": "triosc",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "TriOsc",
"classanchor": "TriOsc",
"parameters": [
{
diff --git a/content/references/translations/en/sound/TriOsc_play_.json b/content/references/translations/en/sound/TriOsc_play_.json
index 82fd9ff2..0e9facc1 100644
--- a/content/references/translations/en/sound/TriOsc_play_.json
+++ b/content/references/translations/en/sound/TriOsc_play_.json
@@ -1,8 +1,8 @@
{
- "brief": "Starts the oscillator.",
+ "brief": "Starts the oscillator",
"related": [],
"name": "play()",
- "description": "Starts the oscillator.",
+ "description": "Starts the oscillator",
"syntax": [
".play()",
".play(freq, amp)",
@@ -11,8 +11,8 @@
],
"returns": "void",
"type": "method",
- "category": "triosc",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "TriOsc",
"classanchor": "TriOsc",
"parameters": [
{
@@ -25,11 +25,6 @@
"description": "The amplitude of the oscillator as a value between 0.0 and 1.0.",
"type": ["float"]
},
- {
- "name": "add",
- "description": "Offset the output of the oscillator by given value",
- "type": ["float"]
- },
{
"name": "pos",
"description": "The panoramic position of the oscillator as a float from -1.0 to 1.0.",
diff --git a/content/references/translations/en/sound/TriOsc_set_.json b/content/references/translations/en/sound/TriOsc_set_.json
index e5232b6a..b7d3fdee 100644
--- a/content/references/translations/en/sound/TriOsc_set_.json
+++ b/content/references/translations/en/sound/TriOsc_set_.json
@@ -1,13 +1,13 @@
{
- "brief": "Set multiple parameters at once.",
+ "brief": "Set multiple parameters at once",
"related": [],
"name": "set()",
- "description": "Set multiple parameters at once.",
- "syntax": [".set(freq, amp, add, pos)"],
+ "description": "Set multiple parameters at once",
+ "syntax": [".set(freq, amp, pos)"],
"returns": "void",
"type": "method",
- "category": "triosc",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "TriOsc",
"classanchor": "TriOsc",
"parameters": [
{
@@ -20,11 +20,6 @@
"description": "The amplitude of the oscillator as a value between 0.0 and 1.0.",
"type": ["float"]
},
- {
- "name": "add",
- "description": "Offset the output of the oscillator by given value",
- "type": ["float"]
- },
{
"name": "pos",
"description": "The panoramic position of the oscillator as a float from -1.0 to 1.0.",
diff --git a/content/references/translations/en/sound/TriOsc_stop_.json b/content/references/translations/en/sound/TriOsc_stop_.json
index 9aa28318..ad4701be 100644
--- a/content/references/translations/en/sound/TriOsc_stop_.json
+++ b/content/references/translations/en/sound/TriOsc_stop_.json
@@ -1,13 +1,13 @@
{
- "brief": "Stop the oscillator.",
+ "brief": "Stop the oscillator from playing back",
"related": [],
"name": "stop()",
- "description": "Stop the oscillator.",
+ "description": "Stop the oscillator from playing back",
"syntax": [".stop()"],
"returns": "void",
"type": "method",
- "category": "triosc",
- "subcategory": "",
+ "category": "Oscillators",
+ "subcategory": "TriOsc",
"classanchor": "TriOsc",
"parameters": []
}
diff --git a/content/references/translations/en/sound/Waveform.json b/content/references/translations/en/sound/Waveform.json
index cea072a8..d9fc6611 100644
--- a/content/references/translations/en/sound/Waveform.json
+++ b/content/references/translations/en/sound/Waveform.json
@@ -17,22 +17,28 @@
"classFields": [],
"description": "This is a Waveform analyzer. It returns the waveform of an \n audio stream the moment it is queried with the analyze()\n method.",
"type": "class",
- "constructors": ["Waveform(parent, nsamples)"],
+ "constructors": [
+ "Waveform(parent, nsamples)"
+ ],
"related": [],
"name": "Waveform",
"classanchor": "sound/Waveform",
- "category": "analysis",
- "subcategory": "",
+ "category": "Analysis",
+ "subcategory": "Waveform",
"parameters": [
{
"name": "parent",
"description": "typically use \"this\"",
- "type": ["PApplet"]
+ "type": [
+ "PApplet"
+ ]
},
{
"name": "nsamples",
"description": "number of waveform samples that you want to be able to read at once (a positive integer).",
- "type": ["int"]
+ "type": [
+ "int"
+ ]
}
]
}
diff --git a/content/references/translations/en/sound/Waveform_analyze_.json b/content/references/translations/en/sound/Waveform_analyze_.json
index 95f3dcbe..c2e8b940 100644
--- a/content/references/translations/en/sound/Waveform_analyze_.json
+++ b/content/references/translations/en/sound/Waveform_analyze_.json
@@ -6,8 +6,8 @@
"syntax": [".analyze()", ".analyze(value)"],
"returns": "float[]",
"type": "method",
- "category": "waveform",
- "subcategory": "",
+ "category": "Analysis",
+ "subcategory": "Waveform",
"classanchor": "Waveform",
"parameters": [
{
diff --git a/content/references/translations/en/sound/Waveform_input_.json b/content/references/translations/en/sound/Waveform_input_.json
index 1528fb0d..f837663b 100644
--- a/content/references/translations/en/sound/Waveform_input_.json
+++ b/content/references/translations/en/sound/Waveform_input_.json
@@ -6,8 +6,8 @@
"syntax": [".input(input)"],
"returns": "void",
"type": "method",
- "category": "waveform",
- "subcategory": "",
+ "category": "Analysis",
+ "subcategory": "Waveform",
"classanchor": "Waveform",
"parameters": [
{
diff --git a/content/references/translations/en/sound/WhiteNoise.json b/content/references/translations/en/sound/WhiteNoise.json
index 1fb323a7..37535028 100644
--- a/content/references/translations/en/sound/WhiteNoise.json
+++ b/content/references/translations/en/sound/WhiteNoise.json
@@ -1,35 +1,30 @@
{
"brief": "This is a White Noise Generator.",
"methods": [
- {
- "anchor": "WhiteNoise_play_",
- "name": "play()",
- "desc": "Start the generator."
- },
- {
- "anchor": "WhiteNoise_set_",
- "name": "set()",
- "desc": "Set multiple parameters at once."
- },
{
"anchor": "WhiteNoise_amp_",
"name": "amp()",
"desc": "Change the amplitude/volume of this sound."
},
- {
- "anchor": "WhiteNoise_add_",
- "name": "add()",
- "desc": "Offset the output of this generator by a fixed value."
- },
{
"anchor": "WhiteNoise_pan_",
"name": "pan()",
"desc": "Move the sound in a stereo panorama."
},
+ {
+ "anchor": "WhiteNoise_play_",
+ "name": "play()",
+ "desc": "Starts the noise"
+ },
+ {
+ "anchor": "WhiteNoise_set_",
+ "name": "set()",
+ "desc": "Set the amplitude and panoramic position with one method."
+ },
{
"anchor": "WhiteNoise_stop_",
"name": "stop()",
- "desc": "Stop the generator."
+ "desc": "Stop the noise from playing back"
}
],
"csspath": "../../",
@@ -37,17 +32,21 @@
"classFields": [],
"description": "This is a White Noise Generator. White Noise has a flat spectrum.",
"type": "class",
- "constructors": ["WhiteNoise(parent)"],
+ "constructors": [
+ "WhiteNoise(parent)"
+ ],
"related": [],
"name": "WhiteNoise",
"classanchor": "sound/WhiteNoise",
- "category": "noise",
- "subcategory": "",
+ "category": "Noise",
+ "subcategory": "WhiteNoise",
"parameters": [
{
"name": "parent",
"description": "typically use \"this\"",
- "type": ["PApplet"]
+ "type": [
+ "PApplet"
+ ]
}
]
}
diff --git a/content/references/translations/en/sound/WhiteNoise_add_.json b/content/references/translations/en/sound/WhiteNoise_add_.json
deleted file mode 100644
index 24024da9..00000000
--- a/content/references/translations/en/sound/WhiteNoise_add_.json
+++ /dev/null
@@ -1,19 +0,0 @@
-{
- "brief": "Offset the output of this generator by a fixed value.",
- "related": [],
- "name": "add()",
- "description": "Offset the output of this generator by a fixed value.",
- "syntax": [".add(add)"],
- "returns": "void",
- "type": "method",
- "category": "whitenoise",
- "subcategory": "",
- "classanchor": "WhiteNoise",
- "parameters": [
- {
- "name": "add",
- "description": "offset the output of the generator by the given value",
- "type": ["float"]
- }
- ]
-}
diff --git a/content/references/translations/en/sound/WhiteNoise_amp_.json b/content/references/translations/en/sound/WhiteNoise_amp_.json
index 4a392525..475b4133 100644
--- a/content/references/translations/en/sound/WhiteNoise_amp_.json
+++ b/content/references/translations/en/sound/WhiteNoise_amp_.json
@@ -2,17 +2,17 @@
"brief": "Change the amplitude/volume of this sound.",
"related": [],
"name": "amp()",
- "description": "Change the amplitude/volume of this sound. Allowed values are between 0.0 and 1.0.",
+ "description": "Change the amplitude/volume of this sound.",
"syntax": [".amp(amp)"],
"returns": "void",
"type": "method",
- "category": "whitenoise",
- "subcategory": "",
+ "category": "Noise",
+ "subcategory": "WhiteNoise",
"classanchor": "WhiteNoise",
"parameters": [
{
"name": "amp",
- "description": "the amplitude of the noise 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"]
}
]
diff --git a/content/references/translations/en/sound/WhiteNoise_pan_.json b/content/references/translations/en/sound/WhiteNoise_pan_.json
index e2da3603..f9e2ea31 100644
--- a/content/references/translations/en/sound/WhiteNoise_pan_.json
+++ b/content/references/translations/en/sound/WhiteNoise_pan_.json
@@ -2,17 +2,17 @@
"brief": "Move the sound in a stereo panorama.",
"related": [],
"name": "pan()",
- "description": "Move the sound 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",
- "category": "whitenoise",
- "subcategory": "",
+ "category": "Noise",
+ "subcategory": "WhiteNoise",
"classanchor": "WhiteNoise",
"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"]
}
]
diff --git a/content/references/translations/en/sound/WhiteNoise_play_.json b/content/references/translations/en/sound/WhiteNoise_play_.json
index 7eaf80a6..1338c97a 100644
--- a/content/references/translations/en/sound/WhiteNoise_play_.json
+++ b/content/references/translations/en/sound/WhiteNoise_play_.json
@@ -1,33 +1,23 @@
{
- "brief": "Start the generator.",
+ "brief": "Starts the noise",
"related": [],
"name": "play()",
- "description": "Start the generator.",
- "syntax": [
- ".play()",
- ".play(amp)",
- ".play(amp, pos)",
- ".play(amp, add, pos)"
- ],
+ "description": "Starts the noise",
+ "syntax": [".play(amp)", ".play(amp, pos)", ".play(amp, add, pos)"],
"returns": "void",
"type": "method",
- "category": "whitenoise",
- "subcategory": "",
+ "category": "Noise",
+ "subcategory": "WhiteNoise",
"classanchor": "WhiteNoise",
"parameters": [
{
"name": "amp",
- "description": "the amplitude of the noise as a value from 0.0 (complete silence) to 1.0 (full volume)",
- "type": ["float"]
- },
- {
- "name": "add",
- "description": "offset the output of the noise by given value",
+ "description": "The amplitude of the noise as a value between 0.0 and 1.0.",
"type": ["float"]
},
{
"name": "pos",
- "description": "pan the generator in stereo panorama. Allowed values are between -1.0 and 1.0.",
+ "description": "The panoramic position of the noise as a float from -1.0 to 1.0.",
"type": ["float"]
}
]
diff --git a/content/references/translations/en/sound/WhiteNoise_set_.json b/content/references/translations/en/sound/WhiteNoise_set_.json
index 8118a64e..cddc09be 100644
--- a/content/references/translations/en/sound/WhiteNoise_set_.json
+++ b/content/references/translations/en/sound/WhiteNoise_set_.json
@@ -1,28 +1,23 @@
{
- "brief": "Set multiple parameters at once.",
+ "brief": "Set the amplitude and panoramic position with one method.",
"related": [],
"name": "set()",
- "description": "Set multiple parameters at once.",
- "syntax": [".set(amp, add, pos)"],
+ "description": "Set the amplitude and panoramic position with one method.",
+ "syntax": [".set(amp, pos)"],
"returns": "void",
"type": "method",
- "category": "whitenoise",
- "subcategory": "",
+ "category": "Noise",
+ "subcategory": "WhiteNoise",
"classanchor": "WhiteNoise",
"parameters": [
{
"name": "amp",
- "description": "the amplitude of the noise as a value from 0.0 (complete silence) to 1.0 (full volume)",
- "type": ["float"]
- },
- {
- "name": "add",
- "description": "offset the output of the noise by given value",
+ "description": "The amplitude of the noise as a value between 0.0 and 1.0.",
"type": ["float"]
},
{
"name": "pos",
- "description": "pan the generator in stereo panorama. Allowed values are between -1.0 and 1.0.",
+ "description": "The panoramic position of the noise as a float from -1.0 to 1.0.",
"type": ["float"]
}
]
diff --git a/content/references/translations/en/sound/WhiteNoise_stop_.json b/content/references/translations/en/sound/WhiteNoise_stop_.json
index a732980c..c37f4de9 100644
--- a/content/references/translations/en/sound/WhiteNoise_stop_.json
+++ b/content/references/translations/en/sound/WhiteNoise_stop_.json
@@ -1,13 +1,13 @@
{
- "brief": "Stop the generator.",
+ "brief": "Stop the noise from playing back",
"related": [],
"name": "stop()",
- "description": "Stop the generator.",
+ "description": "Stop the noise from playing back",
"syntax": [".stop()"],
"returns": "void",
"type": "method",
- "category": "whitenoise",
- "subcategory": "",
+ "category": "Noise",
+ "subcategory": "WhiteNoise",
"classanchor": "WhiteNoise",
"parameters": []
}