diff options
| author | Arthur Tabatchnic <arthur@keeldocs.io> | 2021-04-11 13:50:45 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-04-11 12:50:45 +0200 |
| commit | 0f516d902622ad4edd6e5f46a1903101b4a6f5b0 (patch) | |
| tree | 2d885d63911bd8e84b6ac88ed40541cd4c415050 /docs/feature_audio.md | |
| parent | b23eeb6a14831064578428306938d577be3b6a05 (diff) | |
| download | qmk_firmware-0f516d902622ad4edd6e5f46a1903101b4a6f5b0.tar.gz qmk_firmware-0f516d902622ad4edd6e5f46a1903101b4a6f5b0.zip | |
A few small typo fixes in docs (#12524)
Diffstat (limited to 'docs/feature_audio.md')
| -rw-r--r-- | docs/feature_audio.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/feature_audio.md b/docs/feature_audio.md index 9e7ba75f5..2c440c951 100644 --- a/docs/feature_audio.md +++ b/docs/feature_audio.md | |||
| @@ -8,7 +8,7 @@ To activate this feature, add `AUDIO_ENABLE = yes` to your `rules.mk`. | |||
| 8 | On Atmega32U4 based boards, up to two simultaneous tones can be rendered. | 8 | On Atmega32U4 based boards, up to two simultaneous tones can be rendered. |
| 9 | With one speaker connected to a PWM capable pin on PORTC driven by timer 3 and the other on one of the PWM pins on PORTB driven by timer 1. | 9 | With one speaker connected to a PWM capable pin on PORTC driven by timer 3 and the other on one of the PWM pins on PORTB driven by timer 1. |
| 10 | 10 | ||
| 11 | The following pins can be configured as audio outputs in `config.h` - for one speaker set eiter one out of: | 11 | The following pins can be configured as audio outputs in `config.h` - for one speaker set either one out of: |
| 12 | 12 | ||
| 13 | * `#define AUDIO_PIN C4` | 13 | * `#define AUDIO_PIN C4` |
| 14 | * `#define AUDIO_PIN C5` | 14 | * `#define AUDIO_PIN C5` |
| @@ -166,7 +166,7 @@ The available keycodes for audio are: | |||
| 166 | !> These keycodes turn all of the audio functionality on and off. Turning it off means that audio feedback, audio clicky, music mode, etc. are disabled, completely. | 166 | !> These keycodes turn all of the audio functionality on and off. Turning it off means that audio feedback, audio clicky, music mode, etc. are disabled, completely. |
| 167 | 167 | ||
| 168 | ## Tempo | 168 | ## Tempo |
| 169 | the 'speed' at which SONGs are played is dictated by the set Tempo, which is measured in beats-per-minute. Note lenghts are defined relative to that. | 169 | the 'speed' at which SONGs are played is dictated by the set Tempo, which is measured in beats-per-minute. Note lengths are defined relative to that. |
| 170 | The initial/default tempo is set to 120 bpm, but can be configured by setting `TEMPO_DEFAULT` in `config.c`. | 170 | The initial/default tempo is set to 120 bpm, but can be configured by setting `TEMPO_DEFAULT` in `config.c`. |
| 171 | There is also a set of functions to modify the tempo from within the user/keymap code: | 171 | There is also a set of functions to modify the tempo from within the user/keymap code: |
| 172 | ```c | 172 | ```c |
| @@ -291,7 +291,7 @@ You can configure the default, min and max frequencies, the stepping and built i | |||
| 291 | |--------|---------------|-------------| | 291 | |--------|---------------|-------------| |
| 292 | | `AUDIO_CLICKY_FREQ_DEFAULT` | 440.0f | Sets the default/starting audio frequency for the clicky sounds. | | 292 | | `AUDIO_CLICKY_FREQ_DEFAULT` | 440.0f | Sets the default/starting audio frequency for the clicky sounds. | |
| 293 | | `AUDIO_CLICKY_FREQ_MIN` | 65.0f | Sets the lowest frequency (under 60f are a bit buggy). | | 293 | | `AUDIO_CLICKY_FREQ_MIN` | 65.0f | Sets the lowest frequency (under 60f are a bit buggy). | |
| 294 | | `AUDIO_CLICKY_FREQ_MAX` | 1500.0f | Sets the the highest frequency. Too high may result in coworkers attacking you. | | 294 | | `AUDIO_CLICKY_FREQ_MAX` | 1500.0f | Sets the highest frequency. Too high may result in coworkers attacking you. | |
| 295 | | `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. | | 295 | | `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. | |
| 296 | | `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. | | 296 | | `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. | |
| 297 | | `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. | | 297 | | `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. | |
