Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: Clarify audio keycodes #4620

Merged
merged 5 commits into from Dec 14, 2018
Merged

Docs: Clarify audio keycodes #4620

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d68352b
Clarify audio keycodes
drashna Dec 12, 2018
6edcf0f
Spelling errors
noroadsleft Dec 12, 2018
eb99721
Spacing in md
noroadsleft Dec 12, 2018
879d8e1
Fix midi link too
drashna Dec 12, 2018
e9b7ee6
Wordsmithing
drashna Dec 12, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/feature_audio.md
View file
Open in desktop
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/keycodes.md
View file
Open in desktop
Expand Up @@ -226,9 +226,9 @@ This is a reference only. Each group of keys links to the page documenting their

|Key |Aliases |Description |
|----------------|---------|----------------------------------|
|`AU_ON` | |Audio mode on |
|`AU_OFF` | |Audio mode off |
|`AU_TOG` | |Toggles Audio mode |
|`AU_ON` | |Turns on Audio Feature |
|`AU_OFF` | |Turns off Audio Feature |
|`AU_TOG` | |Toggles Audio state |
|`CLICKY_TOGGLE` |`CK_TOGG`|Toggles Audio clicky mode |
|`CLICKY_UP` |`CK_UP` |Increases frequency of the clicks |
|`CLICKY_DOWN` |`CK_DOWN`|Decreases frequency of the clicks |
Expand Down