Skip to content

Generated files from updated build script (processing-doclet) #516

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

Merged
merged 2 commits into from
Mar 26, 2024
Merged
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
34 changes: 34 additions & 0 deletions content/references/translations/en/sound/AllPass.json
Original file line number Diff line number Diff line change
@@ -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,<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.",
"type": "class",
"constructors": [
"AllPass(parent)"
],
"related": [],
"name": "AllPass",
"classanchor": "sound/AllPass",
"category": "Effects",
"subcategory": "AllPass",
"parameters": []
}
19 changes: 19 additions & 0 deletions content/references/translations/en/sound/AllPass_gain_.json
Original file line number Diff line number Diff line change
@@ -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": ["allpass.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"]
}
]
}
19 changes: 19 additions & 0 deletions content/references/translations/en/sound/AllPass_process_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"brief": "Start the effect.",
"related": [],
"name": "process()",
"description": "Start the effect.",
"syntax": ["effect.process(input)"],
"returns": "void",
"type": "method",
"category": "Effects",
"subcategory": "AllPass",
"classanchor": "AllPass",
"parameters": [
{
"name": "input",
"description": "Input sound source",
"type": ["SoundObject"]
}
]
}
13 changes: 13 additions & 0 deletions content/references/translations/en/sound/AllPass_stop_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"brief": "Stop the effect.",
"related": [],
"name": "stop()",
"description": "Stop the effect.",
"syntax": ["effect.stop()"],
"returns": "void",
"type": "method",
"category": "Effects",
"subcategory": "AllPass",
"classanchor": "AllPass",
"parameters": []
}
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "analyze()",
"description": "Queries a value from the analyzer and returns a float between 0. and 1.",
"syntax": [".analyze()"],
"syntax": ["amplitude.analyze()"],
"returns": "float",
"type": "method",
"category": "Analysis",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "input()",
"description": "Define the audio input for the analyzer.",
"syntax": [".input(input)"],
"syntax": ["amplitude.input(input)"],
"returns": "void",
"type": "method",
"category": "Analysis",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/AudioIn_amp_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "amp()",
"description": "Change the amplitude/volume of this sound.",
"syntax": [".amp(amp)"],
"syntax": ["soundobject.amp(amp)"],
"returns": "void",
"type": "method",
"category": "I/O",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/AudioIn_pan_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "pan()",
"description": "Move the sound in a stereo panorama.",
"syntax": [".pan(pos)"],
"syntax": ["soundobject.pan(pos)"],
"returns": "void",
"type": "method",
"category": "I/O",
8 changes: 4 additions & 4 deletions content/references/translations/en/sound/AudioIn_play_.json
Original file line number Diff line number Diff line change
@@ -4,10 +4,10 @@
"name": "play()",
"description": "Start capturing the input stream and route it to the audio output",
"syntax": [
".play()",
".play(amp)",
".play(amp, add)",
".play(amp, add, pos)"
"audioin.play()",
"audioin.play(amp)",
"audioin.play(amp, add)",
"audioin.play(amp, add, pos)"
],
"returns": "void",
"type": "method",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/AudioIn_set_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "set()",
"description": "Set amplitude and pan position with one method.",
"syntax": [".set(amp, pos)", ".set(amp, add, pos)"],
"syntax": ["audioin.set(amp, pos)", "audioin.set(amp, add, pos)"],
"returns": "void",
"type": "method",
"category": "I/O",
8 changes: 4 additions & 4 deletions content/references/translations/en/sound/AudioIn_start_.json
Original file line number Diff line number Diff line change
@@ -4,10 +4,10 @@
"name": "start()",
"description": "Start the input stream without routing it to the audio output. This is useful\n if you only want to perform audio analysis based on the microphone input.",
"syntax": [
".start()",
".start(amp)",
".start(amp, add)",
".start(amp, add, pos)"
"audioin.start()",
"audioin.start(amp)",
"audioin.start(amp, add)",
"audioin.start(amp, add, pos)"
],
"returns": "void",
"type": "method",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "stop()",
"description": "Stop capturing sound from this audio input.",
"syntax": [".stop()"],
"syntax": ["audioin.stop()"],
"returns": "void",
"type": "method",
"category": "I/O",
13 changes: 4 additions & 9 deletions content/references/translations/en/sound/AudioSample.json
Original file line number Diff line number Diff line change
@@ -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: ,<code>,false,</code>,)",
"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[]"]
}
]
}
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "amp()",
"description": "Change the amplitude/volume of the player. Values are between 0.0 and 1.0.",
"syntax": [".amp(amp)"],
"syntax": ["audiosample.amp(amp)"],
"returns": "void",
"type": "method",
"category": "Sampling",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "channels()",
"description": "Returns the number of channels in the audiosample as an int (1 for mono, 2 for stereo).",
"syntax": [".channels()"],
"syntax": ["audiosample.channels()"],
"returns": "int",
"type": "method",
"category": "Sampling",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "cueFrame()",
"description": "Cues the playhead to a fixed position in the audiosample.",
"syntax": [".cueFrame(frameNumber)"],
"syntax": ["audiosample.cueFrame(frameNumber)"],
"returns": "void",
"type": "method",
"category": "Sampling",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "cue()",
"description": "Cues the playhead to a fixed position in the audiosample. Note that <b>cue()</b> only affects the playhead for future calls to <b>play()</b>, but not to <b>loop()</b>.",
"syntax": [".cue(time)"],
"syntax": ["audiosample.cue(time)"],
"returns": "void",
"type": "method",
"category": "Sampling",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "duration()",
"description": "Returns the duration of the audiosample in seconds.",
"syntax": [".duration()"],
"syntax": ["audiosample.duration()"],
"returns": "float",
"type": "method",
"category": "Sampling",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "frames()",
"description": "Returns the number of frames of the audiosample as an int.",
"syntax": [".frames()"],
"syntax": ["audiosample.frames()"],
"returns": "int",
"type": "method",
"category": "Sampling",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": ["sound/AudioSample_cue_", "sound/AudioSample_play_"],
"name": "jumpFrame()",
"description": "Jump to a specific position in the audiosample without interrupting playback.",
"syntax": [".jumpFrame(frameNumber)"],
"syntax": ["audiosample.jumpFrame(frameNumber)"],
"returns": "void",
"type": "method",
"category": "Sampling",
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"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).",
"syntax": [".jump(time)"],
"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": ["audiosample.jump(time)"],
"returns": "void",
"type": "method",
"category": "Sampling",
@@ -12,7 +12,7 @@
"parameters": [
{
"name": "time",
"description": "position to jump to, in seconds.",
"description": "position to jump to, in seconds",
"type": ["float"]
}
]
11 changes: 5 additions & 6 deletions content/references/translations/en/sound/AudioSample_loop_.json
Original file line number Diff line number Diff line change
@@ -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 <b>cue()</b> or <b>pause()</b> 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)"
"audiosample.loop()",
"audiosample.loop(rate)",
"audiosample.loop(rate, amp)",
"audiosample.loop(rate, pos, amp)"
],
"returns": "void",
"type": "method",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "pan()",
"description": "Pan the soundfile in a stereo panorama. -1.0 pans to the left channel and 1.0 to the right channel. \n Note that panning is only supported for mono (1 channel) audiosamples.",
"syntax": [".pan(pos)"],
"syntax": ["audiosample.pan(pos)"],
"returns": "void",
"type": "method",
"category": "Sampling",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": ["sound/AudioSample_cue_"],
"name": "pause()",
"description": "Stop the playback of the sample, but cue it to the current position. \n The next call to <b>play()</b> will continue playing where it left off.",
"syntax": [".pause()"],
"syntax": ["audiosample.pause()"],
"returns": "void",
"type": "method",
"category": "Sampling",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "percent()",
"description": "Get current sound file playback position in percent.\n \n Note that, if this audio sample was at some point played back in parallel\n (triggered by another call to <b>play()</b> before the original playback had finished),\n the position returned by this function can be of any of the concurrent playbacks,\n not necessarily the last one that was triggered.",
"syntax": [".percent()"],
"syntax": ["audiosample.percent()"],
"returns": "float",
"type": "method",
"category": "Sampling",
Original file line number Diff line number Diff line change
@@ -3,7 +3,10 @@
"related": [],
"name": "playFor()",
"description": "Starts the playback of the audiosample for the specified duration or to the\n end of the audiosample, whichever comes first.",
"syntax": [".playFor(duration)", ".playFor(duration, cue)"],
"syntax": [
"audiosample.playFor(duration)",
"audiosample.playFor(duration, cue)"
],
"returns": "void",
"type": "method",
"category": "Sampling",
16 changes: 5 additions & 11 deletions content/references/translations/en/sound/AudioSample_play_.json
Original file line number Diff line number Diff line change
@@ -4,12 +4,11 @@
"name": "play()",
"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.",
"syntax": [
".play()",
".play(rate)",
".play(rate, amp)",
".play(rate, pos, amp)",
".play(rate, pos, amp, add)",
".play(rate, pos, amp, add, cue)"
"audiosample.play()",
"audiosample.play(rate)",
"audiosample.play(rate, amp)",
"audiosample.play(rate, pos, amp)",
"audiosample.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.",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "positionFrame()",
"description": "Get frame index of current sound file playback position.\n \n Note that, if this audio sample was at some point played back in parallel\n (triggered by another call to <b>play()</b> before the original playback had finished),\n the position returned by this function can be of any of the concurrent playbacks,\n not necessarily the last one that was triggered.",
"syntax": [".positionFrame()"],
"syntax": ["audiosample.positionFrame()"],
"returns": "int",
"type": "method",
"category": "Sampling",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "position()",
"description": "Get current sound file playback position in seconds.\n \n Note that, if this audio sample was at some point played back in parallel\n (triggered by another call to play() before the original playback had finished),\n the position returned by this function can be of any of the concurrent playbacks,\n not necessarily the last one that was triggered.",
"syntax": [".position()"],
"syntax": ["audiosample.position()"],
"returns": "float",
"type": "method",
"category": "Sampling",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "rate()",
"description": "Set the relative playback rate of the audiosample. 1 is the original speed. \n 0.5 is half speed and one octave down. 2 is double the speed and one octave up.",
"syntax": [".rate(rate)"],
"syntax": ["audiosample.rate(rate)"],
"returns": "void",
"type": "method",
"category": "Sampling",
Original file line number Diff line number Diff line change
@@ -4,10 +4,10 @@
"name": "read()",
"description": "The underlying data of the audiosample can be read and written in several different ways:\n the method taking a single float array `data` gets the current sample data and write it \n into the given array. The array has to be able to store as many floats as there are frames \n in this sample.\n It is also possible to only read parts of the sample data using the method with four arguments, \n which allows you to specify the index of the first frame to read, the position in the array to \n write it to, as well as how many frames to copy over into the array in total.\n Finally, the method taking a single integer argument `index` returns the value of the single \n audio frame of the sample at this index as a float.",
"syntax": [
".read(data)",
".read(startFrame, data, startIndex, numFrames)",
".read(frameIndex)",
".read(frameIndex, channelIndex)"
"audiosample.read(data)",
"audiosample.read(startFrame, data, startIndex, numFrames)",
"audiosample.read(frameIndex)",
"audiosample.read(frameIndex, channelIndex)"
],
"returns": "void or float",
"type": "method",
Original file line number Diff line number Diff line change
@@ -3,7 +3,10 @@
"related": [],
"name": "resize()",
"description": "Resizes the underlying buffer of the audiosample to the given number of frames. \n Calling this method allocates a completely new buffer, so any ongoing playback \n will be stopped and all data currently stored in the sample will be lost.",
"syntax": [".resize(frames)", ".resize(frames, stereo)"],
"syntax": [
"audiosample.resize(frames)",
"audiosample.resize(frames, stereo)"
],
"returns": "void",
"type": "method",
"category": "Sampling",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "sampleRate()",
"description": "Returns the underlying sample rate of the audiosample.",
"syntax": [".sampleRate()"],
"syntax": ["audiosample.sampleRate()"],
"returns": "int",
"type": "method",
"category": "Sampling",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "set()",
"description": "Set multiple parameters at once.",
"syntax": [".set(rate, pos, amp)", ".set(rate, pos, amp, add)"],
"syntax": ["audiosample.set(rate, pos, amp)"],
"returns": "void",
"type": "method",
"category": "Sampling",
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"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.",
"syntax": [".stop()"],
"description": "Stops the playback.",
"syntax": ["audiosample.stop()"],
"returns": "void",
"type": "method",
"category": "Sampling",
Original file line number Diff line number Diff line change
@@ -4,9 +4,9 @@
"name": "write()",
"description": "The underlying data of the audiosample can be read and (over)written in several different ways:\n the method taking a single float array `data` replaces the sample data with the content of the \n given array. The array has to contain as many floats as there are frames in this sample.\n It is also possible to only write parts of the sample data using the method with four arguments, \n which allows you to specify the index of the first frame to write, the position in the array to \n take the data from, as well as how many frames should be copied over.\n Finally, the method taking two arguments simply sets the value of the single audio frame \n specified by the first argument to the given float value.",
"syntax": [
".write(data)",
".write(startFrame, data, startIndex, numFrames)",
".write(index, value)"
"audiosample.write(data)",
"audiosample.write(startFrame, data, startIndex, numFrames)",
"audiosample.write(index, value)"
],
"returns": "void",
"type": "method",
9 changes: 7 additions & 2 deletions content/references/translations/en/sound/BandPass.json
Original file line number Diff line number Diff line change
@@ -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()",
14 changes: 10 additions & 4 deletions content/references/translations/en/sound/BandPass_bw_.json
Original file line number Diff line number Diff line change
@@ -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.",
"syntax": [".bw(bw)"],
"description": "Sets the bandwidth of this BandPass filter.",
"syntax": ["bandpass.bw(bw)"],
"returns": "void",
"type": "method",
"category": "Effects",
"subcategory": "BandPass",
"classanchor": "BandPass",
"parameters": []
"parameters": [
{
"name": "bw",
"description": "the filter bandwidth in Hertz",
"type": ["float"]
}
]
}
8 changes: 4 additions & 4 deletions content/references/translations/en/sound/BandPass_freq_.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"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.",
"syntax": [".freq(freq)"],
"description": "Sets the center frequency of the filter.",
"syntax": ["bandpass.freq(freq)"],
"returns": "void",
"type": "method",
"category": "Effects",
@@ -12,7 +12,7 @@
"parameters": [
{
"name": "freq",
"description": "Cutoff frequency between 0 and 20000",
"description": "the center frequency in Hertz",
"type": ["float"]
}
]
12 changes: 8 additions & 4 deletions content/references/translations/en/sound/BandPass_process_.json
Original file line number Diff line number Diff line change
@@ -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": ["bandpass.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"]
}
]
}
19 changes: 19 additions & 0 deletions content/references/translations/en/sound/BandPass_res_.json
Original file line number Diff line number Diff line change
@@ -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 <code>bw(float)</code> \n instead.",
"syntax": ["bandpass.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"]
}
]
}
14 changes: 11 additions & 3 deletions content/references/translations/en/sound/BandPass_set_.json
Original file line number Diff line number Diff line change
@@ -3,14 +3,22 @@
"related": [],
"name": "set()",
"description": "Sets frequency and bandwidth of the filter with one method.",
"syntax": [".set(freq, bw)"],
"syntax": ["bandpass.set(freq, bw)"],
"returns": "void",
"type": "method",
"category": "Effects",
"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"]
}
]
}
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "stop()",
"description": "Stop the effect.",
"syntax": [".stop()"],
"syntax": ["effect.stop()"],
"returns": "void",
"type": "method",
"category": "Effects",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "input()",
"description": "Define the audio input for the analyzer.",
"syntax": [".input(input)"],
"syntax": ["analyzer.input(input)"],
"returns": "void",
"type": "method",
"category": "Analysis",
Original file line number Diff line number Diff line change
@@ -2,8 +2,8 @@
"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.",
"syntax": [".isBeat()"],
"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.",
"syntax": ["beatdetector.isBeat()"],
"returns": "boolean",
"type": "method",
"category": "Analysis",
Original file line number Diff line number Diff line change
@@ -3,7 +3,10 @@
"related": [],
"name": "sensitivity()",
"description": "Sets the sensitivity of the beat detector.",
"syntax": [".sensitivity(sensitivity)", ".sensitivity()"],
"syntax": [
"beatdetector.sensitivity(sensitivity)",
"beatdetector.sensitivity()"
],
"returns": "int or void",
"type": "method",
"category": "Analysis",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "amp()",
"description": "Change the amplitude/volume of this sound.",
"syntax": [".amp(amp)"],
"syntax": ["soundobject.amp(amp)"],
"returns": "void",
"type": "method",
"category": "Noise",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "pan()",
"description": "Move the sound in a stereo panorama.",
"syntax": [".pan(pos)"],
"syntax": ["soundobject.pan(pos)"],
"returns": "void",
"type": "method",
"category": "Noise",
Original file line number Diff line number Diff line change
@@ -3,7 +3,11 @@
"related": [],
"name": "play()",
"description": "Starts the noise",
"syntax": [".play(amp)", ".play(amp, pos)", ".play(amp, add, pos)"],
"syntax": [
"noise.play(amp)",
"noise.play(amp, pos)",
"noise.play(amp, add, pos)"
],
"returns": "void",
"type": "method",
"category": "Noise",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "set()",
"description": "Set the amplitude and panoramic position with one method.",
"syntax": [".set(amp, pos)"],
"syntax": ["noise.set(amp, pos)", "noise.set(amp, add, pos)"],
"returns": "void",
"type": "method",
"category": "Noise",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "stop()",
"description": "Stop the noise from playing back",
"syntax": [".stop()"],
"syntax": ["noise.stop()"],
"returns": "void",
"type": "method",
"category": "Noise",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "feedback()",
"description": "Change the feedback of the delay effect.",
"syntax": [".feedback(feedback)"],
"syntax": ["delay.feedback(feedback)"],
"returns": "void",
"type": "method",
"category": "Effects",
4 changes: 2 additions & 2 deletions content/references/translations/en/sound/Delay_process_.json
Original file line number Diff line number Diff line change
@@ -4,8 +4,8 @@
"name": "process()",
"description": "Start the delay effect.",
"syntax": [
".process(input, maxDelayTime, delayTime)",
".process(input, maxDelayTime)"
"delay.process(input, maxDelayTime, delayTime)",
"delay.process(input, maxDelayTime)"
],
"returns": "void",
"type": "method",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/Delay_set_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "set()",
"description": "Set delay time and feedback values at once.",
"syntax": [".set(delayTime, feedback)"],
"syntax": ["delay.set(delayTime, feedback)"],
"returns": "void",
"type": "method",
"category": "Effects",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/Delay_stop_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "stop()",
"description": "Stop the effect.",
"syntax": [".stop()"],
"syntax": ["effect.stop()"],
"returns": "void",
"type": "method",
"category": "Effects",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/Delay_time_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "time()",
"description": "Changes the delay time of the effect.",
"syntax": [".time(delayTime)"],
"syntax": ["delay.time(delayTime)"],
"returns": "void",
"type": "method",
"category": "Effects",
7 changes: 6 additions & 1 deletion content/references/translations/en/sound/Env_play_.json
Original file line number Diff line number Diff line change
@@ -4,7 +4,7 @@
"name": "play()",
"description": "Triggers the envelope.",
"syntax": [
".play(input, attackTime, sustainTime, sustainLevel, releaseTime)"
"env.play(input, attackTime, sustainTime, sustainLevel, releaseTime)"
],
"returns": "void",
"type": "method",
@@ -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.",
6 changes: 3 additions & 3 deletions content/references/translations/en/sound/FFT.json
Original file line number Diff line number Diff line change
@@ -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"
]
17 changes: 10 additions & 7 deletions content/references/translations/en/sound/FFT_analyzeSample_.json
Original file line number Diff line number Diff line change
@@ -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 <code>frequency = binIndex * sampleRate / \n (2*numBands)</code>.<br>\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.<br>\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": [
"FFT.analyzeSample(sample, target)",
"FFT.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[]"]
}
]
}
10 changes: 5 additions & 5 deletions content/references/translations/en/sound/FFT_analyze_.json
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
{
"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 <code>frequency = binIndex * sampleRate / (2*numBands)</code>.<br>\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": ["fft.analyze()", "fft.analyze(target)"],
"returns": "float[]",
"type": "method",
"category": "Analysis",
"subcategory": "FFT",
"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[]"]
}
]
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/FFT_input_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "input()",
"description": "Define the audio input for the analyzer.",
"syntax": [".input(input)"],
"syntax": ["analyzer.input(input)"],
"returns": "void",
"type": "method",
"category": "Analysis",
14 changes: 12 additions & 2 deletions content/references/translations/en/sound/HighPass.json
Original file line number Diff line number Diff line change
@@ -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_",
6 changes: 3 additions & 3 deletions content/references/translations/en/sound/HighPass_freq_.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"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.",
"syntax": [".freq(freq)"],
"description": "Sets the cutoff frequency for the filter.",
"syntax": ["filter.freq(freq)"],
"returns": "void",
"type": "method",
"category": "Effects",
19 changes: 14 additions & 5 deletions content/references/translations/en/sound/HighPass_process_.json
Original file line number Diff line number Diff line change
@@ -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": ["filter.process(input, freq)", "filter.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"]
}
]
}
19 changes: 19 additions & 0 deletions content/references/translations/en/sound/HighPass_res_.json
Original file line number Diff line number Diff line change
@@ -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": ["filter.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"]
}
]
}
24 changes: 24 additions & 0 deletions content/references/translations/en/sound/HighPass_set_.json
Original file line number Diff line number Diff line change
@@ -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": ["filter.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"]
}
]
}
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "stop()",
"description": "Stop the effect.",
"syntax": [".stop()"],
"syntax": ["effect.stop()"],
"returns": "void",
"type": "method",
"category": "Effects",
14 changes: 12 additions & 2 deletions content/references/translations/en/sound/LowPass.json
Original file line number Diff line number Diff line change
@@ -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_",
6 changes: 3 additions & 3 deletions content/references/translations/en/sound/LowPass_freq_.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"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.",
"syntax": [".freq(freq)"],
"description": "Sets the cutoff frequency for the filter.",
"syntax": ["filter.freq(freq)"],
"returns": "void",
"type": "method",
"category": "Effects",
19 changes: 14 additions & 5 deletions content/references/translations/en/sound/LowPass_process_.json
Original file line number Diff line number Diff line change
@@ -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": ["filter.process(input, freq)", "filter.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"]
}
]
}
19 changes: 19 additions & 0 deletions content/references/translations/en/sound/LowPass_res_.json
Original file line number Diff line number Diff line change
@@ -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": ["filter.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"]
}
]
}
24 changes: 24 additions & 0 deletions content/references/translations/en/sound/LowPass_set_.json
Original file line number Diff line number Diff line change
@@ -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": ["filter.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"]
}
]
}
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "stop()",
"description": "Stop the effect.",
"syntax": [".stop()"],
"syntax": ["effect.stop()"],
"returns": "void",
"type": "method",
"category": "Effects",
32 changes: 32 additions & 0 deletions content/references/translations/en/sound/MultiChannel.json
Original file line number Diff line number Diff line change
@@ -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": []
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"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": [
"MultiChannel.activeChannel(channel)",
"MultiChannel.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"]
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"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": [
"MultiChannel.availableChannels(deviceId)",
"MultiChannel.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"]
}
]
}
Original file line number Diff line number Diff line change
@@ -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 <code>Sound.list()</code> 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 <code>Sound.list()</code> will show accurate channel \n numbers from the start.\n\n Returns <code>true</code> if PortAudio was successfully loaded.",
"syntax": ["MultiChannel.usePortAudio()"],
"returns": "boolean",
"type": "method",
"category": "I/O",
"subcategory": "MultiChannel",
"classanchor": "MultiChannel",
"parameters": []
}
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "amp()",
"description": "Change the amplitude/volume of this sound.",
"syntax": [".amp(amp)"],
"syntax": ["soundobject.amp(amp)"],
"returns": "void",
"type": "method",
"category": "Noise",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "pan()",
"description": "Move the sound in a stereo panorama.",
"syntax": [".pan(pos)"],
"syntax": ["soundobject.pan(pos)"],
"returns": "void",
"type": "method",
"category": "Noise",
Original file line number Diff line number Diff line change
@@ -3,7 +3,11 @@
"related": [],
"name": "play()",
"description": "Starts the noise",
"syntax": [".play(amp)", ".play(amp, pos)", ".play(amp, add, pos)"],
"syntax": [
"noise.play(amp)",
"noise.play(amp, pos)",
"noise.play(amp, add, pos)"
],
"returns": "void",
"type": "method",
"category": "Noise",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "set()",
"description": "Set the amplitude and panoramic position with one method.",
"syntax": [".set(amp, pos)"],
"syntax": ["noise.set(amp, pos)", "noise.set(amp, add, pos)"],
"returns": "void",
"type": "method",
"category": "Noise",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "stop()",
"description": "Stop the noise from playing back",
"syntax": [".stop()"],
"syntax": ["noise.stop()"],
"returns": "void",
"type": "method",
"category": "Noise",
45 changes: 45 additions & 0 deletions content/references/translations/en/sound/PitchDetector.json
Original file line number Diff line number Diff line change
@@ -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"
]
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"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": [
"pitchdetector.analyze()",
"pitchdetector.analyze(minimumConfidence)",
"pitchdetector.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"]
}
]
}
19 changes: 19 additions & 0 deletions content/references/translations/en/sound/PitchDetector_input_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"brief": "Define the audio input for the analyzer.",
"related": [],
"name": "input()",
"description": "Define the audio input for the analyzer.",
"syntax": ["analyzer.input(input)"],
"returns": "void",
"type": "method",
"category": "Analysis",
"subcategory": "PitchDetector",
"classanchor": "PitchDetector",
"parameters": [
{
"name": "input",
"description": "The input sound source",
"type": ["SoundObject"]
}
]
}
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/Pulse.json
Original file line number Diff line number Diff line change
@@ -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_",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/Pulse_amp_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "amp()",
"description": "Change the amplitude/volume of this sound.",
"syntax": [".amp(amp)"],
"syntax": ["soundobject.amp(amp)"],
"returns": "void",
"type": "method",
"category": "Oscillators",
8 changes: 4 additions & 4 deletions content/references/translations/en/sound/Pulse_freq_.json
Original file line number Diff line number Diff line change
@@ -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": ["oscillator.freq(freq)", "oscillator.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"]
}
]
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/Pulse_pan_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "pan()",
"description": "Move the sound in a stereo panorama.",
"syntax": [".pan(pos)"],
"syntax": ["soundobject.pan(pos)"],
"returns": "void",
"type": "method",
"category": "Oscillators",
7 changes: 3 additions & 4 deletions content/references/translations/en/sound/Pulse_play_.json
Original file line number Diff line number Diff line change
@@ -4,10 +4,9 @@
"name": "play()",
"description": "Starts the oscillator",
"syntax": [
".play()",
".play(freq, amp)",
".play(freq, amp, add)",
".play(freq, amp, add, pos)"
"oscillator.play()",
"oscillator.play(freq, amp)",
"oscillator.play(freq, amp, add, pos)"
],
"returns": "void",
"type": "method",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/Pulse_set_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "set()",
"description": "Set multiple parameters at once",
"syntax": [".set(freq, width, amp, add, pos)"],
"syntax": ["pulse.set(freq, width, amp, add, pos)"],
"returns": "void",
"type": "method",
"category": "Oscillators",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/Pulse_stop_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "stop()",
"description": "Stop the oscillator from playing back",
"syntax": [".stop()"],
"syntax": ["oscillator.stop()"],
"returns": "void",
"type": "method",
"category": "Oscillators",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/Pulse_width_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "width()",
"description": "Changes the pulse width of the pulse oscillator. Allowed values are between 0.0 and 1.0.",
"syntax": [".width(width)"],
"syntax": ["pulse.width(width)"],
"returns": "void",
"type": "method",
"category": "Oscillators",
10 changes: 9 additions & 1 deletion content/references/translations/en/sound/Reverb.json
Original file line number Diff line number Diff line change
@@ -45,5 +45,13 @@
"classanchor": "sound/Reverb",
"category": "Effects",
"subcategory": "Reverb",
"parameters": []
"parameters": [
{
"name": "parent",
"description": "PApplet: typically use \"this\"",
"type": [
"PApplet"
]
}
]
}
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/Reverb_damp_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "damp()",
"description": "Changes the damping factor of the reverb effect.",
"syntax": [".damp(damp)"],
"syntax": ["reverb.damp(damp)"],
"returns": "void",
"type": "method",
"category": "Effects",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "process()",
"description": "Start the effect.",
"syntax": [".process(input)"],
"syntax": ["effect.process(input)"],
"returns": "void",
"type": "method",
"category": "Effects",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/Reverb_room_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "room()",
"description": "Change the room size of the reverb effect.",
"syntax": [".room(room)"],
"syntax": ["reverb.room(room)"],
"returns": "void",
"type": "method",
"category": "Effects",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/Reverb_set_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "set()",
"description": "Set multiple parameters of the reverb. Parameters have to be in the right order.",
"syntax": [".set(room, damp, wet)"],
"syntax": ["reverb.set(room, damp, wet)"],
"returns": "void",
"type": "method",
"category": "Effects",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/Reverb_stop_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "stop()",
"description": "Stop the effect.",
"syntax": [".stop()"],
"syntax": ["effect.stop()"],
"returns": "void",
"type": "method",
"category": "Effects",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/Reverb_wet_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "wet()",
"description": "Change the wet/dry ratio of the reverb.",
"syntax": [".wet(wet)"],
"syntax": ["reverb.wet(wet)"],
"returns": "void",
"type": "method",
"category": "Effects",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/SawOsc.json
Original file line number Diff line number Diff line change
@@ -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_",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/SawOsc_amp_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "amp()",
"description": "Change the amplitude/volume of this sound.",
"syntax": [".amp(amp)"],
"syntax": ["soundobject.amp(amp)"],
"returns": "void",
"type": "method",
"category": "Oscillators",
8 changes: 4 additions & 4 deletions content/references/translations/en/sound/SawOsc_freq_.json
Original file line number Diff line number Diff line change
@@ -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": ["oscillator.freq(freq)", "oscillator.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"]
}
]
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/SawOsc_pan_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "pan()",
"description": "Move the sound in a stereo panorama.",
"syntax": [".pan(pos)"],
"syntax": ["soundobject.pan(pos)"],
"returns": "void",
"type": "method",
"category": "Oscillators",
7 changes: 3 additions & 4 deletions content/references/translations/en/sound/SawOsc_play_.json
Original file line number Diff line number Diff line change
@@ -4,10 +4,9 @@
"name": "play()",
"description": "Starts the oscillator",
"syntax": [
".play()",
".play(freq, amp)",
".play(freq, amp, add)",
".play(freq, amp, add, pos)"
"oscillator.play()",
"oscillator.play(freq, amp)",
"oscillator.play(freq, amp, add, pos)"
],
"returns": "void",
"type": "method",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/SawOsc_set_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "set()",
"description": "Set multiple parameters at once",
"syntax": [".set(freq, amp, pos)"],
"syntax": ["oscillator.set(freq, amp, pos)"],
"returns": "void",
"type": "method",
"category": "Oscillators",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/SawOsc_stop_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "stop()",
"description": "Stop the oscillator from playing back",
"syntax": [".stop()"],
"syntax": ["oscillator.stop()"],
"returns": "void",
"type": "method",
"category": "Oscillators",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/SinOsc.json
Original file line number Diff line number Diff line change
@@ -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_",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/SinOsc_amp_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "amp()",
"description": "Change the amplitude/volume of this sound.",
"syntax": [".amp(amp)"],
"syntax": ["soundobject.amp(amp)"],
"returns": "void",
"type": "method",
"category": "Oscillators",
8 changes: 4 additions & 4 deletions content/references/translations/en/sound/SinOsc_freq_.json
Original file line number Diff line number Diff line change
@@ -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": ["oscillator.freq(freq)", "oscillator.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"]
}
]
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/SinOsc_pan_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "pan()",
"description": "Move the sound in a stereo panorama.",
"syntax": [".pan(pos)"],
"syntax": ["soundobject.pan(pos)"],
"returns": "void",
"type": "method",
"category": "Oscillators",
7 changes: 3 additions & 4 deletions content/references/translations/en/sound/SinOsc_play_.json
Original file line number Diff line number Diff line change
@@ -4,10 +4,9 @@
"name": "play()",
"description": "Starts the oscillator",
"syntax": [
".play()",
".play(freq, amp)",
".play(freq, amp, add)",
".play(freq, amp, add, pos)"
"oscillator.play()",
"oscillator.play(freq, amp)",
"oscillator.play(freq, amp, add, pos)"
],
"returns": "void",
"type": "method",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/SinOsc_set_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "set()",
"description": "Set multiple parameters at once",
"syntax": [".set(freq, amp, pos)"],
"syntax": ["oscillator.set(freq, amp, pos)"],
"returns": "void",
"type": "method",
"category": "Oscillators",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/SinOsc_stop_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "stop()",
"description": "Stop the oscillator from playing back",
"syntax": [".stop()"],
"syntax": ["oscillator.stop()"],
"returns": "void",
"type": "method",
"category": "Oscillators",
9 changes: 7 additions & 2 deletions content/references/translations/en/sound/Sound.json
Original file line number Diff line number Diff line change
@@ -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",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "amp()",
"description": "Change the amplitude/volume of this audiosample.",
"syntax": [".amp(amp)"],
"syntax": ["soundfile.amp(amp)"],
"returns": "void",
"type": "method",
"category": "Sampling",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "channels()",
"description": "Returns the number of channels of the soundfile as an int (1 for mono, 2 for stereo).",
"syntax": [".channels()"],
"syntax": ["soundfile.channels()"],
"returns": "int",
"type": "method",
"category": "Sampling",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "cue()",
"description": "Cues the playhead to a fixed position in the soundfile. Note that <b>cue()</b> only \n affects the playhead for future calls to <b>play()</b>, but not to <b>loop()</b>.",
"syntax": [".cue(time)"],
"syntax": ["soundfile.cue(time)"],
"returns": "void",
"type": "method",
"category": "Sampling",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "duration()",
"description": "Returns the duration of the soundfile in seconds.",
"syntax": [".duration()"],
"syntax": ["soundfile.duration()"],
"returns": "float",
"type": "method",
"category": "Sampling",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "frames()",
"description": "Returns the number of frames of this soundfile.",
"syntax": [".frames()"],
"syntax": ["soundfile.frames()"],
"returns": "int",
"type": "method",
"category": "Sampling",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "isPlaying()",
"description": "Check whether this soundfile is currently playing.",
"syntax": [".isPlaying()"],
"syntax": ["soundfile.isPlaying()"],
"returns": "boolean",
"type": "method",
"category": "Sampling",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "jump()",
"description": "Jump to a specific position in the soundfile while continuing to play \n (or starting to play if it wasn't playing already).",
"syntax": [".jump(time)"],
"syntax": ["soundfile.jump(time)"],
"returns": "void",
"type": "method",
"category": "Sampling",
10 changes: 5 additions & 5 deletions content/references/translations/en/sound/SoundFile_loop_.json
Original file line number Diff line number Diff line change
@@ -4,11 +4,11 @@
"name": "loop()",
"description": "Starts playback which will loop at the end of the soundfile.",
"syntax": [
".loop()",
".loop(rate)",
".loop(rate, amp)",
".loop(rate, pos, amp)",
".loop(rate, pos, amp, add)"
"soundfile.loop()",
"soundfile.loop(rate)",
"soundfile.loop(rate, amp)",
"soundfile.loop(rate, pos, amp)",
"soundfile.loop(rate, pos, amp, add)"
],
"returns": "void",
"type": "method",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "pan()",
"description": "Move the sound in a stereo panorama.-1.0 pans to the left channel and 1.0 to the \n right channel. Note that panning is only supported for mono (1 channel) soundfiles.",
"syntax": [".pan(pos)"],
"syntax": ["soundfile.pan(pos)"],
"returns": "void",
"type": "method",
"category": "Sampling",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "pause()",
"description": "Stop the playback of the file, but cue it to the current position. The\n next call to <b>play()</b> will continue playing where it left off.",
"syntax": [".pause()"],
"syntax": ["soundfile.pause()"],
"returns": "void",
"type": "method",
"category": "Sampling",
12 changes: 6 additions & 6 deletions content/references/translations/en/sound/SoundFile_play_.json
Original file line number Diff line number Diff line change
@@ -4,12 +4,12 @@
"name": "play()",
"description": "Starts the playback of the soundfile. Only plays to the end of the\n audiosample once. If <b>cue()</b> or <b>pause()</b> were called previously, playback \n will resume from the cued position.",
"syntax": [
".play()",
".play(rate)",
".play(rate, amp)",
".play(rate, pos, amp)",
".play(rate, pos, amp, add)",
".play(rate, pos, amp, add, cue)"
"soundfile.play()",
"soundfile.play(rate)",
"soundfile.play(rate, amp)",
"soundfile.play(rate, pos, amp)",
"soundfile.play(rate, pos, amp, add)",
"soundfile.play(rate, pos, amp, add, cue)"
],
"returns": "void",
"type": "method",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "rate()",
"description": "Set the playback rate of the soundfile. 1 is the original speed. 0.5 is half speed \n and one octave down. 2 is double the speed and one octave up.",
"syntax": [".rate(rate)"],
"syntax": ["soundfile.rate(rate)"],
"returns": "void",
"type": "method",
"category": "Sampling",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "removeFromCache()",
"description": "Remove this SoundFile's decoded audio sample from the cache, allowing\n it to be garbage collected once there are no more references to this\n SoundFile.",
"syntax": [".removeFromCache()"],
"syntax": ["soundfile.removeFromCache()"],
"returns": "boolean",
"type": "method",
"category": "Sampling",
13 changes: 0 additions & 13 deletions content/references/translations/en/sound/SoundFile_stop_.json

