Skip to content

Commit

Permalink
updated docs for triggerFilter
Browse files Browse the repository at this point in the history
  • Loading branch information
tmhglnd committed Jan 29, 2024
1 parent 0da33fb commit 55d36d5
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/02-instrument.md
Original file line number Diff line number Diff line change
Expand Up @@ -558,7 +558,7 @@ Alias: `duration()`

## out

Replaces the `pan()` method for Synth and Sample. Set the channel output for the midi-note to be send to.
Set the channel output for the midi-note to be send to.

**arguments**

Expand All @@ -573,7 +573,7 @@ Alias: `channel()`

## chord

Turn the chord output (polyphonic) on for a midi instrument. This allows you to use 2-dimensional lists where the 2nd dimension is used to generate chords.
Turn the chord output (polyphony) on for a midi instrument. This allows you to use 2-dimensional lists where the 2nd dimension is used to generate chords.

**arguments**

Expand All @@ -585,7 +585,7 @@ list chords [[0 4 7] [2 5 9] [5 9 0]]
new midi "AU DLS Synth 1" note(chords 1) chord(on)
```

Alias: `poly()`
Alias: `poly`

## sync

Expand Down
17 changes: 17 additions & 0 deletions docs/04-fx.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,23 @@ You can provide extra arguments to have the filter modulate between a low and hi
new synth saw note(0 0) fx(filter low 1/4 100 3500 0.55 0 4)
```

## triggerFilter

A filter with an envelope that is controlled by the trigger of the instrument. Whenever the sequencer triggers an event that would cause the instrument to sound this will also be the event that triggers the start of this filter. The filter has various types, a low and high frequency value for the envelope to move between, an attack and release time in ms or division value and an optional exponent for the slope of the filter.

**arguments**
- {Name} -> filter type, `low`, `high`, `band` (default=low)
- {Number+/Division} -> attack time in ms or division (default=1)
- {Number+/Division} -> release time in ms or division (default=1/16)
- {Number+} -> high frequency point in the envelope (default=4000)
- {Number+} -> low frequency point in the envelope (default=100)
- {Float+} -> exponent for the envelope curve (default=1)

```java
list beat euclid(8 3)
new synth saw note(0 1) time(1/8) play(beat) fx(triggerFilter low 10 1/4 1000 150 0.5)
```

## double / chorus

Add an Automated-Double-Tracking (ADT) or Chorus effect to the sound. When only typing double it will sound like two versions of the sound are created, one left and one right. When typing chorus the original sound is added and the delaytimes are longer. Arguments are the modulation speed in division, the modulation depth in milliseconds, the modulation wave `sine` or `random`, the dry-wet ratio between `0` and `1` and a detune factor between left and right modulation wave in floating.
Expand Down

0 comments on commit 55d36d5

Please sign in to comment.