Nulo/qmk_firmware
1
0
Fork 0
Code Releases Activity

Docs: Clarify audio keycodes (#4620)

Browse source 
* Clarify audio keycodes

* Spelling errors

Co-Authored-By: drashna <drashna@live.com>

* Spacing in md

Co-Authored-By: drashna <drashna@live.com>

* Fix midi link too

* Wordsmithing
This commit is contained in:
Drashna Jaelre 2018-12-14 10:43:24 -08:00 committed by MechMerlin
parent 161ffa0af6
commit 9739d6ba0a
2 changed files with 9 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/feature_audio.md
View file

@ -61,9 +61,11 @@ It's advised that you wrap all audio features in `#ifdef AUDIO_ENABLE` / `#endif
The available keycodes for audio are: The available keycodes for audio are:
* `AU_ON` - Turn audio mode on * `AU_ON` - Turn Audio Feature on
* `AU_OFF` - Turn audio mode off * `AU_OFF` - Turn Audio Feature off
* `AU_TOG` - Toggle audio mode * `AU_TOG` - Toggle Audio Feature state
!> 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.
## ARM Audio Volume ## ARM Audio Volume
@ -158,7 +160,7 @@ You can configure the default, min and max frequencies, the stepping and built i
## MIDI Functionality ## MIDI Functionality
This is still a WIP, but check out `quantum/keymap_midi.c` to see what's happening. Enable from the Makefile. This is still a WIP, but check out `quantum/process_keycode/process_midi.c` to see what's happening. Enable from the Makefile.
## Audio Keycodes ## Audio Keycodes

6
docs/keycodes.md
View file

@ -226,9 +226,9 @@ This is a reference only. Each group of keys links to the page documenting their
|Key |Aliases |Description | |Key |Aliases |Description |
|----------------|---------|----------------------------------| |----------------|---------|----------------------------------|
|`AU_ON` | |Audio mode on | |`AU_ON` | |Turns on Audio Feature |
|`AU_OFF` | |Audio mode off | |`AU_OFF` | |Turns off Audio Feature |
|`AU_TOG` | |Toggles Audio mode | |`AU_TOG` | |Toggles Audio state |
|`CLICKY_TOGGLE` |`CK_TOGG`|Toggles Audio clicky mode | |`CLICKY_TOGGLE` |`CK_TOGG`|Toggles Audio clicky mode |
|`CLICKY_UP` |`CK_UP` |Increases frequency of the clicks | |`CLICKY_UP` |`CK_UP` |Increases frequency of the clicks |
|`CLICKY_DOWN` |`CK_DOWN`|Decreases frequency of the clicks | |`CLICKY_DOWN` |`CK_DOWN`|Decreases frequency of the clicks |