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.

Keys
Define the key(s) to send when the button is pressed.
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.
Key Select the key that should be triggered.
Velocity Set the velocity for the key. The same velocity is used in both Note On and Note Off commands.
For an explicit "Note Off" command, set velocity = 0.
+/- Up to 5 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.
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.

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 in combination with a translation file. By default, no midi in port is selected. If you select a midi in port you must also select a translation file that defines how incoming note messages should be treated. Incoming note messages are ignored if no translation file is defined. Messages on Midi in is primarily used to show state (text and/or image) on the button and will not affect actions when the button is pressed.

Translation file

A translation file is required 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. 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 note that the current version of the plugin does not handle this - displayed image is not affected by button presses. Please see the Translation File section for more details.

Icon

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.