This file was deleted.

Original file line number Diff line number Diff line change
@@ -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": ["Sound.inputDevice(deviceId)", "Sound.inputDevice(deviceName)"],
"returns": "int",
"type": "method",
"category": "Configuration",
"subcategory": "Sound",
12 changes: 9 additions & 3 deletions content/references/translations/en/sound/Sound_list_.json
Original file line number Diff line number Diff line change
@@ -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 <b>Sound.list()</b> 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": ["Sound.list(filter)", "Sound.list()", "Sound.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"]
}
]
}
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
{
"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": ["Sound.outputDevice(deviceId)", "Sound.outputDevice(deviceName)"],
"returns": "int",
"type": "method",
"category": "Configuration",
"subcategory": "Sound",
"classanchor": "Sound",
"parameters": [
{
"name": "deviceId",
"description": "the device id obtained from list()",
"description": "the device id obtained from Sound.list()",
"type": ["int"]
}
]
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "sampleRate()",
"description": "Get or set the internal sample rate of the synthesis engine.",
"syntax": [".sampleRate()", ".sampleRate(sampleRate)"],
"syntax": ["Sound.sampleRate()", "Sound.sampleRate(sampleRate)"],
"returns": "int",
"type": "method",
"category": "Configuration",
13 changes: 13 additions & 0 deletions content/references/translations/en/sound/Sound_status_.json
Original file line number Diff line number Diff line change
@@ -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": ["Sound.status()"],
"returns": "void",
"type": "method",
"category": "Configuration",
"subcategory": "Sound",
"classanchor": "Sound",
"parameters": []
}
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "volume()",
"description": "Set the overall output volume of the Processing sound library.",
"syntax": [".volume(volume)"],
"syntax": ["Sound.volume(volume)"],
"returns": "void",
"type": "method",
"category": "Configuration",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/SqrOsc.json
Original file line number Diff line number Diff line change
@@ -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_",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/SqrOsc_amp_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "amp()",
"description": "Change the amplitude/volume of this sound.",
"syntax": [".amp(amp)"],
"syntax": ["soundobject.amp(amp)"],
"returns": "void",
"type": "method",
"category": "Oscillators",
8 changes: 4 additions & 4 deletions content/references/translations/en/sound/SqrOsc_freq_.json
Original file line number Diff line number Diff line change
@@ -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": ["oscillator.freq(freq)", "oscillator.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"]
}
]
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/SqrOsc_pan_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "pan()",
"description": "Move the sound in a stereo panorama.",
"syntax": [".pan(pos)"],
"syntax": ["soundobject.pan(pos)"],
"returns": "void",
"type": "method",
"category": "Oscillators",
7 changes: 3 additions & 4 deletions content/references/translations/en/sound/SqrOsc_play_.json
Original file line number Diff line number Diff line change
@@ -4,10 +4,9 @@
"name": "play()",
"description": "Starts the oscillator",
"syntax": [
".play()",
".play(freq, amp)",
".play(freq, amp, add)",
".play(freq, amp, add, pos)"
"oscillator.play()",
"oscillator.play(freq, amp)",
"oscillator.play(freq, amp, add, pos)"
],
"returns": "void",
"type": "method",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/SqrOsc_set_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "set()",
"description": "Set multiple parameters at once",
"syntax": [".set(freq, amp, pos)"],
"syntax": ["oscillator.set(freq, amp, pos)"],
"returns": "void",
"type": "method",
"category": "Oscillators",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/SqrOsc_stop_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "stop()",
"description": "Stop the oscillator from playing back",
"syntax": [".stop()"],
"syntax": ["oscillator.stop()"],
"returns": "void",
"type": "method",
"category": "Oscillators",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/TriOsc.json
Original file line number Diff line number Diff line change
@@ -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_",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/TriOsc_amp_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "amp()",
"description": "Change the amplitude/volume of this sound.",
"syntax": [".amp(amp)"],
"syntax": ["soundobject.amp(amp)"],
"returns": "void",
"type": "method",
"category": "Oscillators",
8 changes: 4 additions & 4 deletions content/references/translations/en/sound/TriOsc_freq_.json
Original file line number Diff line number Diff line change
@@ -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": ["oscillator.freq(freq)", "oscillator.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"]
}
]
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/TriOsc_pan_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "pan()",
"description": "Move the sound in a stereo panorama.",
"syntax": [".pan(pos)"],
"syntax": ["soundobject.pan(pos)"],
"returns": "void",
"type": "method",
"category": "Oscillators",
7 changes: 3 additions & 4 deletions content/references/translations/en/sound/TriOsc_play_.json
Original file line number Diff line number Diff line change
@@ -4,10 +4,9 @@
"name": "play()",
"description": "Starts the oscillator",
"syntax": [
".play()",
".play(freq, amp)",
".play(freq, amp, add)",
".play(freq, amp, add, pos)"
"oscillator.play()",
"oscillator.play(freq, amp)",
"oscillator.play(freq, amp, add, pos)"
],
"returns": "void",
"type": "method",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/TriOsc_set_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "set()",
"description": "Set multiple parameters at once",
"syntax": [".set(freq, amp, pos)"],
"syntax": ["oscillator.set(freq, amp, pos)"],
"returns": "void",
"type": "method",
"category": "Oscillators",
2 changes: 1 addition & 1 deletion content/references/translations/en/sound/TriOsc_stop_.json
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "stop()",
"description": "Stop the oscillator from playing back",
"syntax": [".stop()"],
"syntax": ["oscillator.stop()"],
"returns": "void",
"type": "method",
"category": "Oscillators",
4 changes: 2 additions & 2 deletions content/references/translations/en/sound/Waveform.json
Original file line number Diff line number Diff line change
@@ -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 <b>analyze()</b>\n method.",
"description": "This is a Waveform analyzer. It returns the waveform of an \n audio stream the moment it is queried with the <b>analyze()</b>\n method.<br/>\n Note that by default all sound generators (including microphone capture from\n <code>AudioIn</code>) have an amplitude of 1, which means that the values of \n their waveform will be numbers in the range <code>[-0.5, 0.5]</code>.",
"type": "class",
"constructors": [
"Waveform(parent, nsamples)"
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "analyze()",
"description": "Gets the content of the current audiobuffer from the input source.",
"syntax": [".analyze()", ".analyze(value)"],
"syntax": ["waveform.analyze()", "waveform.analyze(value)"],
"returns": "float[]",
"type": "method",
"category": "Analysis",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "input()",
"description": "Define the audio input for the analyzer.",
"syntax": [".input(input)"],
"syntax": ["waveform.input(input)"],
"returns": "void",
"type": "method",
"category": "Analysis",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "amp()",
"description": "Change the amplitude/volume of this sound.",
"syntax": [".amp(amp)"],
"syntax": ["soundobject.amp(amp)"],
"returns": "void",
"type": "method",
"category": "Noise",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "pan()",
"description": "Move the sound in a stereo panorama.",
"syntax": [".pan(pos)"],
"syntax": ["soundobject.pan(pos)"],
"returns": "void",
"type": "method",
"category": "Noise",
Original file line number Diff line number Diff line change
@@ -3,7 +3,11 @@
"related": [],
"name": "play()",
"description": "Starts the noise",
"syntax": [".play(amp)", ".play(amp, pos)", ".play(amp, add, pos)"],
"syntax": [
"noise.play(amp)",
"noise.play(amp, pos)",
"noise.play(amp, add, pos)"
],
"returns": "void",
"type": "method",
"category": "Noise",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "set()",
"description": "Set the amplitude and panoramic position with one method.",
"syntax": [".set(amp, pos)"],
"syntax": ["noise.set(amp, pos)", "noise.set(amp, add, pos)"],
"returns": "void",
"type": "method",
"category": "Noise",
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
"related": [],
"name": "stop()",
"description": "Stop the noise from playing back",
"syntax": [".stop()"],
"syntax": ["noise.stop()"],
"returns": "void",
"type": "method",
"category": "Noise",