Skip to content

Commit b5f99c9

Browse files
SableRafSableRaf
authored
Merge pull request #470 from processing/sound-updates
Update sound library reference categories/subcategories
2 parents 102a083 + 9f3dbb7 commit b5f99c9

File tree

165 files changed

+792
-1033
lines changed

Some content is hidden

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

165 files changed

+792
-1033
lines changed

‎content/references/examples/sound/Amplitude_stop_/Amplitude_stop_0.pde

-22
This file was deleted.

‎content/references/examples/sound/FFT_stop_/FFT_stop_0.pde

-36
This file was deleted.

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

+1-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ void mousePressed() {
1616
float rate = 3;
1717
float pos = 0.5;
1818
float amp = 0.5;
19-
float add = 0;
20-
file.set(rate, pos, amp, add);
19+
file.set(rate, pos, amp);
2120
}
2221

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

+8-4
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,21 @@
1717
"classFields": [],
1818
"description": "This is a volume analyzer. It calculates the root mean square of the\n amplitude of each audio block and returns that value.",
1919
"type": "class",
20-
"constructors": ["Amplitude(parent)"],
20+
"constructors": [
21+
"Amplitude(parent)"
22+
],
2123
"related": [],
2224
"name": "Amplitude",
2325
"classanchor": "sound/Amplitude",
24-
"category": "analysis",
25-
"subcategory": "",
26+
"category": "Analysis",
27+
"subcategory": "Amplitude",
2628
"parameters": [
2729
{
2830
"name": "parent",
2931
"description": "typically use \"this\"",
30-
"type": ["PApplet"]
32+
"type": [
33+
"PApplet"
34+
]
3135
}
3236
]
3337
}

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
"syntax": [".analyze()"],
77
"returns": "float",
88
"type": "method",
9-
"category": "amplitude",
10-
"subcategory": "",
9+
"category": "Analysis",
10+
"subcategory": "Amplitude",
1111
"classanchor": "Amplitude",
1212
"parameters": []
1313
}

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
"syntax": [".input(input)"],
77
"returns": "void",
88
"type": "method",
9-
"category": "amplitude",
10-
"subcategory": "",
9+
"category": "Analysis",
10+
"subcategory": "Amplitude",
1111
"classanchor": "Amplitude",
1212
"parameters": [
1313
{

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

-13
This file was deleted.

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

+29-7
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,65 @@
11
{
22
"brief": "AudioIn lets you grab the audio input from your sound card.",
33
"methods": [
4+
{
5+
"anchor": "AudioIn_amp_",
6+
"name": "amp()",
7+
"desc": "Change the amplitude/volume of this sound."
8+
},
9+
{
10+
"anchor": "AudioIn_pan_",
11+
"name": "pan()",
12+
"desc": "Move the sound in a stereo panorama."
13+
},
414
{
515
"anchor": "AudioIn_play_",
616
"name": "play()",
717
"desc": "Start capturing the input stream and route it to the audio output"
818
},
19+
{
20+
"anchor": "AudioIn_set_",
21+
"name": "set()",
22+
"desc": "Set amplitude and pan position with one method."
23+
},
924
{
1025
"anchor": "AudioIn_start_",
1126
"name": "start()",
1227
"desc": "Start the input stream without routing it to the audio output."
1328
},
1429
{
15-
"anchor": "AudioIn_set_",
16-
"name": "set()",
17-
"desc": "Sets amplitude, add and pan position with one method."
30+
"anchor": "AudioIn_stop_",
31+
"name": "stop()",
32+
"desc": "Stop capturing sound from this audio input."
1833
}
1934
],
2035
"csspath": "../../",
2136
"isLibrary": "true",
2237
"classFields": [],
2338
"description": "AudioIn lets you grab the audio input from your sound card.",
2439
"type": "class",
25-
"constructors": ["AudioIn(parent)", "AudioIn(parent, in)"],
40+
"constructors": [
41+
"AudioIn(parent)",
42+
"AudioIn(parent, in)"
43+
],
2644
"related": [],
2745
"name": "AudioIn",
2846
"classanchor": "sound/AudioIn",
2947
"category": "I/O",
30-
"subcategory": "",
48+
"subcategory": "AudioIn",
3149
"parameters": [
3250
{
3351
"name": "parent",
3452
"description": "typically use \"this\"",
35-
"type": ["PApplet"]
53+
"type": [
54+
"PApplet"
55+
]
3656
},
3757
{
3858
"name": "in",
3959
"description": "input channel number (optional, default 0)",
40-
"type": ["int"]
60+
"type": [
61+
"int"
62+
]
4163
}
4264
]
4365
}

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

-19
This file was deleted.

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"brief": "Changes the amplitude/volume of the input stream.",
2+
"brief": "Change the amplitude/volume of this sound.",
33
"related": [],
44
"name": "amp()",
5-
"description": "Changes the amplitude/volume of the input stream. Allowed values are between 0.0 and 1.0.",
5+
"description": "Change the amplitude/volume of this sound.",
66
"syntax": [".amp(amp)"],
77
"returns": "void",
88
"type": "method",
@@ -12,7 +12,7 @@
1212
"parameters": [
1313
{
1414
"name": "amp",
15-
"description": "the amplitude of the input stream as a value from 0.0 (complete silence) to 1.0 (full volume)",
15+
"description": "A float value between 0.0 (complete silence) and 1.0 (full volume)\n controlling the amplitude/volume of this sound.",
1616
"type": ["float"]
1717
}
1818
]

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"brief": "Pan the input stream in a stereo panorama.",
2+
"brief": "Move the sound in a stereo panorama.",
33
"related": [],
44
"name": "pan()",
5-
"description": "Pan the input stream in a stereo panorama. -1.0 pans to the left channel and 1.0 to the right channel.",
5+
"description": "Move the sound in a stereo panorama.",
66
"syntax": [".pan(pos)"],
77
"returns": "void",
88
"type": "method",
@@ -12,7 +12,7 @@
1212
"parameters": [
1313
{
1414
"name": "pos",
15-
"description": "the panoramic position of this sound unit from -1.0 (left) to 1.0\n (right).",
15+
"description": "The panoramic position of this sound unit as a float from -1.0\n (left) to 1.0 (right).",
1616
"type": ["float"]
1717
}
1818
]

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

+2-7
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,15 @@
1111
],
1212
"returns": "void",
1313
"type": "method",
14-
"category": "audioin",
15-
"subcategory": "",
14+
"category": "I/O",
15+
"subcategory": "AudioIn",
1616
"classanchor": "AudioIn",
1717
"parameters": [
1818
{
1919
"name": "amp",
2020
"description": "the volume to grab the input at as a value from 0.0 (complete\n silence) to 1.0 (full volume)",
2121
"type": ["float"]
2222
},
23-
{
24-
"name": "add",
25-
"description": "offset the audio input by the given value",
26-
"type": ["float"]
27-
},
2823
{
2924
"name": "pos",
3025
"description": "pan the audio input in a stereo panorama. Allowed values are\n between -1.0 (left) and 1.0 (right)",

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

+5-10
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,20 @@
11
{
2-
"brief": "Sets amplitude, add and pan position with one method.",
2+
"brief": "Set amplitude and pan position with one method.",
33
"related": [],
44
"name": "set()",
5-
"description": "Sets amplitude, add and pan position with one method.",
6-
"syntax": [".set(amp, add, pos)"],
5+
"description": "Set amplitude and pan position with one method.",
6+
"syntax": [".set(amp, pos)", ".set(amp, add, pos)"],
77
"returns": "void",
88
"type": "method",
9-
"category": "audioin",
10-
"subcategory": "",
9+
"category": "I/O",
10+
"subcategory": "AudioIn",
1111
"classanchor": "AudioIn",
1212
"parameters": [
1313
{
1414
"name": "amp",
1515
"description": "the volume to grab the input at as a value from 0.0 (complete\n silence) to 1.0 (full volume)",
1616
"type": ["float"]
1717
},
18-
{
19-
"name": "add",
20-
"description": "offset the audio input by the given value",
21-
"type": ["float"]
22-
},
2318
{
2419
"name": "pos",
2520
"description": "pan the audio input in a stereo panorama. Allowed values are\n between -1.0 (left) and 1.0 (right)",

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
],
1212
"returns": "void",
1313
"type": "method",
14-
"category": "audioin",
15-
"subcategory": "",
14+
"category": "I/O",
15+
"subcategory": "AudioIn",
1616
"classanchor": "AudioIn",
1717
"parameters": [
1818
{

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"brief": "Stops the Input Stream.",
2+
"brief": "Stop capturing sound from this audio input.",
33
"related": [],
44
"name": "stop()",
5-
"description": "Stops the Input Stream.",
5+
"description": "Stop capturing sound from this audio input.",
66
"syntax": [".stop()"],
77
"returns": "void",
88
"type": "method",

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@
8484
{
8585
"anchor": "AudioSample_stop_",
8686
"name": "stop()",
87-
"desc": "Stops the playback."
87+
"desc": "Stops the playback, and sets the cue back to the start of the sample."
8888
},
8989
{
9090
"anchor": "AudioSample_position_",
@@ -135,8 +135,8 @@
135135
"related": [],
136136
"name": "AudioSample",
137137
"classanchor": "sound/AudioSample",
138-
"category": "sampling",
139-
"subcategory": "",
138+
"category": "Sampling",
139+
"subcategory": "AudioSample",
140140
"parameters": [
141141
{
142142
"name": "parent",

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
"syntax": [".amp(amp)"],
77
"returns": "void",
88
"type": "method",
9-
"category": "audiosample",
10-
"subcategory": "",
9+
"category": "Sampling",
10+
"subcategory": "AudioSample",
1111
"classanchor": "AudioSample",
1212
"parameters": [
1313
{

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
"syntax": [".channels()"],
77
"returns": "int",
88
"type": "method",
9-
"category": "audiosample",
10-
"subcategory": "",
9+
"category": "Sampling",
10+
"subcategory": "AudioSample",
1111
"classanchor": "AudioSample",
1212
"parameters": []
1313
}

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
"syntax": [".cueFrame(frameNumber)"],
77
"returns": "void",
88
"type": "method",
9-
"category": "audiosample",
10-
"subcategory": "",
9+
"category": "Sampling",
10+
"subcategory": "AudioSample",
1111
"classanchor": "AudioSample",
1212
"parameters": [
1313
{

0 commit comments

Comments
 (0)