aboutsummaryrefslogtreecommitdiffstats
path: root/docs/feature_audio.md
diff options
context:
space:
mode:
authorGravatar Drashna Jaelre <drashna@live.com>2018-12-14 10:43:24 -0800
committerGravatar MechMerlin <30334081+mechmerlin@users.noreply.github.com>2018-12-14 10:43:24 -0800
commit9739d6ba0ad3da93f42cc28a78a6722d39ad3d72 (patch)
tree765ea06ae341e64fa30ea594ab1d4f4f0d8e7c07 /docs/feature_audio.md
parent161ffa0af6b9af76b8e73a3f274bbc415ae9f842 (diff)
downloadqmk_firmware-9739d6ba0ad3da93f42cc28a78a6722d39ad3d72.tar.gz
Docs: Clarify audio keycodes (#4620)
* 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
Diffstat (limited to 'docs/feature_audio.md')
-rw-r--r--docs/feature_audio.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/docs/feature_audio.md b/docs/feature_audio.md
index a39c45687..38861e8c1 100644
--- a/docs/feature_audio.md
+++ b/docs/feature_audio.md
@@ -61,9 +61,11 @@ It's advised that you wrap all audio features in `#ifdef AUDIO_ENABLE` / `#endif
The available keycodes for audio are:
-* `AU_ON` - Turn audio mode on
-* `AU_OFF` - Turn audio mode off
-* `AU_TOG` - Toggle audio mode
+* `AU_ON` - Turn Audio Feature on
+* `AU_OFF` - Turn Audio Feature off
+* `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
@@ -158,7 +160,7 @@ You can configure the default, min and max frequencies, the stepping and built i
## 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