Note On/Off setup

Overview

The Note On/Off action can be used in a number of ways, not only to "play notes".

Play notes The obvious use of the action to simply send Note On/Off to play notes. Using Push, Toggle and Hold buttons you can play single notes or chords with up to 5 notes.
Control e.g. articulation Using Latch buttons you can control things like articulation where the press of one button automatically should disable the previous articulation before activating the new one.
Show status Using a translation file you can have a button show different texts/images depending on received Note messages. This can be used stand-alone (i.e. the button isn't really meant to be pressed but rather to just show state) or in combination with any of the button types.

Channel

Select the Midi channel that should be used.

Please note that the Midi channels are numbered 1-16 (that is normal for humans) but the Midi protocol uses 0-15 (that is normal for computers). If your daw/device uses 0-15 numbering, please subtract 1 from the channel in the dropdown list.

Button type

Select how the button should interact with the device/daw:

  • A Push Button will always send a "Note On" when it is pressed.
  • A Latch Button acts like a Push button but will in addition send a Note Off for any previously used Latch button (see "Latch group" below for more details).
  • A Toggle Button alternates between "Note On" and "Note Off" when it is pressed.
  • A Hold Button will send a "Note On" when it is pressed and a "Note Off" when the button is released.

Select Keys for...

Select the purpose of the action and how the plugin should populate the Keys dropdown fields.

Middle C Middle C, by definition, always has a midi value of 60, but some vendors define "middle C" as C3 while others have C4 or C5. To avoid confusion, set this to be the same as the daw/device you are controlling. If you select midi value 60 in the key dropdown, midi value 60 will be sent regardless of the middle C setting, but the key presentation in the dropdown list will match that of your daw/device if you select middle C to the same as in your daw/device.
Articulation, Generic If you have prepared an articulation file in your Trevliga Spel folder you select Articulation, Generic instead of a Middle C value. If you do, the key dropdowns will be populated from the articulation file instead of the normal key lists. Please see the Option files section for details.
Cubase/Nuendo Expression Map Select the expressionmap file used by the track in Cubase/Nuendo. The Expression Map file will be read and the key dropdowns will be populated from the expression map instead of the normal key lists.
Logic Pro Articulation Set Select the plist file used by the track in Logic Pro. The Articulation Set file will be read and the key dropdowns will be populated from the articulation set instead of the normal key lists.
Some notes about Expression Maps and Articulation Sets:
  • If an entry in the dropdown list is preceded by a question mark "[?]" it means that the articulation has no key assigned for remote control in the Expression Map/Articulation Set and can therefore not be used.
  • If you make changes to an Expression Map/Articulation Set, you must save the changes to the file. Changes you make will immediately be used by the daw and saved with the project, but the originating file is not updated. The plugin relies on the content in the plist/expressionmap files, and these files aren't updated unless you explicitly update them.

Keys
Define the key(s) to send when the button is pressed.
Key Select the key/articulation that should be triggered.

When Expression Maps or Articulation Sets are used, please note that when you select an articulation in the dropdown, you choose the note associated with that articulation, not the name of the articulation. If you change the associated note in the Expression Map/Articulation Set configuration, the Stream Deck button will lose its selection. If items are preseeded by a question mark "[?]" it means that the articulation does not have an associated note in the Expression Map/Articulation Set and cannot be remotely controlled.
Velocity Set the velocity for the key. The same velocity is used in both Note On and Note Off commands (unless an explicit Note Off velocity is set, see below).
For an explicit "Note Off" command, set velocity = 0.
+/- An unlimited number of keys can be defined to be triggered simultaneously (i.e. a chord). Click the + to add a new key and the - to remove the key on the same row as the minus button.
Note Off velocity

The default behavior is to send a Note Off message with the same velocity as the corresponding Note On. If you need to have another velocity value in the Note Off message you can set this here. I multiple notes are defined in the action they will all send Note Off messages according to the setting in this parameter.

Latch group
(Only visible if button type is "Latch")

If you e.g. are using Note messages to control articulation it can be useful to have the previous articulation disabled at the same time as a new one is selected. Latch keys keep track of the last used note message(s) and sends Note Off message(s) for the previously pressed button before sending Note On message(s) for the currently pressed button. Latch buttons keep track of all notes triggered by the previous latch button, and if the previous button triggered multiple notes, Note Off messages for all those notes are sent. Latch buttons work across profiles and folders - a latch button in any folder or profile will send Note Off messages for previosuly used button even if that button was used in another folder or profile.

With Latch groups it is possible to group latch buttons so that Note Off messages are only sent for the previously pressed button belonging to the same latch group. Every new Latch button is assigned to the "Default group" and unless changed, every latch button will act (send Note Off) for any other latch button. If you want some latch button to only react to a subset of other latch buttons you can create a latch group for those buttons. Please note that latch buttons do not filter on midi channels, only latch groups. If button A sends a Note On message on midi channel 1 and button B sends a Note On message on midi channel 2, button B will still send Note Off messages on channel 1 for button A when pressed (if they belong to the same latch group). If you need to keep latch buttons for different channels apart you need to create a latch group for each channel.

To add a latch button to an existing latch group, simply select the group in the dropdown. The dropdown contain latch groups detected since the Stream Deck application was started, i.e. groups from multiple profiles or folders might be present in the dropdown. If there are latch groups used only in profiles or folders that you have not yet activated since the last start of the Stream Deck application they will not be shown in the dropdown. If you know there is a latch group that isn't shown you can still assign the button to it by registering it as a "new" group as described below. As long as the group name is idential (case sensitive) to a group in a not yet activated profile it is regarded to be the same group.

To add a new latch group, enter the group name in the text field and press the + button. The group will be added to the dropdown and automatically selected for the current button. There is no way to manually remove groups from the dropdown. If you have removed all buttons from an earlier used group it will be removed the next time the Stream Deck application is restarted.

If Latch buttons are configured to use 2 icons, the latest used button will have the On state and show the appropriate icon for that. When another button in the same Latch group is pressed, the first button will be reset to the Off state while the new button will have the On state. Configured this way you will always see which button that is currently active. Please note that if the buttons are configured to monitor Midi In, an incoming note that match the first note for a button will activate that button and inactivate the other buttons in the same Latch group. Tip: If you want a button that simple mutes and resets all other buttons in the same Latch group, just create a button with a single note with the velocity 0 (i.e. Note Off). This button will never get the On state but it will reset all other buttons in the group.

Midi Out port

Select the Midi out port that should be used. If available, the default port "StreamDeck2Daw" is selected when you create a button but you can select any other port if required. When you change Midi port for one button, the change affect that button only but the new Midi port selected will be the default port for all new buttons that will be created from that point on (for all kind of commands).

Midi In port

Select the Midi in port that should be used. By default, no midi in port is selected. Toggle and Latch buttons can monitor Midi In and can adapt to and (if they are configured with 2 icons) show the current state based on incoming Midi messages. Any button type can be configured to use a translation file to defines how incoming note messages should be treated. For Push and Hold buttons, incoming note messages are ignored if no translation file is defined.

Translation file

A translation file can be assigned when a Midi in port is defined. The main purpose of the translation file (in the Note action) is to present texts and/or images on the button based on incoming note messages (values in the translation file represent note values, not velocity values). The syntax of the translation file is identical to when used with Program Change or Control Change actions, but please note that send attributes are ignored for the note action. Notes defined in the editor will be sent regardless of the send attribute on the corresponding note tag in the translation file. The displayonsend attribute will however be used, so if you want the a button press to affect the text/image of the button you can do that using that attribute for the corresponding note. Please see the Translation File section for more details.

Button Icons

You can select if the button should use 1 or 2 icons (when not using a translation file). Toggle and Latch buttons (and to some extent the Hold button) can benefit from having two buttons in order to display the current state. In earlier releases (1.8.6. and earlier) the Note On/Off action had one icon only. In order not to break existing installations, "old" buttons by default keep the setting with 1 icon while newly created buttons will get 2 icons by default.

Please note that it is the selected radio button that determine if 1 or 2 icons will be used by the plugin, not whether 1 or 2 icons are defined in the Stream Deck editor icon selection (...but of course you need to select which two icons to display if you tell the plugin to use 2 icons...)

Push buttons will always only use 1 icon since there is no state involved in Push buttons (...unless a translation file is used...). Toggle, Latch and Hold buttons can be configured with 1 or 2 icons depending on if they should show different states or not.

Initially, the same icons are set for all midi actions. You can of course chose whatever icons you like, but a set of Midi related icons are bundled with the plugin (please see the Installation section for details).

If a translation file is used, you can have unique icons for every step defined in the translation file. If you want to use that feature, you must not define an icon for the action itself in the Stream Deck editor. Please see the Translation File section for more details.