Module Musician.Keyboard
Live keyboard window
Functions
Functions
- Musician.Keyboard.BuildMapping ()
- Build keyboard mapping from actual configuration
- Musician.Keyboard.ConfigureDemo ([doKeyboardRefresh=true])
-
Configure demo mode relatively to the source song
Parameters:
- doKeyboardRefresh (boolean) Rebuild key mapping when true (default true)
- Musician.Keyboard.DisableDemoMode ([doKeyboardRefresh=true])
-
Disable demo mode
Parameters:
- doKeyboardRefresh (boolean) Rebuild key mapping when true (default true)
- Musician.Keyboard.EnableDemoMode (upperTrackIndex, lowerTrackIndex[, doKeyboardRefresh=true])
-
Enable demo mode with provided track indexes
Parameters:
- upperTrackIndex (number)
- lowerTrackIndex (number)
- doKeyboardRefresh (boolean) Rebuild key mapping when true (default true)
- Musician.Keyboard.Init ()
- Initialize keyboard
- Musician.Keyboard.KeyButtonStateDiffers (keyValue, down)
-
Return true if the provided keypress' button down state differs from the provided one.
Parameters:
- keyValue (string)
- down (boolean)
Returns:
-
(boolean)
- Musician.Keyboard.OnFrame (event, elapsed)
-
OnFrame
Parameters:
- event (string)
- elapsed (boolean)
- Musician.Keyboard.OnKey (keyValue, down)
-
Key up/down handler, from physical or on-screen keyboard
Parameters:
- keyValue (string)
- down (boolean)
Returns:
-
(boolean) True if the keypress was consumed
- Musician.Keyboard.OnLiveBandSync (event, player, isSynced)
-
OnLiveBandSync
Parameters:
- event
- player
- isSynced Display "Is synced" emote in the chat
- Musician.Keyboard.OnLiveNoteOff (event, key, layer, isChordNote, source)
-
OnLiveNoteOff
Parameters:
- event (string)
- key (number)
- layer (number)
- isChordNote (boolean)
- source (table)
- Musician.Keyboard.OnLiveNoteOn (event, key, layer, instrumentData, isChordNote, source)
-
OnLiveNoteOn
Parameters:
- event (string)
- key (number)
- layer (number)
- instrumentData (table)
- isChordNote (boolean)
- source (table)
- Musician.Keyboard.OnNoteOff (event, song, track, key)
-
Demo mode OnNoteOff
Parameters:
- event (string)
- song (Musician.Song)
- track (number)
- key (number)
- Musician.Keyboard.OnNoteOn (event, song, track, key)
-
Demo mode OnNoteOn
Parameters:
- event (string)
- song (Musician.Song)
- track (table)
- key (number)
- Musician.Keyboard.OnPhysicalKey (keyValue, down)
-
Key up/down handler, from physical keyboard
Parameters:
- keyValue (string)
- down (boolean)
- Musician.Keyboard.OnPhysicalKeyDown (event, keyValue)
-
OnPhysicalKeyDown
Parameters:
- event (string)
- keyValue (string)
- Musician.Keyboard.OnPhysicalKeyUp (event, keyValue)
-
OnPhysicalKeyUp
Parameters:
- event (string)
- keyValue (string)
- Musician.Keyboard.OnSongPlay (event, song)
-
Demo mode OnSongPlay
Parameters:
- event (string)
- song (Musician.Song)
- Musician.Keyboard.SetBaseKey (key[, doKeyboardRefresh=true])
-
Change base key
Parameters:
- key (number)
- doKeyboardRefresh (boolean) Rebuild key mapping when true (default true)
- Musician.Keyboard.SetButtonState (button, down)
-
Set on-screen keyboard button up/down state, without triggering its action.
Parameters:
- button (Button)
- down (boolean)
- Musician.Keyboard.SetButtonsUp ([onlyForLayer])
-
Set all buttons up
Parameters:
- onlyForLayer (number) (optional)
- Musician.Keyboard.SetInstrument (layer, instrument[, doKeyboardRefresh=true])
-
Change Instrument
Parameters:
- layer (number)
- instrument (number)
- doKeyboardRefresh (boolean) Rebuild key mapping when true (default true)
- Musician.Keyboard.SetKeyShift (layer, shift[, doKeyboardRefresh=true])
-
Set key shift amount
Parameters:
- layer (number)
- shift (number) Shift amount
- doKeyboardRefresh (boolean) Rebuild key mapping when true (default true)
- Musician.Keyboard.SetLayout (layoutIndex[, doKeyboardRefresh=true])
-
Change keyboard layout
Parameters:
- layoutIndex (number)
- doKeyboardRefresh (boolean) Rebuild key mapping when true (default true)
- Musician.Keyboard.SetPowerChords (layer, enable[, doKeyboardRefresh=true])
-
Set power chords \m/
Parameters:
- layer (number)
- enable (boolean)
- doKeyboardRefresh (boolean) Rebuild key mapping when true (default true)
- Musician.Keyboard.ShiftKeys (layer, amount[, doKeyboardRefresh=true])
-
Shift keys
Parameters:
- layer (number)
- amount (number)
- doKeyboardRefresh (boolean) Rebuild key mapping when true (default true)
- Musician.Keyboard.Show ()
- Show
- Musician.Keyboard.ToggleUI ()
- Toggle UI, keeping the keyboard visible
- Musician.Keyboard.UpdateBandSyncButton ()
- Update band sync button
- MusicianKeyboard.DeleteProgram (program)
-
Delete a program
Parameters:
- program (number)
- MusicianKeyboard.FunctionKey (down, keyValue)
-
Function key pressed
Parameters:
- down (boolean)
- keyValue (string)
Returns:
-
(boolean) True if the keypress was consumed
- MusicianKeyboard.HasSavedProgram (program)
-
Has saved program
Parameters:
- program (number)
Returns:
-
(boolean)
- MusicianKeyboard.IsCurrentProgram (program)
-
Indicate if the provided program is the current one that has been loaded
Parameters:
- program (number)
Returns:
-
(boolean)
- MusicianKeyboard.IsDeletingProgram ()
-
Get program deleting mode
Returns:
-
(boolean)
- MusicianKeyboard.IsSavingProgram ()
-
Get program saving mode
Returns:
-
(boolean)
- MusicianKeyboard.LoadConfig (config)
-
Load configuration
Parameters:
- config (table)
- MusicianKeyboard.LoadProgram (program)
-
Load saved program
Parameters:
- program (number)
Returns:
-
(boolean)
- MusicianKeyboard.NoteKey (down, keyValue)
-
Note key pressed
Parameters:
- down (boolean)
- keyValue (string)
Returns:
-
(boolean) True if the keypress was consumed
- MusicianKeyboard.ProgramActionKey (down, keyValue)
-
Program action key pressed
Parameters:
- down (boolean)
- keyValue (string)
Returns:
-
(boolean) True if the keypress was consumed
- MusicianKeyboard.SaveProgram (program)
-
Save program
Parameters:
- program (number)
- MusicianKeyboard.SetDeletingProgram (value)
-
Set program deleting mode
Parameters:
- value (boolean)
- MusicianKeyboard.SetSavingProgram (value)
-
Set program saving mode
Parameters:
- value (boolean)