hacklab/strudel
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

more logical naming + update docs

Browse source
This commit is contained in:
Felix Roos 2023-10-03 08:35:15 +02:00
parent dcd75e0384
commit a3649148c1
3 changed files with 47 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

43
packages/core/controls.mjs
View file

@ -972,53 +972,62 @@ const generic_params = [
[['room', 'size']],
/**
* Reverb lowpass starting frequency (in hertz).
* When this property is changed, the reverb will be recaculated, so only change this sparsely..
*
* @name revlp
* @param {number} level between 0 and 20000hz
* @name roomlp
* @synonyms rlp
* @param {number} frequency between 0 and 20000hz
* @example
* s("bd sd").room(0.5).revlp(10000)
* s("bd sd").room(0.5).rlp(10000)
* @example
* s("bd sd").room(0.5).revlp(5000)
* s("bd sd").room(0.5).rlp(5000)
*/
['revlp'],
['roomlp', 'rlp'],
/**
* Reverb lowpass frequency at -60dB (in hertz).
* When this property is changed, the reverb will be recaculated, so only change this sparsely..
*
* @name revdim
* @param {number} level between 0 and 20000hz
* @name roomdim
* @synonyms rdim
* @param {number} frequency between 0 and 20000hz
* @example
* s("bd sd").room(0.5).revlp(10000).revdim(8000)
* s("bd sd").room(0.5).rlp(10000).rdim(8000)
* @example
* s("bd sd").room(0.5).revlp(5000).revdim(400)
* s("bd sd").room(0.5).rlp(5000).rdim(400)
*
*/
['revdim'],
['roomdim', 'rdim'],
/**
* Reverb fade time (in seconds).
* When this property is changed, the reverb will be recaculated, so only change this sparsely..
*
* @name fade
* @name roomfade
* @synonyms rfade
* @param {number} seconds for the reverb to fade
* @example
* s("bd sd").room(0.5).revlp(10000).fade(0.5)
* s("bd sd").room(0.5).rlp(10000).rfade(0.5)
* @example
* s("bd sd").room(0.5).revlp(5000).fade(4)
* s("bd sd").room(0.5).rlp(5000).rfade(4)
*
*/
['fade'],
['roomfade', 'rfade'],
/**
* Sets the room size of the reverb, see {@link room}.
* When this property is changed, the reverb will be recaculated, so only change this sparsely..
*
* @name roomsize
* @param {number | Pattern} size between 0 and 10
* @synonyms size, sz
* @synonyms rsize, sz, size
* @example
* s("bd sd").room(.8).roomsize("<0 1 2 4 8>")
* s("bd sd").room(.8).rsize(1)
* @example
* s("bd sd").room(.8).rsize(4)
*
*/
// TODO: find out why :
// s("bd sd").room(.8).roomsize("<0 .2 .4 .6 .8 [1,0]>").osc()
// .. does not work. Is it because room is only one effect?
['size', 'sz', 'roomsize'],
['roomsize', 'size', 'sz', 'rsize'],
// ['sagogo'],
// ['sclap'],
// ['sclaves'],