diff --git a/content/references/translations/en/sound/AllPass.json b/content/references/translations/en/sound/AllPass.json
new file mode 100644
index 00000000..53e3f728
--- /dev/null
+++ b/content/references/translations/en/sound/AllPass.json
@@ -0,0 +1,34 @@
+{
+ "brief": "Outputs all input frequencies at the same amplitude but changes \n their phase relationship.",
+ "methods": [
+ {
+ "anchor": "AllPass_gain_",
+ "name": "gain()",
+ "desc": "Sets the gain for the filter."
+ },
+ {
+ "anchor": "AllPass_process_",
+ "name": "process()",
+ "desc": "Start the effect."
+ },
+ {
+ "anchor": "AllPass_stop_",
+ "name": "stop()",
+ "desc": "Stop the effect."
+ }
+ ],
+ "csspath": "../../",
+ "isLibrary": "true",
+ "classFields": [],
+ "description": "This is an all pass filter. For signals processed, all frequencies hold the \n same amplitude but have their phase relationship modified using a delayline \n of one sample,
\n
\n y(k) = -z * x(k) + x(k - 1) + z * y(k - 1)
\n
\n where y
is the output, x
is the input, \n z
is the gain coefficient, and k
is the signal.",
+ "type": "class",
+ "constructors": [
+ "AllPass(parent)"
+ ],
+ "related": [],
+ "name": "AllPass",
+ "classanchor": "sound/AllPass",
+ "category": "Effects",
+ "subcategory": "AllPass",
+ "parameters": []
+}
diff --git a/content/references/translations/en/sound/AllPass_gain_.json b/content/references/translations/en/sound/AllPass_gain_.json
new file mode 100644
index 00000000..8b328b0e
--- /dev/null
+++ b/content/references/translations/en/sound/AllPass_gain_.json
@@ -0,0 +1,19 @@
+{
+ "brief": "Sets the gain for the filter.",
+ "related": [],
+ "name": "gain()",
+ "description": "Sets the gain for the filter in the range 0.0 - 1.0, where larger values \n increase phase displacement.",
+ "syntax": [".gain(g)"],
+ "returns": "void",
+ "type": "method",
+ "category": "Effects",
+ "subcategory": "AllPass",
+ "classanchor": "AllPass",
+ "parameters": [
+ {
+ "name": "g",
+ "description": "phase displacement in the range 0.0 - 1.0",
+ "type": ["float"]
+ }
+ ]
+}
diff --git a/content/references/translations/en/sound/AllPass_process_.json b/content/references/translations/en/sound/AllPass_process_.json
new file mode 100644
index 00000000..dfc83efe
--- /dev/null
+++ b/content/references/translations/en/sound/AllPass_process_.json
@@ -0,0 +1,19 @@
+{
+ "brief": "Start the effect.",
+ "related": [],
+ "name": "process()",
+ "description": "Start the effect.",
+ "syntax": [".process(input)"],
+ "returns": "void",
+ "type": "method",
+ "category": "Effects",
+ "subcategory": "AllPass",
+ "classanchor": "AllPass",
+ "parameters": [
+ {
+ "name": "input",
+ "description": "Input sound source",
+ "type": ["SoundObject"]
+ }
+ ]
+}
diff --git a/content/references/translations/en/sound/AllPass_stop_.json b/content/references/translations/en/sound/AllPass_stop_.json
new file mode 100644
index 00000000..27990483
--- /dev/null
+++ b/content/references/translations/en/sound/AllPass_stop_.json
@@ -0,0 +1,13 @@
+{
+ "brief": "Stop the effect.",
+ "related": [],
+ "name": "stop()",
+ "description": "Stop the effect.",
+ "syntax": [".stop()"],
+ "returns": "void",
+ "type": "method",
+ "category": "Effects",
+ "subcategory": "AllPass",
+ "classanchor": "AllPass",
+ "parameters": []
+}
diff --git a/content/references/translations/en/sound/AudioSample.json b/content/references/translations/en/sound/AudioSample.json
index 4908e6e6..497f42fc 100644
--- a/content/references/translations/en/sound/AudioSample.json
+++ b/content/references/translations/en/sound/AudioSample.json
@@ -34,7 +34,7 @@
{
"anchor": "AudioSample_jump_",
"name": "jump()",
- "desc": "Jump to a specific position in the audiosample while continuing to play (or starting to play if it wasn't playing already)."
+ "desc": "Jumps to a specific position in the audio sample."
},
{
"anchor": "AudioSample_jumpFrame_",
@@ -84,7 +84,7 @@
{
"anchor": "AudioSample_stop_",
"name": "stop()",
- "desc": "Stops the playback, and sets the cue back to the start of the sample."
+ "desc": "Stops the playback."
},
{
"anchor": "AudioSample_position_",
@@ -120,7 +120,7 @@
"csspath": "../../",
"isLibrary": "true",
"classFields": [],
- "description": "This class allows you low-level access to an audio buffer to create, access,\n manipulate and play back sound samples.\n \n If you want to pre-load your audio sample with an audio file from disk you\n can do so using the SoundFile subclass.",
+ "description": "This class allows you low-level access to an audio buffer to create, access,\n manipulate and play back sound samples.\n \n If you want to pre-load your audio sample with an audio file from disk you\n can do so using the {@link SoundFile} subclass.",
"type": "class",
"constructors": [
"AudioSample(parent, frames)",
@@ -150,18 +150,13 @@
},
{
"name": "stereo",
- "description": "whether to treat the audiosample as 2-channel (stereo) or not\n (default: false)",
+ "description": "whether to treat the audiosample as 2-channel (stereo) or not\n (default: ,,false,
,)",
"type": ["boolean"]
},
{
"name": "frameRate",
"description": "the underlying frame rate of the sample (default: 44100)",
"type": ["int"]
- },
- {
- "name": "data",
- "description": "an array of float values to be used as this audiosample's sound\n data. The audiosample will consequently have as many frames as the\n length of the given array.",
- "type": ["float[]"]
}
]
}
diff --git a/content/references/translations/en/sound/AudioSample_jump_.json b/content/references/translations/en/sound/AudioSample_jump_.json
index 7ad59a93..92bca264 100644
--- a/content/references/translations/en/sound/AudioSample_jump_.json
+++ b/content/references/translations/en/sound/AudioSample_jump_.json
@@ -1,8 +1,8 @@
{
- "brief": "Jump to a specific position in the audiosample while continuing to play (or starting to play if it wasn't playing already).",
+ "brief": "Jumps to a specific position in the audio sample.",
"related": ["sound/AudioSample_cue_", "sound/AudioSample_play_"],
"name": "jump()",
- "description": "Jump to a specific position in the audiosample while continuing to play (or starting to play if it wasn't playing already).",
+ "description": "Jump to a specific position in the audiosample while continuing to play (or \n starting to play if it wasn't playing already).",
"syntax": [".jump(time)"],
"returns": "void",
"type": "method",
@@ -12,7 +12,7 @@
"parameters": [
{
"name": "time",
- "description": "position to jump to, in seconds.",
+ "description": "position to jump to, in seconds",
"type": ["float"]
}
]
diff --git a/content/references/translations/en/sound/AudioSample_loop_.json b/content/references/translations/en/sound/AudioSample_loop_.json
index 88f5ef10..87916526 100644
--- a/content/references/translations/en/sound/AudioSample_loop_.json
+++ b/content/references/translations/en/sound/AudioSample_loop_.json
@@ -2,13 +2,12 @@
"brief": "Starts the playback of the audiosample.",
"related": [],
"name": "loop()",
- "description": "Starts playback which will loop at the end of the audiosample.",
+ "description": "Starts the playback of the audiosample. Only plays to the end of the audiosample \n once. If cue() or pause() were called previously, playback will resume from the cued position.",
"syntax": [
".loop()",
".loop(rate)",
".loop(rate, amp)",
- ".loop(rate, pos, amp)",
- ".loop(rate, pos, amp, add)"
+ ".loop(rate, pos, amp)"
],
"returns": "void",
"type": "method",
diff --git a/content/references/translations/en/sound/AudioSample_play_.json b/content/references/translations/en/sound/AudioSample_play_.json
index 984989a3..10ba4257 100644
--- a/content/references/translations/en/sound/AudioSample_play_.json
+++ b/content/references/translations/en/sound/AudioSample_play_.json
@@ -8,8 +8,7 @@
".play(rate)",
".play(rate, amp)",
".play(rate, pos, amp)",
- ".play(rate, pos, amp, add)",
- ".play(rate, pos, amp, add, cue)"
+ ".play(rate, pos, amp, cue)"
],
"returns": "void",
"type": "method",
@@ -32,11 +31,6 @@
"description": "the desired playback amplitude of the audiosample as a value from\n 0.0 (complete silence) to 1.0 (full volume)",
"type": ["float"]
},
- {
- "name": "add",
- "description": "offset the output of the generator by the given value",
- "type": ["float"]
- },
{
"name": "cue",
"description": "position in the audiosample that playback should start from, in\n seconds.",
diff --git a/content/references/translations/en/sound/AudioSample_set_.json b/content/references/translations/en/sound/AudioSample_set_.json
index 5a831b44..2d50725b 100644
--- a/content/references/translations/en/sound/AudioSample_set_.json
+++ b/content/references/translations/en/sound/AudioSample_set_.json
@@ -3,7 +3,7 @@
"related": [],
"name": "set()",
"description": "Set multiple parameters at once.",
- "syntax": [".set(rate, pos, amp)", ".set(rate, pos, amp, add)"],
+ "syntax": [".set(rate, pos, amp)"],
"returns": "void",
"type": "method",
"category": "Sampling",
diff --git a/content/references/translations/en/sound/AudioSample_stop_.json b/content/references/translations/en/sound/AudioSample_stop_.json
index e08e9756..d34a0752 100644
--- a/content/references/translations/en/sound/AudioSample_stop_.json
+++ b/content/references/translations/en/sound/AudioSample_stop_.json
@@ -1,8 +1,8 @@
{
- "brief": "Stops the playback, and sets the cue back to the start of the sample.",
+ "brief": "Stops the playback.",
"related": [],
"name": "stop()",
- "description": "Stops the playback, and sets the cue back to the start of the sample.",
+ "description": "Stops the playback.",
"syntax": [".stop()"],
"returns": "void",
"type": "method",
diff --git a/content/references/translations/en/sound/BandPass.json b/content/references/translations/en/sound/BandPass.json
index 6f450a3e..12d09fd4 100644
--- a/content/references/translations/en/sound/BandPass.json
+++ b/content/references/translations/en/sound/BandPass.json
@@ -4,18 +4,23 @@
{
"anchor": "BandPass_bw_",
"name": "bw()",
- "desc": "Set the bandwidth for the filter."
+ "desc": "Sets the bandwidth for the filter."
},
{
"anchor": "BandPass_freq_",
"name": "freq()",
- "desc": "Set the cutoff frequency for the filter."
+ "desc": "Sets the center frequency of the filter."
},
{
"anchor": "BandPass_process_",
"name": "process()",
"desc": "Start applying this bandpass filter to an input signal."
},
+ {
+ "anchor": "BandPass_res_",
+ "name": "res()",
+ "desc": "Sets the resonance (or 'Q factor') of this filter."
+ },
{
"anchor": "BandPass_set_",
"name": "set()",
diff --git a/content/references/translations/en/sound/BandPass_bw_.json b/content/references/translations/en/sound/BandPass_bw_.json
index 1083b4a1..f4969c58 100644
--- a/content/references/translations/en/sound/BandPass_bw_.json
+++ b/content/references/translations/en/sound/BandPass_bw_.json
@@ -1,13 +1,19 @@
{
- "brief": "Set the bandwidth for the filter.",
+ "brief": "Sets the bandwidth for the filter.",
"related": [],
"name": "bw()",
- "description": "Set the bandwidth for the filter.",
+ "description": "Sets the bandwidth of this BandPass filter.",
"syntax": [".bw(bw)"],
"returns": "void",
"type": "method",
"category": "Effects",
"subcategory": "BandPass",
"classanchor": "BandPass",
- "parameters": []
+ "parameters": [
+ {
+ "name": "bw",
+ "description": "the filter bandwidth in Hertz",
+ "type": ["float"]
+ }
+ ]
}
diff --git a/content/references/translations/en/sound/BandPass_freq_.json b/content/references/translations/en/sound/BandPass_freq_.json
index 2bb49045..f46687bc 100644
--- a/content/references/translations/en/sound/BandPass_freq_.json
+++ b/content/references/translations/en/sound/BandPass_freq_.json
@@ -1,8 +1,8 @@
{
- "brief": "Set the cutoff frequency for the filter.",
+ "brief": "Sets the center frequency of the filter.",
"related": [],
"name": "freq()",
- "description": "Set the cutoff frequency for the filter.",
+ "description": "Sets the center frequency of the filter.",
"syntax": [".freq(freq)"],
"returns": "void",
"type": "method",
@@ -12,7 +12,7 @@
"parameters": [
{
"name": "freq",
- "description": "Cutoff frequency between 0 and 20000",
+ "description": "the center frequency in Hertz",
"type": ["float"]
}
]
diff --git a/content/references/translations/en/sound/BandPass_process_.json b/content/references/translations/en/sound/BandPass_process_.json
index 3a7accbf..e754f4e2 100644
--- a/content/references/translations/en/sound/BandPass_process_.json
+++ b/content/references/translations/en/sound/BandPass_process_.json
@@ -3,7 +3,7 @@
"related": [],
"name": "process()",
"description": "Start applying this bandpass filter to an input signal.",
- "syntax": [".process(input, freq)", ".process(input, freq, bw)"],
+ "syntax": [".process(input, freq, bw)"],
"returns": "void",
"type": "method",
"category": "Effects",
@@ -12,14 +12,18 @@
"parameters": [
{
"name": "input",
- "description": "the sound source to apply the filter to",
+ "description": "the sound source to filter",
"type": ["SoundObject"]
},
{
"name": "freq",
- "description": "Cutoff frequency between 0 and 20000",
+ "description": "the center frequency in Hertz",
"type": ["float"]
},
- { "name": "bw", "description": "Set the bandwidth", "type": ["float"] }
+ {
+ "name": "bw",
+ "description": "the filter bandwidth in Hertz",
+ "type": ["float"]
+ }
]
}
diff --git a/content/references/translations/en/sound/BandPass_res_.json b/content/references/translations/en/sound/BandPass_res_.json
new file mode 100644
index 00000000..a0a2840b
--- /dev/null
+++ b/content/references/translations/en/sound/BandPass_res_.json
@@ -0,0 +1,19 @@
+{
+ "brief": "Sets the resonance (or 'Q factor') of this filter.",
+ "related": [],
+ "name": "res()",
+ "description": "Sets a fixed Q factor for this filter. If you want to specify a fixed \n bandwidth for this bandpass filter (in Hertz) that is maintained even as \n the center frequency of the filter changes, use bw(float)
\n instead.",
+ "syntax": [".res(q)"],
+ "returns": "void",
+ "type": "method",
+ "category": "Effects",
+ "subcategory": "BandPass",
+ "classanchor": "BandPass",
+ "parameters": [
+ {
+ "name": "q",
+ "description": "the desired Q factor, a value between 0.1 and 10",
+ "type": ["float"]
+ }
+ ]
+}
diff --git a/content/references/translations/en/sound/BandPass_set_.json b/content/references/translations/en/sound/BandPass_set_.json
index 00604221..af980d05 100644
--- a/content/references/translations/en/sound/BandPass_set_.json
+++ b/content/references/translations/en/sound/BandPass_set_.json
@@ -10,7 +10,15 @@
"subcategory": "BandPass",
"classanchor": "BandPass",
"parameters": [
- { "name": "freq", "description": "Set the frequency", "type": ["float"] },
- { "name": "bw", "description": "Set the bandwidth", "type": ["float"] }
+ {
+ "name": "freq",
+ "description": "the center frequency in Hertz",
+ "type": ["float"]
+ },
+ {
+ "name": "bw",
+ "description": "the filter bandwidth in Hertz",
+ "type": ["float"]
+ }
]
}
diff --git a/content/references/translations/en/sound/BeatDetector_isBeat_.json b/content/references/translations/en/sound/BeatDetector_isBeat_.json
index b6d11cbb..a6d3a031 100644
--- a/content/references/translations/en/sound/BeatDetector_isBeat_.json
+++ b/content/references/translations/en/sound/BeatDetector_isBeat_.json
@@ -2,7 +2,7 @@
"brief": "Returns whether or not the current moment of audio contains a beat or not.",
"related": [],
"name": "isBeat()",
- "description": "Returns whether or not the current moment of audio contains a beat or not.\n A \"beat\" is defined as a spike in the energy of the audio signal \\u2014 it may\n or may not coincide exactly with a musical beat.",
+ "description": "Returns true
if the current moment of the audio signal \n contains a beat, false
otherwise.
\n A \"beat\" is defined as a spike in the energy of the audio signal - it may\n or may not coincide exactly with a musical beat.",
"syntax": [".isBeat()"],
"returns": "boolean",
"type": "method",
diff --git a/content/references/translations/en/sound/BrownNoise_set_.json b/content/references/translations/en/sound/BrownNoise_set_.json
index 61a33a02..0d6eb267 100644
--- a/content/references/translations/en/sound/BrownNoise_set_.json
+++ b/content/references/translations/en/sound/BrownNoise_set_.json
@@ -3,7 +3,7 @@
"related": [],
"name": "set()",
"description": "Set the amplitude and panoramic position with one method.",
- "syntax": [".set(amp, pos)"],
+ "syntax": [".set(amp, pos)", ".set(amp, add, pos)"],
"returns": "void",
"type": "method",
"category": "Noise",
diff --git a/content/references/translations/en/sound/Env_play_.json b/content/references/translations/en/sound/Env_play_.json
index dba16326..6fe5c1a4 100644
--- a/content/references/translations/en/sound/Env_play_.json
+++ b/content/references/translations/en/sound/Env_play_.json
@@ -27,6 +27,11 @@
"description": "Sustain time value as a float.",
"type": ["float"]
},
+ {
+ "name": "sustainLevel",
+ "description": "Sustain level value as a float. (as fraction of the input amplitude)",
+ "type": ["float"]
+ },
{
"name": "releaseTime",
"description": "Release time value as a float.",
diff --git a/content/references/translations/en/sound/FFT.json b/content/references/translations/en/sound/FFT.json
index ad61e2a0..38e8766f 100644
--- a/content/references/translations/en/sound/FFT.json
+++ b/content/references/translations/en/sound/FFT.json
@@ -4,12 +4,12 @@
{
"anchor": "FFT_analyze_",
"name": "analyze()",
- "desc": "Calculates the current frequency spectrum and returns it as an array with as many elements as frequency bands."
+ "desc": "Calculates the current frequency spectrum of the audio input \n signal."
},
{
"anchor": "FFT_analyzeSample_",
"name": "analyzeSample()",
- "desc": "Calculates the frequency spectrum of the given sample, returning an array of magnitudes."
+ "desc": "Calculates the frequency spectrum of a given audio sample."
},
{
"anchor": "FFT_input_",
@@ -41,7 +41,7 @@
},
{
"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 ...).",
+ "description": "number of frequency bands for the FFT. This parameter needs to \n be a power of 2 (e.g. 16, 32, 64, 128, ...). The default is 512.",
"type": [
"int"
]
diff --git a/content/references/translations/en/sound/FFT_analyzeSample_.json b/content/references/translations/en/sound/FFT_analyzeSample_.json
index 41c64c7f..a0d4f982 100644
--- a/content/references/translations/en/sound/FFT_analyzeSample_.json
+++ b/content/references/translations/en/sound/FFT_analyzeSample_.json
@@ -1,9 +1,12 @@
{
- "brief": "Calculates the frequency spectrum of the given sample, returning an array of magnitudes.",
+ "brief": "Calculates the frequency spectrum of a given audio sample.",
"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)"],
+ "description": "Calculates the frequency spectrum of a given audio sample and returns an \n array of magnitudes, one for each frequency band. The frequency associated \n with each band of the spectrum is frequency = binIndex * sampleRate / \n (2*numBands)
.
\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.
\n\n The values of the resulting array show the amplitudes of pure tone \n components contained in the signal. If the signal is a sine with an \n amplitude of 1, the spectrum will have an absolute value of 1 (0 dB) at the \n frequency of the sine. For complex real-world signals the spectrum values \n will be much lower and usually don't exceed 0.05.",
+ "syntax": [
+ ".analyzeSample(sample, target)",
+ ".analyzeSample(sample, numBands)"
+ ],
"returns": "float[]",
"type": "method",
"category": "Analysis",
@@ -12,13 +15,13 @@
"parameters": [
{
"name": "sample",
- "description": "an array with sound samples",
+ "description": "an array of numbers that describe the waveform to be analyzed",
"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"]
+ "name": "target",
+ "description": "array that the computed spectrum will be written to. The FFT \n will compute as many frequency bands as the length of this array, which \n must be a power of 2 (2, 4, 8, 16 etc.)",
+ "type": ["float[]"]
}
]
}
diff --git a/content/references/translations/en/sound/FFT_analyze_.json b/content/references/translations/en/sound/FFT_analyze_.json
index 62d57e0d..0537826a 100644
--- a/content/references/translations/en/sound/FFT_analyze_.json
+++ b/content/references/translations/en/sound/FFT_analyze_.json
@@ -1,9 +1,9 @@
{
- "brief": "Calculates the current frequency spectrum and returns it as an array with as many elements as frequency bands.",
+ "brief": "Calculates the current frequency spectrum of the audio input \n signal.",
"related": [],
"name": "analyze()",
- "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)"],
+ "description": "Calculates the current frequency spectrum of the input signal.\n Returns an array with as many elements as this FFT analyzer's number of \n frequency bands. The frequency associated with each band of the spectrum is\n frequency = binIndex * sampleRate / (2*numBands)
.
\n\n The values of the resulting array show the amplitudes of pure tone \n components contained in the signal. If the signal is a sine with an \n amplitude of 1, the spectrum will have an absolute value of 1 (0 dB) at the \n frequency of the sine. For complex real-world signals the spectrum values \n will be much lower and usually don't exceed 0.05.",
+ "syntax": [".analyze()", ".analyze(target)"],
"returns": "float[]",
"type": "method",
"category": "Analysis",
@@ -11,8 +11,8 @@
"classanchor": "FFT",
"parameters": [
{
- "name": "value",
- "description": "an array with as many elements as this FFT analyzer's number of\n frequency bands",
+ "name": "target",
+ "description": "if provided, writes the frequency spectrum into the given array.\n The array needs to have as many elements as this FFT analyzer's \n number of frequency bands.",
"type": ["float[]"]
}
]
diff --git a/content/references/translations/en/sound/HighPass.json b/content/references/translations/en/sound/HighPass.json
index 707b051f..f6f26d83 100644
--- a/content/references/translations/en/sound/HighPass.json
+++ b/content/references/translations/en/sound/HighPass.json
@@ -4,12 +4,22 @@
{
"anchor": "HighPass_freq_",
"name": "freq()",
- "desc": "Set the cut off frequency for the filter."
+ "desc": "Sets the cutoff frequency for the filter."
},
{
"anchor": "HighPass_process_",
"name": "process()",
- "desc": "Start applying this highpass filter to an input signal."
+ "desc": "Starts applying this filter to an input signal."
+ },
+ {
+ "anchor": "HighPass_res_",
+ "name": "res()",
+ "desc": "Sets the resonance (or 'Q factor') of this filter. Increasing Q increases \n the resonance of the filter at its cutoff frequency. Defaults to 1."
+ },
+ {
+ "anchor": "HighPass_set_",
+ "name": "set()",
+ "desc": "Sets frequency and bandwidth of the filter with one method."
},
{
"anchor": "HighPass_stop_",
diff --git a/content/references/translations/en/sound/HighPass_freq_.json b/content/references/translations/en/sound/HighPass_freq_.json
index 2a852e0e..9f601cbf 100644
--- a/content/references/translations/en/sound/HighPass_freq_.json
+++ b/content/references/translations/en/sound/HighPass_freq_.json
@@ -1,8 +1,8 @@
{
- "brief": "Set the cut off frequency for the filter.",
+ "brief": "Sets the cutoff frequency for the filter.",
"related": [],
"name": "freq()",
- "description": "Set the cut off frequency for the filter.",
+ "description": "Sets the cutoff frequency for the filter.",
"syntax": [".freq(freq)"],
"returns": "void",
"type": "method",
diff --git a/content/references/translations/en/sound/HighPass_process_.json b/content/references/translations/en/sound/HighPass_process_.json
index cc766245..4ebbab5c 100644
--- a/content/references/translations/en/sound/HighPass_process_.json
+++ b/content/references/translations/en/sound/HighPass_process_.json
@@ -1,9 +1,9 @@
{
- "brief": "Start applying this highpass filter to an input signal.",
+ "brief": "Starts applying this filter to an input signal.",
"related": [],
"name": "process()",
- "description": "Start applying this highpass filter to an input signal.",
- "syntax": [".process(input, freq)"],
+ "description": "Starts applying this filter to an input signal.",
+ "syntax": [".process(input, freq)", ".process(input, freq, q)"],
"returns": "void",
"type": "method",
"category": "Effects",
@@ -12,9 +12,18 @@
"parameters": [
{
"name": "input",
- "description": "the sound source to apply the filter to",
+ "description": "the sound source to filter",
"type": ["SoundObject"]
},
- { "name": "freq", "description": "cutoff frequency", "type": ["float"] }
+ {
+ "name": "freq",
+ "description": "the cutoff frequency in Hertz",
+ "type": ["float"]
+ },
+ {
+ "name": "q",
+ "description": "the resonance (or 'Q factor'), a value between 0.1 and 10",
+ "type": ["float"]
+ }
]
}
diff --git a/content/references/translations/en/sound/HighPass_res_.json b/content/references/translations/en/sound/HighPass_res_.json
new file mode 100644
index 00000000..bfcfce5e
--- /dev/null
+++ b/content/references/translations/en/sound/HighPass_res_.json
@@ -0,0 +1,19 @@
+{
+ "brief": "Sets the resonance (or 'Q factor') of this filter.",
+ "related": [],
+ "name": "res()",
+ "description": "Sets the resonance (or 'Q factor') of this filter. Increasing Q increases \n the resonance of the filter at its cutoff frequency. Defaults to 1.",
+ "syntax": [".res(q)"],
+ "returns": "void",
+ "type": "method",
+ "category": "Effects",
+ "subcategory": "HighPass",
+ "classanchor": "HighPass",
+ "parameters": [
+ {
+ "name": "q",
+ "description": "the desired Q factor, a value between 0.1 and 10",
+ "type": ["float"]
+ }
+ ]
+}
diff --git a/content/references/translations/en/sound/HighPass_set_.json b/content/references/translations/en/sound/HighPass_set_.json
new file mode 100644
index 00000000..c8ce3e7a
--- /dev/null
+++ b/content/references/translations/en/sound/HighPass_set_.json
@@ -0,0 +1,24 @@
+{
+ "brief": "Sets frequency and bandwidth of the filter with one method.",
+ "related": [],
+ "name": "set()",
+ "description": "Sets frequency and bandwidth of the filter with one method.",
+ "syntax": [".set(freq, q)"],
+ "returns": "void",
+ "type": "method",
+ "category": "Effects",
+ "subcategory": "HighPass",
+ "classanchor": "HighPass",
+ "parameters": [
+ {
+ "name": "freq",
+ "description": "the cutoff frequency in Hertz",
+ "type": ["float"]
+ },
+ {
+ "name": "q",
+ "description": "the resonance (or 'Q factor'), a value between 0.1 and 10",
+ "type": ["float"]
+ }
+ ]
+}
diff --git a/content/references/translations/en/sound/LowPass.json b/content/references/translations/en/sound/LowPass.json
index 9352a396..5da83b89 100644
--- a/content/references/translations/en/sound/LowPass.json
+++ b/content/references/translations/en/sound/LowPass.json
@@ -4,12 +4,22 @@
{
"anchor": "LowPass_freq_",
"name": "freq()",
- "desc": "Set the cut off frequency for the filter."
+ "desc": "Sets the cutoff frequency for the filter."
},
{
"anchor": "LowPass_process_",
"name": "process()",
- "desc": "Start applying this highpass filter to an input signal."
+ "desc": "Starts applying this filter to an input signal."
+ },
+ {
+ "anchor": "LowPass_res_",
+ "name": "res()",
+ "desc": "Sets the resonance (or 'Q factor') of this filter. Increasing Q increases \n the resonance of the filter at its cutoff frequency. Defaults to 1."
+ },
+ {
+ "anchor": "LowPass_set_",
+ "name": "set()",
+ "desc": "Sets frequency and bandwidth of the filter with one method."
},
{
"anchor": "LowPass_stop_",
diff --git a/content/references/translations/en/sound/LowPass_freq_.json b/content/references/translations/en/sound/LowPass_freq_.json
index 1607e7c0..94285d6d 100644
--- a/content/references/translations/en/sound/LowPass_freq_.json
+++ b/content/references/translations/en/sound/LowPass_freq_.json
@@ -1,8 +1,8 @@
{
- "brief": "Set the cut off frequency for the filter.",
+ "brief": "Sets the cutoff frequency for the filter.",
"related": [],
"name": "freq()",
- "description": "Set the cut off frequency for the filter.",
+ "description": "Sets the cutoff frequency for the filter.",
"syntax": [".freq(freq)"],
"returns": "void",
"type": "method",
diff --git a/content/references/translations/en/sound/LowPass_process_.json b/content/references/translations/en/sound/LowPass_process_.json
index eea883d6..7d43861b 100644
--- a/content/references/translations/en/sound/LowPass_process_.json
+++ b/content/references/translations/en/sound/LowPass_process_.json
@@ -1,9 +1,9 @@
{
- "brief": "Start applying this highpass filter to an input signal.",
+ "brief": "Starts applying this filter to an input signal.",
"related": [],
"name": "process()",
- "description": "Start applying this highpass filter to an input signal.",
- "syntax": [".process(input, freq)"],
+ "description": "Starts applying this filter to an input signal.",
+ "syntax": [".process(input, freq)", ".process(input, freq, q)"],
"returns": "void",
"type": "method",
"category": "Effects",
@@ -12,9 +12,18 @@
"parameters": [
{
"name": "input",
- "description": "the sound source to apply the filter to",
+ "description": "the sound source to filter",
"type": ["SoundObject"]
},
- { "name": "freq", "description": "cutoff frequency", "type": ["float"] }
+ {
+ "name": "freq",
+ "description": "the cutoff frequency in Hertz",
+ "type": ["float"]
+ },
+ {
+ "name": "q",
+ "description": "the resonance (or 'Q factor'), a value between 0.1 and 10",
+ "type": ["float"]
+ }
]
}
diff --git a/content/references/translations/en/sound/LowPass_res_.json b/content/references/translations/en/sound/LowPass_res_.json
new file mode 100644
index 00000000..75b16e6f
--- /dev/null
+++ b/content/references/translations/en/sound/LowPass_res_.json
@@ -0,0 +1,19 @@
+{
+ "brief": "Sets the resonance (or 'Q factor') of this filter.",
+ "related": [],
+ "name": "res()",
+ "description": "Sets the resonance (or 'Q factor') of this filter. Increasing Q increases \n the resonance of the filter at its cutoff frequency. Defaults to 1.",
+ "syntax": [".res(q)"],
+ "returns": "void",
+ "type": "method",
+ "category": "Effects",
+ "subcategory": "LowPass",
+ "classanchor": "LowPass",
+ "parameters": [
+ {
+ "name": "q",
+ "description": "the desired Q factor, a value between 0.1 and 10",
+ "type": ["float"]
+ }
+ ]
+}
diff --git a/content/references/translations/en/sound/LowPass_set_.json b/content/references/translations/en/sound/LowPass_set_.json
new file mode 100644
index 00000000..92e22675
--- /dev/null
+++ b/content/references/translations/en/sound/LowPass_set_.json
@@ -0,0 +1,24 @@
+{
+ "brief": "Sets frequency and bandwidth of the filter with one method.",
+ "related": [],
+ "name": "set()",
+ "description": "Sets frequency and bandwidth of the filter with one method.",
+ "syntax": [".set(freq, q)"],
+ "returns": "void",
+ "type": "method",
+ "category": "Effects",
+ "subcategory": "LowPass",
+ "classanchor": "LowPass",
+ "parameters": [
+ {
+ "name": "freq",
+ "description": "the cutoff frequency in Hertz",
+ "type": ["float"]
+ },
+ {
+ "name": "q",
+ "description": "the resonance (or 'Q factor'), a value between 0.1 and 10",
+ "type": ["float"]
+ }
+ ]
+}
diff --git a/content/references/translations/en/sound/MultiChannel.json b/content/references/translations/en/sound/MultiChannel.json
new file mode 100644
index 00000000..2422247d
--- /dev/null
+++ b/content/references/translations/en/sound/MultiChannel.json
@@ -0,0 +1,32 @@
+{
+ "brief": "Controls the routing of sounds on multi-channel devices",
+ "methods": [
+ {
+ "anchor": "MultiChannel_activeChannel_",
+ "name": "activeChannel()",
+ "desc": "Controls which output channel sounds will be played back to.\n\n After selecting a new output channel, all sounds that start `play()`ing \n will be sent to that channel."
+ },
+ {
+ "anchor": "MultiChannel_availableChannels_",
+ "name": "availableChannels()",
+ "desc": "Gets the number of output channels available on an output device"
+ },
+ {
+ "anchor": "MultiChannel_usePortAudio_",
+ "name": "usePortAudio()",
+ "desc": "Force using PortAudio instead of JavaSound."
+ }
+ ],
+ "csspath": "../../",
+ "isLibrary": "true",
+ "classFields": [],
+ "description": "Controls the routing of sounds on multi-channel devices",
+ "type": "class",
+ "constructors": ["MultiChannel()"],
+ "related": [],
+ "name": "MultiChannel",
+ "classanchor": "sound/MultiChannel",
+ "category": "I/O",
+ "subcategory": "MultiChannel",
+ "parameters": []
+}
diff --git a/content/references/translations/en/sound/MultiChannel_activeChannel_.json b/content/references/translations/en/sound/MultiChannel_activeChannel_.json
new file mode 100644
index 00000000..7fcd927f
--- /dev/null
+++ b/content/references/translations/en/sound/MultiChannel_activeChannel_.json
@@ -0,0 +1,19 @@
+{
+ "brief": "Controls which output channel sounds will be played back to.\n\n After selecting a new output channel, all sounds that start `play()`ing \n will be sent to that channel.",
+ "related": ["sound/MultiChannel_availableChannels_"],
+ "name": "activeChannel()",
+ "description": "Controls which output channel sounds will be played back to.\n\n After selecting a new output channel, all sounds that start `play()`ing \n will be sent to that channel.",
+ "syntax": [".activeChannel(channel)", ".activeChannel()"],
+ "returns": "int",
+ "type": "method",
+ "category": "I/O",
+ "subcategory": "MultiChannel",
+ "classanchor": "MultiChannel",
+ "parameters": [
+ {
+ "name": "channel",
+ "description": "the channel number to send sounds to",
+ "type": ["int"]
+ }
+ ]
+}
diff --git a/content/references/translations/en/sound/MultiChannel_availableChannels_.json b/content/references/translations/en/sound/MultiChannel_availableChannels_.json
new file mode 100644
index 00000000..28245743
--- /dev/null
+++ b/content/references/translations/en/sound/MultiChannel_availableChannels_.json
@@ -0,0 +1,19 @@
+{
+ "brief": "Gets the number of output channels available on an output device",
+ "related": ["sound/Sound_outputDevice_"],
+ "name": "availableChannels()",
+ "description": "Gets the number of output channels available on an output device",
+ "syntax": [".availableChannels(deviceId)", ".availableChannels()"],
+ "returns": "int",
+ "type": "method",
+ "category": "I/O",
+ "subcategory": "MultiChannel",
+ "classanchor": "MultiChannel",
+ "parameters": [
+ {
+ "name": "deviceId",
+ "description": "if none is given, gets information about the current device.",
+ "type": ["int"]
+ }
+ ]
+}
diff --git a/content/references/translations/en/sound/MultiChannel_usePortAudio_.json b/content/references/translations/en/sound/MultiChannel_usePortAudio_.json
new file mode 100644
index 00000000..217366a6
--- /dev/null
+++ b/content/references/translations/en/sound/MultiChannel_usePortAudio_.json
@@ -0,0 +1,13 @@
+{
+ "brief": "Force using PortAudio instead of JavaSound.",
+ "related": ["sound/Sound_list_"],
+ "name": "usePortAudio()",
+ "description": "Force using PortAudio instead of JavaSound.\n\n Support for 24 bit audio interfaces on Windows requires using the native\n PortAudio bindings instead of the default JavaSound one. The Sound library \n will automatically check for and load PortAudio when it is necessary to do \n so. However, when Sound.list()
is called before selecting an \n output device, it might show an incorrect number of channels for \n multi-channel interfaces. By explicitly loading PortAudio ahead of time you \n can ensure that Sound.list()
will show accurate channel \n numbers from the start.\n\n Returns true
if PortAudio was successfully loaded.",
+ "syntax": [".usePortAudio()"],
+ "returns": "boolean",
+ "type": "method",
+ "category": "I/O",
+ "subcategory": "MultiChannel",
+ "classanchor": "MultiChannel",
+ "parameters": []
+}
diff --git a/content/references/translations/en/sound/PinkNoise_set_.json b/content/references/translations/en/sound/PinkNoise_set_.json
index 0b70c142..0e3a1f35 100644
--- a/content/references/translations/en/sound/PinkNoise_set_.json
+++ b/content/references/translations/en/sound/PinkNoise_set_.json
@@ -3,7 +3,7 @@
"related": [],
"name": "set()",
"description": "Set the amplitude and panoramic position with one method.",
- "syntax": [".set(amp, pos)"],
+ "syntax": [".set(amp, pos)", ".set(amp, add, pos)"],
"returns": "void",
"type": "method",
"category": "Noise",
diff --git a/content/references/translations/en/sound/PitchDetector.json b/content/references/translations/en/sound/PitchDetector.json
new file mode 100644
index 00000000..4fa49667
--- /dev/null
+++ b/content/references/translations/en/sound/PitchDetector.json
@@ -0,0 +1,45 @@
+{
+ "brief": "Detects the fundamental frequency of a sound signal",
+ "methods": [
+ {
+ "anchor": "PitchDetector_analyze_",
+ "name": "analyze()",
+ "desc": "Detect the fundamental frequency of the input sound signal."
+ },
+ {
+ "anchor": "PitchDetector_input_",
+ "name": "input()",
+ "desc": "Define the audio input for the analyzer."
+ }
+ ],
+ "csspath": "../../",
+ "isLibrary": "true",
+ "classFields": [],
+ "description": "Detects the pitch (also known as the 'fundamental frequency') of a sound \n signal. For complex signals this is not a trivial task, so the analyzer only \n returns a frequency measurement (measured in Hertz) when its measurement \n exceeds a 'confidence level' that can be specified by the user.",
+ "type": "class",
+ "constructors": [
+ "PitchDetector(parent, minimumConfidence)",
+ "PitchDetector(parent)"
+ ],
+ "related": [],
+ "name": "PitchDetector",
+ "classanchor": "sound/PitchDetector",
+ "category": "Analysis",
+ "subcategory": "PitchDetector",
+ "parameters": [
+ {
+ "name": "parent",
+ "description": "typically \"this\"",
+ "type": [
+ "PApplet"
+ ]
+ },
+ {
+ "name": "minimumConfidence",
+ "description": "the minimum confidence level required for \n frequency measurements, between 0 (accept all measurements, no matter how \n unreliable) to 1 (only accept perfect measurements). Defaults to 0.8.",
+ "type": [
+ "float"
+ ]
+ }
+ ]
+}
diff --git a/content/references/translations/en/sound/PitchDetector_analyze_.json b/content/references/translations/en/sound/PitchDetector_analyze_.json
new file mode 100644
index 00000000..44465aee
--- /dev/null
+++ b/content/references/translations/en/sound/PitchDetector_analyze_.json
@@ -0,0 +1,19 @@
+{
+ "brief": "Detect the fundamental frequency of the input sound signal.",
+ "related": [],
+ "name": "analyze()",
+ "description": "Returns an estimate of the current pitch (or 'fundamental frequency') of \n the input sound signal, in Hertz. If the confidence in the current \n measurement does not exceed the minimum confidence, this method returns 0.",
+ "syntax": [".analyze()", ".analyze(minimumConfidence)", ".analyze(target)"],
+ "returns": "float",
+ "type": "method",
+ "category": "Analysis",
+ "subcategory": "PitchDetector",
+ "classanchor": "PitchDetector",
+ "parameters": [
+ {
+ "name": "minimumConfidence",
+ "description": "the minimum confidence level required for \n frequency measurements, between 0 (accept all measurements, no matter how \n unreliable) to 1 (only accept perfect measurements). If omitted, uses the \n confidence level specified when this PitchDetector was created.",
+ "type": ["float"]
+ }
+ ]
+}
diff --git a/content/references/translations/en/sound/PitchDetector_input_.json b/content/references/translations/en/sound/PitchDetector_input_.json
new file mode 100644
index 00000000..100c14aa
--- /dev/null
+++ b/content/references/translations/en/sound/PitchDetector_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": "PitchDetector",
+ "classanchor": "PitchDetector",
+ "parameters": [
+ {
+ "name": "input",
+ "description": "The input sound source",
+ "type": ["SoundObject"]
+ }
+ ]
+}
diff --git a/content/references/translations/en/sound/Pulse.json b/content/references/translations/en/sound/Pulse.json
index 693df327..4c86ff33 100644
--- a/content/references/translations/en/sound/Pulse.json
+++ b/content/references/translations/en/sound/Pulse.json
@@ -9,7 +9,7 @@
{
"anchor": "Pulse_freq_",
"name": "freq()",
- "desc": "Set the frequency of the oscillator in Hz."
+ "desc": "Sets the frequency of the oscillator."
},
{
"anchor": "Pulse_pan_",
diff --git a/content/references/translations/en/sound/Pulse_freq_.json b/content/references/translations/en/sound/Pulse_freq_.json
index aa295258..81b0c97b 100644
--- a/content/references/translations/en/sound/Pulse_freq_.json
+++ b/content/references/translations/en/sound/Pulse_freq_.json
@@ -1,9 +1,9 @@
{
- "brief": "Set the frequency of the oscillator in Hz.",
+ "brief": "Sets the frequency of the oscillator.",
"related": [],
"name": "freq()",
- "description": "Set the frequency of the oscillator in Hz.",
- "syntax": [".freq(freq)"],
+ "description": "Sets the frequency of the oscillator.",
+ "syntax": [".freq(freq)", ".freq(modulator)"],
"returns": "void",
"type": "method",
"category": "Oscillators",
@@ -12,7 +12,7 @@
"parameters": [
{
"name": "freq",
- "description": "A floating point value of the oscillator in Hz.",
+ "description": "the desired oscillator frequency in Hertz",
"type": ["float"]
}
]
diff --git a/content/references/translations/en/sound/Pulse_play_.json b/content/references/translations/en/sound/Pulse_play_.json
index 46078b5e..9b59b156 100644
--- a/content/references/translations/en/sound/Pulse_play_.json
+++ b/content/references/translations/en/sound/Pulse_play_.json
@@ -3,12 +3,7 @@
"related": [],
"name": "play()",
"description": "Starts the oscillator",
- "syntax": [
- ".play()",
- ".play(freq, amp)",
- ".play(freq, amp, add)",
- ".play(freq, amp, add, pos)"
- ],
+ "syntax": [".play()", ".play(freq, amp)", ".play(freq, amp, add, pos)"],
"returns": "void",
"type": "method",
"category": "Oscillators",
diff --git a/content/references/translations/en/sound/Reverb.json b/content/references/translations/en/sound/Reverb.json
index 5dc08b27..3a625797 100644
--- a/content/references/translations/en/sound/Reverb.json
+++ b/content/references/translations/en/sound/Reverb.json
@@ -45,5 +45,13 @@
"classanchor": "sound/Reverb",
"category": "Effects",
"subcategory": "Reverb",
- "parameters": []
+ "parameters": [
+ {
+ "name": "parent",
+ "description": "PApplet: typically use \"this\"",
+ "type": [
+ "PApplet"
+ ]
+ }
+ ]
}
diff --git a/content/references/translations/en/sound/SawOsc.json b/content/references/translations/en/sound/SawOsc.json
index 58a053f8..560c653a 100644
--- a/content/references/translations/en/sound/SawOsc.json
+++ b/content/references/translations/en/sound/SawOsc.json
@@ -9,7 +9,7 @@
{
"anchor": "SawOsc_freq_",
"name": "freq()",
- "desc": "Set the frequency of the oscillator in Hz."
+ "desc": "Sets the frequency of the oscillator."
},
{
"anchor": "SawOsc_pan_",
diff --git a/content/references/translations/en/sound/SawOsc_freq_.json b/content/references/translations/en/sound/SawOsc_freq_.json
index 6c90ef5d..23cacfe0 100644
--- a/content/references/translations/en/sound/SawOsc_freq_.json
+++ b/content/references/translations/en/sound/SawOsc_freq_.json
@@ -1,9 +1,9 @@
{
- "brief": "Set the frequency of the oscillator in Hz.",
+ "brief": "Sets the frequency of the oscillator.",
"related": [],
"name": "freq()",
- "description": "Set the frequency of the oscillator in Hz.",
- "syntax": [".freq(freq)"],
+ "description": "Sets the frequency of the oscillator.",
+ "syntax": [".freq(freq)", ".freq(modulator)"],
"returns": "void",
"type": "method",
"category": "Oscillators",
@@ -12,7 +12,7 @@
"parameters": [
{
"name": "freq",
- "description": "A floating point value of the oscillator in Hz.",
+ "description": "the desired oscillator frequency in Hertz",
"type": ["float"]
}
]
diff --git a/content/references/translations/en/sound/SawOsc_play_.json b/content/references/translations/en/sound/SawOsc_play_.json
index 973af5aa..e3d85400 100644
--- a/content/references/translations/en/sound/SawOsc_play_.json
+++ b/content/references/translations/en/sound/SawOsc_play_.json
@@ -3,12 +3,7 @@
"related": [],
"name": "play()",
"description": "Starts the oscillator",
- "syntax": [
- ".play()",
- ".play(freq, amp)",
- ".play(freq, amp, add)",
- ".play(freq, amp, add, pos)"
- ],
+ "syntax": [".play()", ".play(freq, amp)", ".play(freq, amp, add, pos)"],
"returns": "void",
"type": "method",
"category": "Oscillators",
diff --git a/content/references/translations/en/sound/SinOsc.json b/content/references/translations/en/sound/SinOsc.json
index 20c0ad67..c7cbc685 100644
--- a/content/references/translations/en/sound/SinOsc.json
+++ b/content/references/translations/en/sound/SinOsc.json
@@ -9,7 +9,7 @@
{
"anchor": "SinOsc_freq_",
"name": "freq()",
- "desc": "Set the frequency of the oscillator in Hz."
+ "desc": "Sets the frequency of the oscillator."
},
{
"anchor": "SinOsc_pan_",
diff --git a/content/references/translations/en/sound/SinOsc_freq_.json b/content/references/translations/en/sound/SinOsc_freq_.json
index ef45095f..bbfc3392 100644
--- a/content/references/translations/en/sound/SinOsc_freq_.json
+++ b/content/references/translations/en/sound/SinOsc_freq_.json
@@ -1,9 +1,9 @@
{
- "brief": "Set the frequency of the oscillator in Hz.",
+ "brief": "Sets the frequency of the oscillator.",
"related": [],
"name": "freq()",
- "description": "Set the frequency of the oscillator in Hz.",
- "syntax": [".freq(freq)"],
+ "description": "Sets the frequency of the oscillator.",
+ "syntax": [".freq(freq)", ".freq(modulator)"],
"returns": "void",
"type": "method",
"category": "Oscillators",
@@ -12,7 +12,7 @@
"parameters": [
{
"name": "freq",
- "description": "A floating point value of the oscillator in Hz.",
+ "description": "the desired oscillator frequency in Hertz",
"type": ["float"]
}
]
diff --git a/content/references/translations/en/sound/SinOsc_play_.json b/content/references/translations/en/sound/SinOsc_play_.json
index 1167a180..c0989a20 100644
--- a/content/references/translations/en/sound/SinOsc_play_.json
+++ b/content/references/translations/en/sound/SinOsc_play_.json
@@ -3,12 +3,7 @@
"related": [],
"name": "play()",
"description": "Starts the oscillator",
- "syntax": [
- ".play()",
- ".play(freq, amp)",
- ".play(freq, amp, add)",
- ".play(freq, amp, add, pos)"
- ],
+ "syntax": [".play()", ".play(freq, amp)", ".play(freq, amp, add, pos)"],
"returns": "void",
"type": "method",
"category": "Oscillators",
diff --git a/content/references/translations/en/sound/Sound.json b/content/references/translations/en/sound/Sound.json
index 52cfdd41..9fc567a7 100644
--- a/content/references/translations/en/sound/Sound.json
+++ b/content/references/translations/en/sound/Sound.json
@@ -4,7 +4,7 @@
{
"anchor": "Sound_list_",
"name": "list()",
- "desc": "Print and return information on available audio devices and their number of input/output channels."
+ "desc": "Shows information about available audio devices"
},
{
"anchor": "Sound_sampleRate_",
@@ -25,6 +25,11 @@
"anchor": "Sound_volume_",
"name": "volume()",
"desc": "Set the overall output volume of the Processing sound library."
+ },
+ {
+ "anchor": "Sound_status_",
+ "name": "status()",
+ "desc": "Prints information about the sound library's current memory and \n CPU usage"
}
],
"csspath": "../../",
@@ -36,7 +41,7 @@
"Sound(parent)",
"Sound(parent, sampleRate, outputDevice, inputDevice, volume)"
],
- "related": [],
+ "related": ["sound/MultiChannel"],
"name": "Sound",
"classanchor": "sound/Sound",
"category": "Configuration",
diff --git a/content/references/translations/en/sound/SoundFile_stop_.json b/content/references/translations/en/sound/SoundFile_stop_.json
deleted file mode 100644
index 04e44729..00000000
--- a/content/references/translations/en/sound/SoundFile_stop_.json
+++ /dev/null
@@ -1,13 +0,0 @@
-{
- "brief": "Stops the playback, and sets the cue back to the start of the sample.",
- "related": [],
- "name": "stop()",
- "description": "Stops the playback, and sets the cue back to the start of the sample.",
- "syntax": [".stop()"],
- "returns": "void",
- "type": "method",
- "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 1645bf2f..2a4f631f 100644
--- a/content/references/translations/en/sound/Sound_inputDevice_.json
+++ b/content/references/translations/en/sound/Sound_inputDevice_.json
@@ -1,10 +1,10 @@
{
"brief": "Choose the device (sound card) which should be used for grabbing audio input using AudioIn.",
- "related": [],
+ "related": ["sound/Sound_list_"],
"name": "inputDevice()",
"description": "Choose the device (sound card) which should be used for grabbing audio input\n using AudioIn. Note that this setting affects the choice of sound card, which \n is not necessarily the same as the number of the input channel. If your sound \n card has more than one input channel, you can specify which channel to use in\n the constructor of the AudioIn class.",
- "syntax": [".inputDevice(deviceId)"],
- "returns": "void",
+ "syntax": [".inputDevice(deviceId)", ".inputDevice(deviceName)"],
+ "returns": "int",
"type": "method",
"category": "Configuration",
"subcategory": "Sound",
diff --git a/content/references/translations/en/sound/Sound_list_.json b/content/references/translations/en/sound/Sound_list_.json
index 3116b6bb..c4c7605c 100644
--- a/content/references/translations/en/sound/Sound_list_.json
+++ b/content/references/translations/en/sound/Sound_list_.json
@@ -1,13 +1,19 @@
{
- "brief": "Print and return information on available audio devices and their number of input/output channels.",
+ "brief": "Shows information about available audio devices",
"related": [],
"name": "list()",
"description": "Print and return information on available audio devices and their number of\n input/output channels.\n Under normal circumstances you will not want to call Sound.list() in \n your actual sketch code, but only for testing to figure out which sound cards \n are available on a new system and how to select them. However, if the order \n of devices on your system is prone to fluctuate from reboot to reboot, you \n can also use the device name array returned by the function to automate device \n selection by name in your own code.",
- "syntax": [".list()"],
+ "syntax": [".list(filter)", ".list()", ".list(printAll)"],
"returns": "String[]",
"type": "method",
"category": "Configuration",
"subcategory": "Sound",
"classanchor": "Sound",
- "parameters": []
+ "parameters": [
+ {
+ "name": "filter",
+ "description": "only list audio devices whose device name contains this \n string",
+ "type": ["String"]
+ }
+ ]
}
diff --git a/content/references/translations/en/sound/Sound_outputDevice_.json b/content/references/translations/en/sound/Sound_outputDevice_.json
index 8aa41491..a77f45a9 100644
--- a/content/references/translations/en/sound/Sound_outputDevice_.json
+++ b/content/references/translations/en/sound/Sound_outputDevice_.json
@@ -1,10 +1,10 @@
{
"brief": "Choose the device (sound card) which the Sound library's audio output should be sent to.",
- "related": [],
+ "related": ["sound/Sound_list_"],
"name": "outputDevice()",
"description": "Choose the device (sound card) which the Sound library's audio output should\n be sent to. The output device should support stereo output (2 channels).",
- "syntax": [".outputDevice(deviceId)"],
- "returns": "void",
+ "syntax": [".outputDevice(deviceId)", ".outputDevice(deviceName)"],
+ "returns": "int",
"type": "method",
"category": "Configuration",
"subcategory": "Sound",
@@ -12,7 +12,7 @@
"parameters": [
{
"name": "deviceId",
- "description": "the device id obtained from list()",
+ "description": "the device id obtained from Sound.list()",
"type": ["int"]
}
]
diff --git a/content/references/translations/en/sound/Sound_status_.json b/content/references/translations/en/sound/Sound_status_.json
new file mode 100644
index 00000000..a14ae434
--- /dev/null
+++ b/content/references/translations/en/sound/Sound_status_.json
@@ -0,0 +1,13 @@
+{
+ "brief": "Prints information about the sound library's current memory and \n CPU usage",
+ "related": [],
+ "name": "status()",
+ "description": "Prints information about the sound library's current memory and CPU usage \n to the console.",
+ "syntax": [".status()"],
+ "returns": "void",
+ "type": "method",
+ "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 0dd083b9..7bc67fd3 100644
--- a/content/references/translations/en/sound/SqrOsc.json
+++ b/content/references/translations/en/sound/SqrOsc.json
@@ -9,7 +9,7 @@
{
"anchor": "SqrOsc_freq_",
"name": "freq()",
- "desc": "Set the frequency of the oscillator in Hz."
+ "desc": "Sets the frequency of the oscillator."
},
{
"anchor": "SqrOsc_pan_",
diff --git a/content/references/translations/en/sound/SqrOsc_freq_.json b/content/references/translations/en/sound/SqrOsc_freq_.json
index f4db0abf..d5fb52d0 100644
--- a/content/references/translations/en/sound/SqrOsc_freq_.json
+++ b/content/references/translations/en/sound/SqrOsc_freq_.json
@@ -1,9 +1,9 @@
{
- "brief": "Set the frequency of the oscillator in Hz.",
+ "brief": "Sets the frequency of the oscillator.",
"related": [],
"name": "freq()",
- "description": "Set the frequency of the oscillator in Hz.",
- "syntax": [".freq(freq)"],
+ "description": "Sets the frequency of the oscillator.",
+ "syntax": [".freq(freq)", ".freq(modulator)"],
"returns": "void",
"type": "method",
"category": "Oscillators",
@@ -12,7 +12,7 @@
"parameters": [
{
"name": "freq",
- "description": "A floating point value of the oscillator in Hz.",
+ "description": "the desired oscillator frequency in Hertz",
"type": ["float"]
}
]
diff --git a/content/references/translations/en/sound/SqrOsc_play_.json b/content/references/translations/en/sound/SqrOsc_play_.json
index d09f670f..9add5307 100644
--- a/content/references/translations/en/sound/SqrOsc_play_.json
+++ b/content/references/translations/en/sound/SqrOsc_play_.json
@@ -3,12 +3,7 @@
"related": [],
"name": "play()",
"description": "Starts the oscillator",
- "syntax": [
- ".play()",
- ".play(freq, amp)",
- ".play(freq, amp, add)",
- ".play(freq, amp, add, pos)"
- ],
+ "syntax": [".play()", ".play(freq, amp)", ".play(freq, amp, add, pos)"],
"returns": "void",
"type": "method",
"category": "Oscillators",
diff --git a/content/references/translations/en/sound/TriOsc.json b/content/references/translations/en/sound/TriOsc.json
index afb45a0d..8b2e7349 100644
--- a/content/references/translations/en/sound/TriOsc.json
+++ b/content/references/translations/en/sound/TriOsc.json
@@ -9,7 +9,7 @@
{
"anchor": "TriOsc_freq_",
"name": "freq()",
- "desc": "Set the frequency of the oscillator in Hz."
+ "desc": "Sets the frequency of the oscillator."
},
{
"anchor": "TriOsc_pan_",
diff --git a/content/references/translations/en/sound/TriOsc_freq_.json b/content/references/translations/en/sound/TriOsc_freq_.json
index f182e39f..db023b96 100644
--- a/content/references/translations/en/sound/TriOsc_freq_.json
+++ b/content/references/translations/en/sound/TriOsc_freq_.json
@@ -1,9 +1,9 @@
{
- "brief": "Set the frequency of the oscillator in Hz.",
+ "brief": "Sets the frequency of the oscillator.",
"related": [],
"name": "freq()",
- "description": "Set the frequency of the oscillator in Hz.",
- "syntax": [".freq(freq)"],
+ "description": "Sets the frequency of the oscillator.",
+ "syntax": [".freq(freq)", ".freq(modulator)"],
"returns": "void",
"type": "method",
"category": "Oscillators",
@@ -12,7 +12,7 @@
"parameters": [
{
"name": "freq",
- "description": "A floating point value of the oscillator in Hz.",
+ "description": "the desired oscillator frequency in Hertz",
"type": ["float"]
}
]
diff --git a/content/references/translations/en/sound/TriOsc_play_.json b/content/references/translations/en/sound/TriOsc_play_.json
index 0e9facc1..cf59b1bb 100644
--- a/content/references/translations/en/sound/TriOsc_play_.json
+++ b/content/references/translations/en/sound/TriOsc_play_.json
@@ -3,12 +3,7 @@
"related": [],
"name": "play()",
"description": "Starts the oscillator",
- "syntax": [
- ".play()",
- ".play(freq, amp)",
- ".play(freq, amp, add)",
- ".play(freq, amp, add, pos)"
- ],
+ "syntax": [".play()", ".play(freq, amp)", ".play(freq, amp, add, pos)"],
"returns": "void",
"type": "method",
"category": "Oscillators",
diff --git a/content/references/translations/en/sound/Waveform.json b/content/references/translations/en/sound/Waveform.json
index d9fc6611..52209d90 100644
--- a/content/references/translations/en/sound/Waveform.json
+++ b/content/references/translations/en/sound/Waveform.json
@@ -1,5 +1,5 @@
{
- "brief": "This is a Waveform analyzer.",
+ "brief": "Inspects the underlying soundwave of an audio signal.",
"methods": [
{
"anchor": "Waveform_analyze_",
@@ -15,7 +15,7 @@
"csspath": "../../",
"isLibrary": "true",
"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.",
+ "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.
\n Note that by default all sound generators (including microphone capture from\n AudioIn
) have an amplitude of 1, which means that the values of \n their waveform will be numbers in the range [-0.5, 0.5]
.",
"type": "class",
"constructors": [
"Waveform(parent, nsamples)"
diff --git a/content/references/translations/en/sound/WhiteNoise_set_.json b/content/references/translations/en/sound/WhiteNoise_set_.json
index cddc09be..dda2a387 100644
--- a/content/references/translations/en/sound/WhiteNoise_set_.json
+++ b/content/references/translations/en/sound/WhiteNoise_set_.json
@@ -3,7 +3,7 @@
"related": [],
"name": "set()",
"description": "Set the amplitude and panoramic position with one method.",
- "syntax": [".set(amp, pos)"],
+ "syntax": [".set(amp, pos)", ".set(amp, add, pos)"],
"returns": "void",
"type": "method",
"category": "Noise",