Skip to content

Commit f527d17

Browse files
SableRafSableRaf
committed
Generated files from updated build script (processing-doclet)
These files were created by running the `processingrefBuild.sh` script as updated by Kevin in processing/processing-doclet#5
1 parent 34c7890 commit f527d17

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+566
-159
lines changed

‎content/references/translations/en/sound/AllPass.json

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"brief": "Outputs all input frequencies at the same amplitude but changes \n their phase relationship.",
3+
"methods": [
4+
{
5+
"anchor": "AllPass_gain_",
6+
"name": "gain()",
7+
"desc": "Sets the gain for the filter."
8+
},
9+
{
10+
"anchor": "AllPass_process_",
11+
"name": "process()",
12+
"desc": "Start the effect."
13+
},
14+
{
15+
"anchor": "AllPass_stop_",
16+
"name": "stop()",
17+
"desc": "Stop the effect."
18+
}
19+
],
20+
"csspath": "../../",
21+
"isLibrary": "true",
22+
"classFields": [],
23+
"description": "This is an all pass filter. For signals processed, all frequencies hold the \n same amplitude but have their phase relationship modified using a delayline \n of one sample,<br/>\n <br/>\n <code>y(k) = -z * x(k) + x(k - 1) + z * y(k - 1)</code><br/>\n <br/>\n where <code>y</code> is the output, <code>x</code> is the input, \n <code>z</code> is the gain coefficient, and <code>k</code> is the signal.",
24+
"type": "class",
25+
"constructors": [
26+
"AllPass(parent)"
27+
],
28+
"related": [],
29+
"name": "AllPass",
30+
"classanchor": "sound/AllPass",
31+
"category": "Effects",
32+
"subcategory": "AllPass",
33+
"parameters": []
34+
}

‎content/references/translations/en/sound/AllPass_gain_.json

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"brief": "Sets the gain for the filter.",
3+
"related": [],
4+
"name": "gain()",
5+
"description": "Sets the gain for the filter in the range 0.0 - 1.0, where larger values \n increase phase displacement.",
6+
"syntax": [".gain(g)"],
7+
"returns": "void",
8+
"type": "method",
9+
"category": "Effects",
10+
"subcategory": "AllPass",
11+
"classanchor": "AllPass",
12+
"parameters": [
13+
{
14+
"name": "g",
15+
"description": "phase displacement in the range 0.0 - 1.0",
16+
"type": ["float"]
17+
}
18+
]
19+
}

‎content/references/translations/en/sound/AllPass_process_.json

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"brief": "Start the effect.",
3+
"related": [],
4+
"name": "process()",
5+
"description": "Start the effect.",
6+
"syntax": [".process(input)"],
7+
"returns": "void",
8+
"type": "method",
9+
"category": "Effects",
10+
"subcategory": "AllPass",
11+
"classanchor": "AllPass",
12+
"parameters": [
13+
{
14+
"name": "input",
15+
"description": "Input sound source",
16+
"type": ["SoundObject"]
17+
}
18+
]
19+
}

‎content/references/translations/en/sound/AllPass_stop_.json

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"brief": "Stop the effect.",
3+
"related": [],
4+
"name": "stop()",
5+
"description": "Stop the effect.",
6+
"syntax": [".stop()"],
7+
"returns": "void",
8+
"type": "method",
9+
"category": "Effects",
10+
"subcategory": "AllPass",
11+
"classanchor": "AllPass",
12+
"parameters": []
13+
}

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

+4-9
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
{
3535
"anchor": "AudioSample_jump_",
3636
"name": "jump()",
37-
"desc": "Jump to a specific position in the audiosample while continuing to play (or starting to play if it wasn't playing already)."
37+
"desc": "Jumps to a specific position in the audio sample."
3838
},
3939
{
4040
"anchor": "AudioSample_jumpFrame_",
@@ -84,7 +84,7 @@
8484
{
8585
"anchor": "AudioSample_stop_",
8686
"name": "stop()",
87-
"desc": "Stops the playback, and sets the cue back to the start of the sample."
87+
"desc": "Stops the playback."
8888
},
8989
{
9090
"anchor": "AudioSample_position_",
@@ -120,7 +120,7 @@
120120
"csspath": "../../",
121121
"isLibrary": "true",
122122
"classFields": [],
123-
"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.",
123+
"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.",
124124
"type": "class",
125125
"constructors": [
126126
"AudioSample(parent, frames)",
@@ -150,18 +150,13 @@
150150
},
151151
{
152152
"name": "stereo",
153-
"description": "whether to treat the audiosample as 2-channel (stereo) or not\n (default: false)",
153+
"description": "whether to treat the audiosample as 2-channel (stereo) or not\n (default: ,<code>,false,</code>,)",
154154
"type": ["boolean"]
155155
},
156156
{
157157
"name": "frameRate",
158158
"description": "the underlying frame rate of the sample (default: 44100)",
159159
"type": ["int"]
160-
},
161-
{
162-
"name": "data",
163-
"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.",
164-
"type": ["float[]"]
165160
}
166161
]
167162
}

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"brief": "Jump to a specific position in the audiosample while continuing to play (or starting to play if it wasn't playing already).",
2+
"brief": "Jumps to a specific position in the audio sample.",
33
"related": ["sound/AudioSample_cue_", "sound/AudioSample_play_"],
44
"name": "jump()",
5-
"description": "Jump to a specific position in the audiosample while continuing to play (or starting to play if it wasn't playing already).",
5+
"description": "Jump to a specific position in the audiosample while continuing to play (or \n starting to play if it wasn't playing already).",
66
"syntax": [".jump(time)"],
77
"returns": "void",
88
"type": "method",
@@ -12,7 +12,7 @@
1212
"parameters": [
1313
{
1414
"name": "time",
15-
"description": "position to jump to, in seconds.",
15+
"description": "position to jump to, in seconds",
1616
"type": ["float"]
1717
}
1818
]

