summaryrefslogtreecommitdiff
path: root/docs/feature_audio.md
diff options
context:
space:
mode:
authorJosh <josh@visionistinc.com>2019-05-17 16:48:53 -0400
committerDrashna Jaelre <drashna@live.com>2019-05-17 13:48:53 -0700
commitd85110b6ec5fcdf3ef88b41909ce739b017abbea (patch)
tree4fd8ad2cd4d53362fe9cf1cd6da5fa51b808cc70 /docs/feature_audio.md
parent00d1d7828c63538122d9d3db7336b9a40c9ffe80 (diff)
Adds a configurable initial delay to the audio clicky feature (#4286)
* Adding an AUDIO_CLICKY_DELAY_DURATION configurable value to the AUDIO_CLICKY feature. * Tweaking my community keymap to work better with my rev 4 planck.
Diffstat (limited to 'docs/feature_audio.md')
-rw-r--r--docs/feature_audio.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/feature_audio.md b/docs/feature_audio.md
index e1dd4c5a85..7511598bcf 100644
--- a/docs/feature_audio.md
+++ b/docs/feature_audio.md
@@ -175,8 +175,9 @@ You can configure the default, min and max frequencies, the stepping and built i
| `AUDIO_CLICKY_FREQ_DEFAULT` | 440.0f | Sets the default/starting audio frequency for the clicky sounds. |
| `AUDIO_CLICKY_FREQ_MIN` | 65.0f | Sets the lowest frequency (under 60f are a bit buggy). |
| `AUDIO_CLICKY_FREQ_MAX` | 1500.0f | Sets the the highest frequency. Too high may result in coworkers attacking you. |
-| `AUDIO_CLICKY_FREQ_FACTOR` | 1.18921f| Sets the stepping of UP/DOWN key codes. |
+| `AUDIO_CLICKY_FREQ_FACTOR` | 1.18921f| Sets the stepping of UP/DOWN key codes. This is a multiplicative factor. The default steps the frequency up/down by a musical minor third. |
| `AUDIO_CLICKY_FREQ_RANDOMNESS` | 0.05f | Sets a factor of randomness for the clicks, Setting this to `0f` will make each click identical, and `1.0f` will make this sound much like the 90's computer screen scrolling/typing effect. |
+| `AUDIO_CLICKY_DELAY_DURATION` | 1 | An integer note duration where 1 is 1/16th of the tempo, or a sixty-fourth note (see `quantum/audio/musical_notes.h` for implementation details). The main clicky effect will be delayed by this duration. Adjusting this to values around 6-12 will help compensate for loud switches. |