From ea6d728b8944a7ad3c70168f55f328645947dd14 Mon Sep 17 00:00:00 2001 From: Felix Roos Date: Sun, 29 May 2022 15:07:01 +0200 Subject: [PATCH] link webdirt - superdirt controls --- doc.json | 4 +-- packages/webdirt/webdirt.mjs | 51 ++++++++++++++++++------------------ 2 files changed, 27 insertions(+), 28 deletions(-) diff --git a/doc.json b/doc.json index 29ff392a..e8a5beba 100644 --- a/doc.json +++ b/doc.json @@ -3740,7 +3740,7 @@ "___s": true }, { - "comment": "/**\n *\n * Uses [webdirt](https://github.com/dktr0/WebDirt) as output.\n *\n *
\n * show supported Webdirt controls\n *\n * - s :: String, -- name of sample bank (ie. old-style with sampleMap)\n * - n :: Int, -- number of sample within a bank (ie. old-style with sampleMap)\n * - whenPosix :: Number, -- when to play the sample, in POSIX/epoch-1970 time\n * - when :: Number, -- when to play the sample, in audio context time\n * - gain :: Number, -- clamped from 0 to 2; 1 is default and full-scale\n * - overgain :: Number, -- additional gain added to gain to go past clamp at 2\n * - pan :: Number, -- range: 0 to 1\n * - nudge :: Number, -- nudge the time of the sample forwards/backwards in seconds\n * - speed :: Number,\n * - note :: Number,\n * - begin :: Number,\n * - end :: Number,\n * - cut :: Int,\n * - shape :: Number,\n * - cutoff :: Number,\n * - resonance :: Number,\n * - hcutoff :: Number,\n * - hresonance :: Number,\n * - bandf :: Number,\n * - bandq :: Number,\n * - vowel :: String,\n * - delay :: Number,\n * - delaytime :: Number,\n * - delayfeedback :: Number,\n * - loop :: Number,\n * - crush :: Number,\n * - coarse :: Number,\n * - unit :: String\n *\n *
\n *\n * @name webdirt\n * @memberof Pattern\n * @returns Pattern\n * @example\n * s(\"bd*2 hh sd hh\").n(\"<0 1>\").webdirt()\n */", + "comment": "/**\n *\n * Uses [webdirt](https://github.com/dktr0/WebDirt) as output.\n *\n *
\n * show supported Webdirt controls\n *\n * - s :: String, -- name of sample bank\n * - n :: Int, -- number of sample within a bank\n * - {@link gain} :: Number, -- clamped from 0 to 2; 1 is default and full-scale\n * - {@link overgain} :: Number, -- additional gain added to gain to go past clamp at 2\n * - {@link pan} :: Number, -- range: 0 to 1\n * - {@link nudge} :: Number, -- nudge the time of the sample forwards/backwards in seconds\n * - {@link speed} :: Number, -- speed / pitch of the sample\n * - {@link unit} :: String\n * - {@link note} :: Number, -- pitch offset in semitones\n * - {@link begin} :: Number, -- cut from sample start, normalized\n * - {@link end} :: Number, -- cut from sample end, normalized\n * - {@link cut} :: Int, -- samples with same cut number will interupt each other\n * - {@link shape} :: Number,\n * - {@link cutoff} :: Number, -- lowpass filter frequency\n * - {@link resonance} :: Number, -- lowpass filter resonance\n * - {@link hcutoff} :: Number, -- highpass filter frequency\n * - {@link hresonance} :: Number, -- highpass filter resonance\n * - {@link bandf} :: Number, -- bandpass filter frequency\n * - {@link bandq} :: Number, -- bandpass filter resonance\n * - {@link vowel} :: String, -- name of vowel ('a' | 'e' | 'i' | 'o' | 'u')\n * - {@link delay} :: Number, -- delay wet/dry mix\n * - {@link delaytime} :: Number, -- delay time in seconds\n * - {@link delayfeedback} :: Number, -- delay feedback\n * - {@link loop} :: Number, -- loop sample n times (relative to sample length)\n * - {@link crush} :: Number, -- bitcrusher (currently not working)\n * - {@link coarse} :: Number, -- coarse effect (currently not working)\n\n *\n *
\n *\n * @name webdirt\n * @memberof Pattern\n * @returns Pattern\n * @example\n * s(\"bd*2 hh sd hh\").n(\"<0 1>\").webdirt()\n */", "meta": { "filename": "webdirt.mjs", "lineno": 19, @@ -3748,7 +3748,7 @@ "path": "/home/felix/projects/strudel/packages/webdirt", "code": {} }, - "description": "

Uses webdirt as output.

\n
\nshow supported Webdirt controls\n\n
", + "description": "

Uses webdirt as output.

\n
\nshow supported Webdirt controls\n\n
", "name": "webdirt", "memberof": "Pattern", "returns": [ diff --git a/packages/webdirt/webdirt.mjs b/packages/webdirt/webdirt.mjs index 79ac0049..ea4eaa1f 100644 --- a/packages/webdirt/webdirt.mjs +++ b/packages/webdirt/webdirt.mjs @@ -23,34 +23,33 @@ export function loadWebDirt(config) { *
* show supported Webdirt controls * - * - s :: String, -- name of sample bank (ie. old-style with sampleMap) - * - n :: Int, -- number of sample within a bank (ie. old-style with sampleMap) - * - whenPosix :: Number, -- when to play the sample, in POSIX/epoch-1970 time - * - when :: Number, -- when to play the sample, in audio context time - * - gain :: Number, -- clamped from 0 to 2; 1 is default and full-scale + * - s :: String, -- name of sample bank + * - n :: Int, -- number of sample within a bank + * - {@link gain} :: Number, -- clamped from 0 to 2; 1 is default and full-scale * - overgain :: Number, -- additional gain added to gain to go past clamp at 2 - * - pan :: Number, -- range: 0 to 1 + * - {@link pan} :: Number, -- range: 0 to 1 * - nudge :: Number, -- nudge the time of the sample forwards/backwards in seconds - * - speed :: Number, - * - note :: Number, - * - begin :: Number, - * - end :: Number, - * - cut :: Int, - * - shape :: Number, - * - cutoff :: Number, - * - resonance :: Number, - * - hcutoff :: Number, - * - hresonance :: Number, - * - bandf :: Number, - * - bandq :: Number, - * - vowel :: String, - * - delay :: Number, - * - delaytime :: Number, - * - delayfeedback :: Number, - * - loop :: Number, - * - crush :: Number, - * - coarse :: Number, - * - unit :: String + * - {@link speed} :: Number, -- speed / pitch of the sample + * - {@link unit} :: String + * - note :: Number, -- pitch offset in semitones + * - {@link begin} :: Number, -- cut from sample start, normalized + * - {@link end} :: Number, -- cut from sample end, normalized + * - {@link cut} :: Int, -- samples with same cut number will interupt each other + * - {@link cutoff} :: Number, -- lowpass filter frequency + * - {@link resonance} :: Number, -- lowpass filter resonance + * - {@link hcutoff} :: Number, -- highpass filter frequency + * - {@link hresonance} :: Number, -- highpass filter resonance + * - {@link bandf} :: Number, -- bandpass filter frequency + * - {@link bandq} :: Number, -- bandpass filter resonance + * - {@link vowel} :: String, -- name of vowel ('a' | 'e' | 'i' | 'o' | 'u') + * - delay :: Number, -- delay wet/dry mix + * - delaytime :: Number, -- delay time in seconds + * - delayfeedback :: Number, -- delay feedback + * - {@link loop} :: Number, -- loop sample n times (relative to sample length) + * - {@link crush} :: Number, -- bitcrusher (currently not working) + * - {@link coarse} :: Number, -- coarse effect (currently not working) + * - {@link shape} :: Number, -- (currently not working) + * *
*