From bfdfab0a007ef880678e34f964a332551dab50b9 Mon Sep 17 00:00:00 2001 From: Felix Roos Date: Wed, 9 Jul 2025 09:33:11 +0200 Subject: [PATCH 1/2] fix: @synonym -> @synonyms --- jsdoc/jsdoc-synonyms.js | 2 +- packages/core/controls.mjs | 2 +- packages/core/pattern.mjs | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/jsdoc/jsdoc-synonyms.js b/jsdoc/jsdoc-synonyms.js index 0b52420bc..d59c8dac4 100644 --- a/jsdoc/jsdoc-synonyms.js +++ b/jsdoc/jsdoc-synonyms.js @@ -1,5 +1,5 @@ /* -jsdoc-synonyms.js - Add support for @synonym tag +jsdoc-synonyms.js - Add support for @synonyms tag Copyright (C) 2023 Strudel contributors - see This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with this program. If not, see . */ diff --git a/packages/core/controls.mjs b/packages/core/controls.mjs index a0f5d10e3..5eb8e5da8 100644 --- a/packages/core/controls.mjs +++ b/packages/core/controls.mjs @@ -448,7 +448,7 @@ export const { coarse } = registerControl('coarse'); * modulate the amplitude of a sound with a continuous waveform * * @name am - * @synonym tremolo + * @synonyms tremolo * @param {number | Pattern} speed modulation speed in HZ * @example * s("triangle").am("2").amshape("").amdepth(.5) diff --git a/packages/core/pattern.mjs b/packages/core/pattern.mjs index d9bb94075..d59a1285d 100644 --- a/packages/core/pattern.mjs +++ b/packages/core/pattern.mjs @@ -2522,7 +2522,7 @@ export const { fastchunk, fastChunk } = register( /** * Like `chunk`, but the function is applied to a looped subcycle of the source pattern. * @name chunkInto - * @synonym chunkinto + * @synonyms chunkinto * @memberof Pattern * @example * sound("bd sd ht lt bd - cp lt").chunkInto(4, hurry(2)) @@ -2535,7 +2535,7 @@ export const { chunkinto, chunkInto } = register(['chunkinto', 'chunkInto'], fun /** * Like `chunkInto`, but moves backwards through the chunks. * @name chunkBackInto - * @synonym chunkbackinto + * @synonyms chunkbackinto * @memberof Pattern * @example * sound("bd sd ht lt bd - cp lt").chunkInto(4, hurry(2)) @@ -2565,7 +2565,7 @@ export const bypass = register( * Loops the pattern inside an `offset` for `cycles`. * If you think of the entire span of time in cycles as a ribbon, you can cut a single piece and loop it. * @name ribbon - * @synonym rib + * @synonyms rib * @param {number} offset start point of loop in cycles * @param {number} cycles loop length in cycles * @example From cf7fc23981df38e2fffdc25c675a3ec615188704 Mon Sep 17 00:00:00 2001 From: Felix Roos Date: Wed, 9 Jul 2025 09:33:28 +0200 Subject: [PATCH 2/2] add new am examples to doc --- website/src/pages/learn/effects.mdx | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/website/src/pages/learn/effects.mdx b/website/src/pages/learn/effects.mdx index 2f7eaa7f8..9c96dbe31 100644 --- a/website/src/pages/learn/effects.mdx +++ b/website/src/pages/learn/effects.mdx @@ -57,6 +57,34 @@ Each filter has 2 parameters: +# Amplitude Modulation + +Amplitude modulation changes the amplitude (gain) periodically over time. + +## am + + + +## amsync + + + +## amdepth + + + +## amskew + + + +## amphase + + + +## amshape + + + # Amplitude Envelope The amplitude [envelope]() controls the dynamic contour of a sound.