Merge branch 'daslyfe/gainmod' of ssh://codeberg.org/uzu/strudel into daslyfe/gainmod

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 <https://codeberg.org/uzu/strudel/activity/contributors>
 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 <https://www.gnu.org/licenses/>.
 */

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("<tri saw ramp square>").amdepth(.5)

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

website/src/pages/learn/effects.mdx

@@ -57,6 +57,34 @@ Each filter has 2 parameters:
 
 <JsDoc client:idle name="vowel" h={0} />
 
+# Amplitude Modulation
+
+Amplitude modulation changes the amplitude (gain) periodically over time.
+
+## am
+
+<JsDoc client:idle name="am" h={0} />
+
+## amsync
+
+<JsDoc client:idle name="amsync" h={0} />
+
+## amdepth
+
+<JsDoc client:idle name="amdepth" h={0} />
+
+## amskew
+
+<JsDoc client:idle name="amskew" h={0} />
+
+## amphase
+
+<JsDoc client:idle name="amphase" h={0} />
+
+## amshape
+
+<JsDoc client:idle name="amshape" h={0} />
+
 # Amplitude Envelope
 
 The amplitude [envelope](<https://en.wikipedia.org/wiki/Envelope_(music)>) controls the dynamic contour of a sound.