Skip to content

Support layout-independent keyboard key identifier #8

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

Open
tbazin wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Support layout-independent keyboard key identifier #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf6c621
Support layout-independent keyboard key identifier
tbazin Jan 10, 2022
1005ae7
:wrench: Update build files and bump version
tbazin Jan 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

#### Bring your own sound.

Use AudioKeys to power the QWERTY keyboard in your next Web Audio project. AudioKeys provides **intelligent handling of key events**, giving you key up and key down events that you can use to trigger your sounds.
Use AudioKeys to power the typing keyboard in your next Web Audio project. AudioKeys provides **intelligent handling of key events**, giving you key up and key down events that you can use to trigger your sounds.

AudioKeys provides **configurable polyphony**— if you're making a monophonic synth, choose from the common note priorities "last note", "first note", "highest note", or "lowest note". It also handles odd situations like switching tabs— AudioKeys fires a note off event when your browser window goes out of focus.

Expand Down Expand Up @@ -126,6 +126,12 @@ For more on note priority, check out [this Sound on Sound article](https://web.a
###### `rootNote`
Determines what note the lowest key on the keyboard will represent. The default is `60` (C4). Keep in mind that setting it to a note other than C (36, 48, 60, 72, 84, etc.) will result in the key mappings not lining up like a regular keyboard!

###### `layoutIndependentMapping`

Whether to identify keyboardEvents using the keyboard layout-independent `e.code` instead of the (deprecated) QWERTY-only `e.keyCode`.
`true` recommended.
Default: `false` for backward-compatibility.


------------------------------------

Expand All @@ -134,4 +140,4 @@ Determines what note the lowest key on the keyboard will represent. The default
- [x] Implement octave shifting (for `rows=1`)
- [x] Implement velocity selection (for `rows=1`)
- [ ] Demo site
- [ ] Add MIDI support
- [ ] Add MIDI support
Loading