Skip to content

Commit

Permalink
Wrangling types
Browse files Browse the repository at this point in the history
  • Loading branch information
stalgiag committed Feb 29, 2024
1 parent 61b3ce0 commit 8fdfb51
Show file tree
Hide file tree
Showing 59 changed files with 198 additions and 158 deletions.
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.Amplitude.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ description: |
Listens to all p5sound by default, or use setInput()
to listen to a specific sound source. Accepts an optional
smoothing value, which defaults to 0.</p>
isConstructor: true
line: 3022
isConstructor: true
params:
- name: smoothing
description: |
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.AudioIn.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ description: >-
is limited to localhost and https, but access over http may be
limited.</em></p>
isConstructor: true
line: 6015
isConstructor: true
params:
- name: errorCallback
description: |
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.AudioVoice.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ description: |
<p>Base class for monophonic synthesizers. Any extensions of this class
should follow the API and implement the methods below in order to
remain compatible with p5.PolySynth();</p>
isConstructor: true
line: 11149
isConstructor: true
chainable: false
---

Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.BandPass.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ description: |
This is the same as creating a p5.Filter and then calling
its method <code>setType('bandpass')</code>.
See p5.Filter for methods.</p>
isConstructor: true
line: 6962
isConstructor: true
chainable: false
---

Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.Compressor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ description: >
<a href = "/reference/#/p5.Effect/disconnect">disconnect()</a> are
available.</p>
isConstructor: true
line: 10036
isConstructor: true
chainable: false
---

Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.Convolver.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ description: |-
<p>Use the method <code>createConvolution(path)</code> to instantiate a
p5.Convolver with a path to your impulse response audio file.</p>
isConstructor: true
line: 8549
isConstructor: true
params:
- name: path
description: |
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.Delay.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ description: >
<a href = "/reference/#/p5.Effect/disconnect">disconnect()</a> are
available.</p>
isConstructor: true
line: 7926
isConstructor: true
example:
- |-
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.Distortion.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ description: >
<a href = "/reference/#/p5.Effect/disconnect">disconnect()</a> are
available.</p>
isConstructor: true
line: 10816
isConstructor: true
params:
- name: amount
description: |
Expand Down
5 changes: 1 addition & 4 deletions src/content/reference/en/p5.sound/p5.EQ.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ description: >
<a href = "/reference/#/p5.Effect/disconnect">disconnect()</a> are
available.</p>
isConstructor: true
line: 7105
isConstructor: true
params:
- name: _eqsize
description: |
Expand Down Expand Up @@ -97,9 +97,6 @@ example:
eq.bands[eqBandIndex].gain(-40);
}
</code></div>
return:
description: p5.EQ object
type: Object
chainable: false
---

Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.Effect.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ description: >
<a href="/reference/#/p5.Filter">p5.Filter</a>,
<a href="/reference/#/p5.Reverb">p5.Reverb</a>.</p>
isConstructor: true
line: 6423
isConstructor: true
params:
- name: ac
description: |
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.Envelope.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ description: >-
<code><a href="#/p5.Envelope/triggerRelease">triggerRelease</a></code> to
trigger noteOn/noteOff.</p>
isConstructor: true
line: 4721
isConstructor: true
example:
- |-
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.FFT.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ description: |-
correctly. The actual size of the FFT buffer is twice the
number of bins, so given a standard sample rate, the buffer is
2048/44100 seconds long.</p>
isConstructor: true
line: 3347
isConstructor: true
params:
- name: smoothing
description: |
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.Filter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ description: >
<a href = "/reference/#/p5.Effect/disconnect">disconnect()</a> are
available.</p>
isConstructor: true
line: 6628
isConstructor: true
params:
- name: type
description: |
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.Gain.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ file: lib/addons/p5.sound.js
description: |
<p>A gain node is usefull to set the relative volume of sound.
It's typically used to build mixers.</p>
isConstructor: true
line: 10973
isConstructor: true
example:
- |-
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.HighPass.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ description: |
This is the same as creating a p5.Filter and then calling
its method <code>setType('highpass')</code>.
See p5.Filter for methods.</p>
isConstructor: true
line: 6938
isConstructor: true
chainable: false
---

Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.LowPass.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ description: |
This is the same as creating a p5.Filter and then calling
its method <code>setType('lowpass')</code>.
See p5.Filter for methods.</p>
isConstructor: true
line: 6914
isConstructor: true
chainable: false
---

Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.MonoSynth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ description: |
This is a class to be used in conjunction with the PolySynth
class. Custom synthetisers should be built inheriting from
this class.</p>
isConstructor: true
line: 11247
isConstructor: true
example:
- |-
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.Noise.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ file: lib/addons/p5.sound.js
description: >
<p>Noise is a type of oscillator that generates a buffer with random
values.</p>
isConstructor: true
line: 5620
isConstructor: true
params:
- name: type
description: |
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.OnsetDetect.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ file: lib/addons/p5.sound.js
description: |
<p>Listen for onsets (a sharp increase in volume) within a given
frequency range.</p>
isConstructor: true
line: 11624
isConstructor: true
params:
- name: freqLow
description: |
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.Oscillator.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ description: |-
href="/reference/#/p5.SqrOsc">p5.SqrOsc</a>, or <a
href="/reference/#/p5.SawOsc">p5.SawOsc</a>.
</p>
isConstructor: true
line: 4060
isConstructor: true
params:
- name: freq
description: |
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.Panner3D.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ description: |
"https://developer.mozilla.org/en-US/docs/Web/API/AudioListener">
Audio Context Listener</a>, which can be accessed
by <code>p5.soundOut.audiocontext.listener</code></p>
isConstructor: true
line: 7602
isConstructor: true
chainable: false
---

Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.Part.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ description: |-
with steps and tatums. By default, each step represents a 1/16th note.</p>
<p>See p5.Phrase for more about musical timing.</p>
isConstructor: true
line: 9185
isConstructor: true
params:
- name: steps
description: |
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.PeakDetect.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ description: >-
target="_blank">Felix Turner</a>.
</p>
isConstructor: true
line: 10312
isConstructor: true
params:
- name: freq1
description: |
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.Phrase.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ description: |-
which value is passed into the callback at each step of the
phrase. It can be numbers, an object with multiple numbers,
or a zero (0) indicates a rest so the callback won't be called).</p>
isConstructor: true
line: 9103
isConstructor: true
params:
- name: name
description: |
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.PolySynth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ description: |
The PolySynth class holds an array of AudioVoice, and deals
with voices allocations, with setting notes to be played, and
parameters to be set.</p>
isConstructor: true
line: 11691
isConstructor: true
params:
- name: synthVoice
description: |
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.Pulse.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ description: |
width between the pulses. See <a href="
http://p5js.org/reference/#/p5.Oscillator">
<code>p5.Oscillator</code> for a full list of methods.</p>
isConstructor: true
line: 5779
isConstructor: true
params:
- name: freq
description: |
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.Reverb.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ description: >
<a href = "/reference/#/p5.Effect/disconnect">disconnect()</a> are
available.</p>
isConstructor: true
line: 8308
isConstructor: true
example:
- |-
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.SawOsc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ description: |
</code> or creating a p5.Oscillator and then calling
its method <code>setType('sawtooth')</code>.
See p5.Oscillator for methods.</p>
isConstructor: true
line: 4656
isConstructor: true
params:
- name: freq
description: |
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.Score.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ description: |
be played back in order. For example, you could have an
A part, a B part, and a C part, and play them back in this order
<code>new p5.Score(a, a, b, a, c)</code></p>
isConstructor: true
line: 9493
isConstructor: true
params:
- name: parts
description: |
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.SinOsc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ description: |
</code> or creating a p5.Oscillator and then calling
its method <code>setType('sine')</code>.
See p5.Oscillator for methods.</p>
isConstructor: true
line: 4602
isConstructor: true
params:
- name: freq
description: |
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.SoundFile.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ description: |-
web browsers. If you want to ensure compatability, instead of a single
file path, you may include an Array of filepaths, and the browser will
choose a format that works.</p>
isConstructor: true
line: 1405
isConstructor: true
params:
- name: path
description: |
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.SoundLoop.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ submodule: p5.sound
file: lib/addons/p5.sound.js
description: |
<p>SoundLoop</p>
isConstructor: true
line: 9673
isConstructor: true
params:
- name: callback
description: |
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.SoundRecorder.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ description: |-
When playback is stopped (either after the given amount of time,
or with the stop() method), the p5.SoundRecorder will send its
recording to that p5.SoundFile for playback.</p>
isConstructor: true
line: 10559
isConstructor: true
example:
- |-
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.SqrOsc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ description: |
</code> or creating a p5.Oscillator and then calling
its method <code>setType('square')</code>.
See p5.Oscillator for methods.</p>
isConstructor: true
line: 4683
isConstructor: true
params:
- name: freq
description: |
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.sound/p5.TriOsc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ description: |
</code> or creating a p5.Oscillator and then calling
its method <code>setType('triangle')</code>.
See p5.Oscillator for methods.</p>
isConstructor: true
line: 4629
isConstructor: true
params:
- name: freq
description: |
Expand Down
Loading

0 comments on commit 8fdfb51

Please sign in to comment.