‎content/references/translations/en/sound/AudioSample_loop_.json

+2-3
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,12 @@
22
"brief": "Starts the playback of the audiosample.",
33
"related": [],
44
"name": "loop()",
5-
"description": "Starts playback which will loop at the end of the audiosample.",
5+
"description": "Starts the playback of the audiosample. Only plays to the end of the audiosample \n once. If <b>cue()</b> or <b>pause()</b> were called previously, playback will resume from the cued position.",
66
"syntax": [
77
".loop()",
88
".loop(rate)",
99
".loop(rate, amp)",
10-
".loop(rate, pos, amp)",
11-
".loop(rate, pos, amp, add)"
10+
".loop(rate, pos, amp)"
1211
],
1312
"returns": "void",
1413
"type": "method",

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

+1-7
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88
".play(rate)",
99
".play(rate, amp)",
1010
".play(rate, pos, amp)",
11-
".play(rate, pos, amp, add)",
12-
".play(rate, pos, amp, add, cue)"
11+
".play(rate, pos, amp, cue)"
1312
],
1413
"returns": "void",
1514
"type": "method",
@@ -32,11 +31,6 @@
3231
"description": "the desired playback amplitude of the audiosample as a value from\n 0.0 (complete silence) to 1.0 (full volume)",
3332
"type": ["float"]
3433
},
35-
{
36-
"name": "add",
37-
"description": "offset the output of the generator by the given value",
38-
"type": ["float"]
39-
},
4034
{
4135
"name": "cue",
4236
"description": "position in the audiosample that playback should start from, in\n seconds.",

‎content/references/translations/en/sound/AudioSample_set_.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"related": [],
44
"name": "set()",
55
"description": "Set multiple parameters at once.",
6-
"syntax": [".set(rate, pos, amp)", ".set(rate, pos, amp, add)"],
6+
"syntax": [".set(rate, pos, amp)"],
77
"returns": "void",
88
"type": "method",
99
"category": "Sampling",

‎content/references/translations/en/sound/AudioSample_stop_.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"brief": "Stops the playback, and sets the cue back to the start of the sample.",
2+
"brief": "Stops the playback.",
33
"related": [],
44
"name": "stop()",
5-
"description": "Stops the playback, and sets the cue back to the start of the sample.",
5+
"description": "Stops the playback.",
66
"syntax": [".stop()"],
77
"returns": "void",
88
"type": "method",

‎content/references/translations/en/sound/BandPass.json

+7-2
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,23 @@
44
{
55
"anchor": "BandPass_bw_",
66
"name": "bw()",
7-
"desc": "Set the bandwidth for the filter."
7+
"desc": "Sets the bandwidth for the filter."
88
},
99
{
1010
"anchor": "BandPass_freq_",
1111
"name": "freq()",
12-
"desc": "Set the cutoff frequency for the filter."
12+
"desc": "Sets the center frequency of the filter."
1313
},
1414
{
1515
"anchor": "BandPass_process_",
1616
"name": "process()",
1717
"desc": "Start applying this bandpass filter to an input signal."
1818
},
19+
{
20+
"anchor": "BandPass_res_",
21+
"name": "res()",
22+
"desc": "Sets the resonance (or 'Q factor') of this filter."
23+
},
1924
{
2025
"anchor": "BandPass_set_",
2126
"name": "set()",

‎content/references/translations/en/sound/BandPass_bw_.json

+9-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,19 @@
11
{
2-
"brief": "Set the bandwidth for the filter.",
2+
"brief": "Sets the bandwidth for the filter.",
33
"related": [],
44
"name": "bw()",
5-
"description": "Set the bandwidth for the filter.",
5+
"description": "Sets the bandwidth of this BandPass filter.",
66
"syntax": [".bw(bw)"],
77
"returns": "void",
88
"type": "method",
99
"category": "Effects",
1010
"subcategory": "BandPass",
1111
"classanchor": "BandPass",
12-
"parameters": []
12+
"parameters": [
13+
{
14+
"name": "bw",
15+
"description": "the filter bandwidth in Hertz",
16+
"type": ["float"]
17+
}
18+
]
1319
}

‎content/references/translations/en/sound/BandPass_freq_.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"brief": "Set the cutoff frequency for the filter.",
2+
"brief": "Sets the center frequency of the filter.",
33
"related": [],
44
"name": "freq()",
5-
"description": "Set the cutoff frequency for the filter.",
5+
"description": "Sets the center frequency of the filter.",
66
"syntax": [".freq(freq)"],
77
"returns": "void",
88
"type": "method",
@@ -12,7 +12,7 @@
1212
"parameters": [
1313
{
1414
"name": "freq",
15-
"description": "Cutoff frequency between 0 and 20000",
15+
"description": "the center frequency in Hertz",
1616
"type": ["float"]
1717
}
1818
]

‎content/references/translations/en/sound/BandPass_process_.json

+8-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"related": [],
44
"name": "process()",
55
"description": "Start applying this bandpass filter to an input signal.",
6-
"syntax": [".process(input, freq)", ".process(input, freq, bw)"],
6+
"syntax": [".process(input, freq, bw)"],
77
"returns": "void",
88
"type": "method",
99
"category": "Effects",
@@ -12,14 +12,18 @@
1212
"parameters": [
1313
{
1414
"name": "input",
15-
"description": "the sound source to apply the filter to",
15+
"description": "the sound source to filter",
1616
"type": ["SoundObject"]
1717
},
1818
{
1919
"name": "freq",
20-
"description": "Cutoff frequency between 0 and 20000",
20+
"description": "the center frequency in Hertz",
2121
"type": ["float"]
2222
},
23-
{ "name": "bw", "description": "Set the bandwidth", "type": ["float"] }
23+
{
24+
"name": "bw",
25+
"description": "the filter bandwidth in Hertz",
26+
"type": ["float"]
27+
}
2428
]
2529
}

‎content/references/translations/en/sound/BandPass_res_.json

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"brief": "Sets the resonance (or 'Q factor') of this filter.",
3+
"related": [],
4+
"name": "res()",
5+
"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 <code>bw(float)</code> \n instead.",
6+
"syntax": [".res(q)"],
7+
"returns": "void",
8+
"type": "method",
9+
"category": "Effects",
10+
"subcategory": "BandPass",
11+
"classanchor": "BandPass",
12+
"parameters": [
13+
{
14+
"name": "q",
15+
"description": "the desired Q factor, a value between 0.1 and 10",
16+
"type": ["float"]
17+
}
18+
]
19+
}

