summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2018-05-08 23:18:15 +0200
committerJack Humbert <jack.humb@gmail.com>2018-05-08 23:18:15 +0200
commit63d5c947d3bce7ad9db014b7930e4809aa16fa4c (patch)
tree29f2f97b93cf652dcc40742b8b84ae9f78fad900 /docs
parent14b7602a65dedaf51db1c9288144765d43a83a15 (diff)
downloadqmk_firmware-63d5c947d3bce7ad9db014b7930e4809aa16fa4c.tar.gz
qmk_firmware-63d5c947d3bce7ad9db014b7930e4809aa16fa4c.tar.xz
updated music mask
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_audio.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/feature_audio.md b/docs/feature_audio.md
index 1b8ca86f4..50e389605 100644
--- a/docs/feature_audio.md
+++ b/docs/feature_audio.md
@@ -89,6 +89,20 @@ By default, `MUSIC_MASK` is set to `keycode < 0xFF` which means keycodes less th
Which will capture all keycodes - be careful, this will get you stuck in music mode until you restart your keyboard!
+For a more advanced way to control which keycodes should still be processed, you can use `music_mask_kb(keycode)` in `<keyboard>.c` and `music_mask_user(keycode)` in your `keymap.c`:
+
+ bool music_mask_user(uint16_t keycode) {
+ switch (keycode) {
+ case RAISE:
+ case LOWER:
+ return false;
+ default:
+ return true;
+ }
+ }
+
+Things that return false are not part of the mask, and are always processed.
+
The pitch standard (`PITCH_STANDARD_A`) is 440.0f by default - to change this, add something like this to your `config.h`:
#define PITCH_STANDARD_A 432.0f