diff options
Diffstat (limited to 'docs/feature_audio.md')
| -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 | |||
| 119 | 119 | ||
| 120 | #define NO_MUSIC_MODE | 120 | #define NO_MUSIC_MODE |
| 121 | 121 | ||
| 122 | ## Faux Click | 122 | ## Audio Click |
| 123 | 123 | ||
| 124 | 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. | 124 | 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. |
| 125 | 125 | ||
| 126 | * `CK_TOGG` - Toggles the status (will play sound if enabled) | 126 | * `CK_TOGG` - Toggles the status (will play sound if enabled) |
| 127 | * `CK_RST` - Resets the frequency to the default state | 127 | * `CK_ON` - Turns on Audio Click (plays sound) |
| 128 | * `CK_UP` - Increases the frequency of the clicks | 128 | * `CK_OFF` - Turns off Audio Click (doesn't play sound) |
| 129 | * `CK_DOWN` - Decreases the frequency of the clicks | 129 | * `CK_RST` - Resets the frequency to the default state (plays sound at default frequency) |
| 130 | * `CK_UP` - Increases the frequency of the clicks (plays sound at new frequency) | ||
| 131 | * `CK_DOWN` - Decreases the frequency of the clicks (plays sound at new frequency) | ||
| 130 | 132 | ||
| 131 | 133 | ||
| 132 | The feature is disabled by default, to save space. To enable it, add this to your `config.h`: | 134 | 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 | |||
| 142 | | `AUDIO_CLICKY_FREQ_MIN` | 65.0f | Sets the lowest frequency (under 60f are a bit buggy). | | 144 | | `AUDIO_CLICKY_FREQ_MIN` | 65.0f | Sets the lowest frequency (under 60f are a bit buggy). | |
| 143 | | `AUDIO_CLICKY_FREQ_MAX` | 1500.0f | Sets the the highest frequency. Too high may result in coworkers attacking you. | | 145 | | `AUDIO_CLICKY_FREQ_MAX` | 1500.0f | Sets the the highest frequency. Too high may result in coworkers attacking you. | |
| 144 | | `AUDIO_CLICKY_FREQ_FACTOR` | 1.18921f| Sets the stepping of UP/DOWN key codes. | | 146 | | `AUDIO_CLICKY_FREQ_FACTOR` | 1.18921f| Sets the stepping of UP/DOWN key codes. | |
| 145 | | `AUDIO_CLICKY_FREQ_RANDOMNESS` | 0.05f | Sets a factor of randomness for the clicks, Setting this to `0f` will make each click identical. | | 147 | | `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. | |
| 146 | 148 | ||
| 147 | 149 | ||
| 148 | 150 | ||