‎content/references/translations/en/sound/BandPass_set_.json

+10-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,15 @@
1010
"subcategory": "BandPass",
1111
"classanchor": "BandPass",
1212
"parameters": [
13-
{ "name": "freq", "description": "Set the frequency", "type": ["float"] },
14-
{ "name": "bw", "description": "Set the bandwidth", "type": ["float"] }
13+
{
14+
"name": "freq",
15+
"description": "the center frequency in Hertz",
16+
"type": ["float"]
17+
},
18+
{
19+
"name": "bw",
20+
"description": "the filter bandwidth in Hertz",
21+
"type": ["float"]
22+
}
1523
]
1624
}

‎content/references/translations/en/sound/BeatDetector_isBeat_.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"brief": "Returns whether or not the current moment of audio contains a beat or not.",
33
"related": [],
44
"name": "isBeat()",
5-
"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.",
5+
"description": "Returns <code>true</code> if the current moment of the audio signal \n contains a beat, <code>false</code> otherwise.<br/>\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.",
66
"syntax": [".isBeat()"],
77
"returns": "boolean",
88
"type": "method",

‎content/references/translations/en/sound/BrownNoise_set_.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"related": [],
44
"name": "set()",
55
"description": "Set the amplitude and panoramic position with one method.",
6-
"syntax": [".set(amp, pos)"],
6+
"syntax": [".set(amp, pos)", ".set(amp, add, pos)"],
77
"returns": "void",
88
"type": "method",
99
"category": "Noise",

‎content/references/translations/en/sound/Env_play_.json

+5
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,11 @@
2727
"description": "Sustain time value as a float.",
2828
"type": ["float"]
2929
},
30+
{
31+
"name": "sustainLevel",
32+
"description": "Sustain level value as a float. (as fraction of the input amplitude)",
33+
"type": ["float"]
34+
},
3035
{
3136
"name": "releaseTime",
3237
"description": "Release time value as a float.",

0 commit comments

Comments
 (0)