diff options
| author | Drashna Jaelre <drashna@live.com> | 2018-06-01 22:29:52 +0200 |
|---|---|---|
| committer | skullydazed <skullydazed@users.noreply.github.com> | 2018-09-25 22:28:36 +0200 |
| commit | a0309db983150fd0197eb620a6ba552d90d29f93 (patch) | |
| tree | c2101615f64c8ab4af8f17dd214ec92e0a3cad48 /docs | |
| parent | cfb1b353eef290ea4eddd7cfcb4617ca25d440d2 (diff) | |
| download | qmk_firmware-a0309db983150fd0197eb620a6ba552d90d29f93.tar.gz qmk_firmware-a0309db983150fd0197eb620a6ba552d90d29f93.tar.xz | |
Add On/Off keycodes
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/feature_audio.md | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/docs/feature_audio.md b/docs/feature_audio.md index fe210c09b..82e0ed950 100644 --- a/docs/feature_audio.md +++ b/docs/feature_audio.md @@ -119,14 +119,16 @@ You can completely disable Music Mode as well. This is useful, if you're pressed #define NO_MUSIC_MODE -## Faux Click +## Audio Click This adds a click sound each time you hit a button, to simulate click sounds from the keyboard. And the sounds are slightly different for each keypress, so it doesn't sound like a single long note, if you type rapidly. * `CK_TOGG` - Toggles the status (will play sound if enabled) -* `CK_RST` - Resets the frequency to the default state -* `CK_UP` - Increases the frequency of the clicks -* `CK_DOWN` - Decreases the frequency of the clicks +* `CK_ON` - Turns on Audio Click (plays sound) +* `CK_OFF` - Turns off Audio Click (doesn't play sound) +* `CK_RST` - Resets the frequency to the default state (plays sound at default frequency) +* `CK_UP` - Increases the frequency of the clicks (plays sound at new frequency) +* `CK_DOWN` - Decreases the frequency of the clicks (plays sound at new frequency) The feature is disabled by default, to save space. To enable it, add this to your `config.h`: @@ -142,7 +144,7 @@ You can configure the default, min and max frequencies, the stepping and built i | `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_RANDOMNESS` | 0.05f | Sets a factor of randomness for the clicks, Setting this to `0f` will make each click identical. | +| `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. | |