Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update sound library reference categories/subcategories #470

Merged
merged 2 commits into from
Aug 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view

This file was deleted.

36 changes: 0 additions & 36 deletions content/references/examples/sound/FFT_stop_/FFT_stop_0.pde

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -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);
}

12 changes: 8 additions & 4 deletions content/references/translations/en/sound/Amplitude.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
]
}
]
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
"syntax": [".analyze()"],
"returns": "float",
"type": "method",
"category": "amplitude",
"subcategory": "",
"category": "Analysis",
"subcategory": "Amplitude",
"classanchor": "Amplitude",
"parameters": []
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
"syntax": [".input(input)"],
"returns": "void",
"type": "method",
"category": "amplitude",
"subcategory": "",
"category": "Analysis",
"subcategory": "Amplitude",
"classanchor": "Amplitude",
"parameters": [
{
Expand Down
13 changes: 0 additions & 13 deletions content/references/translations/en/sound/Amplitude_stop_.json

This file was deleted.

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

This file was deleted.

6 changes: 3 additions & 3 deletions content/references/translations/en/sound/AudioIn_amp_.json
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -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"]
}
]
Expand Down
6 changes: 3 additions & 3 deletions content/references/translations/en/sound/AudioIn_pan_.json
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -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"]
}
]
Expand Down
9 changes: 2 additions & 7 deletions content/references/translations/en/sound/AudioIn_play_.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,15 @@
],
"returns": "void",
"type": "method",
"category": "audioin",
"subcategory": "",
"category": "I/O",
"subcategory": "AudioIn",
"classanchor": "AudioIn",
"parameters": [
{
"name": "amp",
"description": "the volume to grab the input at as a value from 0.0 (complete\n silence) to 1.0 (full volume)",
"type": ["float"]
},
{
"name": "add",
"description": "offset the audio input by the given value",
"type": ["float"]
},
{
"name": "pos",
"description": "pan the audio input in a stereo panorama. Allowed values are\n between -1.0 (left) and 1.0 (right)",
Expand Down
15 changes: 5 additions & 10 deletions content/references/translations/en/sound/AudioIn_set_.json
Original file line number Diff line number Diff line change
@@ -1,25 +1,20 @@
{
"brief": "Sets amplitude, add and pan position with one method.",
"brief": "Set amplitude and pan position with one method.",
"related": [],
"name": "set()",
"description": "Sets amplitude, add and pan position with one method.",
"syntax": [".set(amp, add, pos)"],
"description": "Set amplitude and pan position with one method.",
"syntax": [".set(amp, pos)", ".set(amp, add, pos)"],
"returns": "void",
"type": "method",
"category": "audioin",
"subcategory": "",
"category": "I/O",
"subcategory": "AudioIn",
"classanchor": "AudioIn",
"parameters": [
{
"name": "amp",
"description": "the volume to grab the input at as a value from 0.0 (complete\n silence) to 1.0 (full volume)",
"type": ["float"]
},
{
"name": "add",
"description": "offset the audio input by the given value",
"type": ["float"]
},
{
"name": "pos",
"description": "pan the audio input in a stereo panorama. Allowed values are\n between -1.0 (left) and 1.0 (right)",
Expand Down
4 changes: 2 additions & 2 deletions content/references/translations/en/sound/AudioIn_start_.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
],
"returns": "void",
"type": "method",
"category": "audioin",
"subcategory": "",
"category": "I/O",
"subcategory": "AudioIn",
"classanchor": "AudioIn",
"parameters": [
{
Expand Down
4 changes: 2 additions & 2 deletions content/references/translations/en/sound/AudioIn_stop_.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
6 changes: 3 additions & 3 deletions content/references/translations/en/sound/AudioSample.json
Original file line number Diff line number Diff line change
Expand Up @@ -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_",
Expand Down Expand Up @@ -135,8 +135,8 @@
"related": [],
"name": "AudioSample",
"classanchor": "sound/AudioSample",
"category": "sampling",
"subcategory": "",
"category": "Sampling",
"subcategory": "AudioSample",
"parameters": [
{
"name": "parent",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
"syntax": [".amp(amp)"],
"returns": "void",
"type": "method",
"category": "audiosample",
"subcategory": "",
"category": "Sampling",
"subcategory": "AudioSample",
"classanchor": "AudioSample",
"parameters": [
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
"syntax": [".channels()"],
"returns": "int",
"type": "method",
"category": "audiosample",
"subcategory": "",
"category": "Sampling",
"subcategory": "AudioSample",
"classanchor": "AudioSample",
"parameters": []
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
"syntax": [".cueFrame(frameNumber)"],
"returns": "void",
"type": "method",
"category": "audiosample",
"subcategory": "",
"category": "Sampling",
"subcategory": "AudioSample",
"classanchor": "AudioSample",
"parameters": [
{
Expand Down
Loading