Update docstring and add an example

This commit is contained in:
Aria
2026-01-11 19:10:02 -06:00
parent 6bd1c877aa
commit c3018a29a0
2 changed files with 18 additions and 1 deletions
+5 -1
View File
@@ -3081,6 +3081,10 @@ export const { FXrelease, FXrel, FXr, fxr } = registerControl('FXrelease', 'FXre
* Input audio device to be used as a sound source in a pattern
*
* @name input
* @param {string | Pattern} inputName Name of the input audio device to use
* @param {string | number | Pattern} input Name or index of the input audio device to use
* @example
* // Please be careful about feedback!
* input("1 2").gain(0.5)
* .stretch(0.5).lfo({ s: 0.5 })
*/
export const { input } = registerControl('input');
+13
View File
@@ -5484,6 +5484,19 @@ exports[`runs examples > example "inhabit" example index 1 1`] = `
]
`;
exports[`runs examples > example "input" example index 0 1`] = `
[
"[ 0/1 → 1/2 | input:1 gain:0.5 stretch:0.5 lfo:{0:{control:stretch sync:0.5} __ids:{}} ]",
"[ 1/2 → 1/1 | input:2 gain:0.5 stretch:0.5 lfo:{0:{control:stretch sync:0.5} __ids:{}} ]",
"[ 1/1 → 3/2 | input:1 gain:0.5 stretch:0.5 lfo:{0:{control:stretch sync:0.5} __ids:{}} ]",
"[ 3/2 → 2/1 | input:2 gain:0.5 stretch:0.5 lfo:{0:{control:stretch sync:0.5} __ids:{}} ]",
"[ 2/1 → 5/2 | input:1 gain:0.5 stretch:0.5 lfo:{0:{control:stretch sync:0.5} __ids:{}} ]",
"[ 5/2 → 3/1 | input:2 gain:0.5 stretch:0.5 lfo:{0:{control:stretch sync:0.5} __ids:{}} ]",
"[ 3/1 → 7/2 | input:1 gain:0.5 stretch:0.5 lfo:{0:{control:stretch sync:0.5} __ids:{}} ]",
"[ 7/2 → 4/1 | input:2 gain:0.5 stretch:0.5 lfo:{0:{control:stretch sync:0.5} __ids:{}} ]",
]
`;
exports[`runs examples > example "inside" example index 0 1`] = `
[
"[ 0/1 → 1/8 | note:D3 ]",