Keyboard control¶

The keyboard control displays LED feedback concerning the state of the keyboard view, as well as Live's scale mode.

Note

Standard controls are already capable of interacting with the keyboard view, and the keyboard control still requires you to manually define any commands. The only purpose of this control is to enable LED feedback.

yaml schema¶

Inherits from standard control.

function: string, dict
active_color: color definition
inactive_color: color definition
# color: not implemented

function¶

string, dict

This is the condition that will determine if the control is active or inactive.

repeat_rate¶

function:
  repeat_rate: 1/4

function:
  repeat_rate: on

Reflect the keyboard's note repeat rate.

in_key¶

function: in_key

Reflect if they keyboard is using in key mode.

full_velo¶

function: full_velo

Reflect if they keyboard is using full velocity mode.

octave_down, octave_up¶

function: octave_down

Reflect if the keyboard's octave is at its lowest or highest: if the octave is at its lowest, function: octave_down would be inactive.

scale¶

Reflects the root and/or scale name of Live's scale mode.

function:
  scale:
    root: F

function:
  scale:
    name: lydian augmented

function:
  scale:
    root: C
    name: major

For either root or name you may provide an integer. For root, C is 0 and B is 11. For name, the order follows the order of scales in the Live GUI.

In either case you may provide an integer greater than the number of options and your choice will be "wrapped" to a valid one. E.g. providing 12 for root will result in C, as will 24.

color¶

not implemented

Use active color and inactive color.

active_color¶

color definition

Define a color that will display when this control's bound page is active.

inactive_color¶

color definition

Inverse of active color.

Examples¶

Minimal config¶

my_control:
    type: keyboard
    function:
      repeat_rate: 1/4

See function for available options.

Note repeat overlay¶

See recipe.