StreamDeck Midi setup

Command

Select the command that will be triggered when the button is used. The dropdown will display the commands defined in the "Generic Remote" configuration in Cubase. The configuration in the Generic Remote setup (lower flags section) defines how the button will work.

If multiple Generic Remote devices has been defined in the "StreamDeckCubaseUserSettings.xml" file, a dropown will be displayed where you can decide which Generic Remote device that should be used (see Advanced Configuration). The Command dropdown will show the commands available in the selected Generic Remote device.

Button behavior

Stream Deck buttons can be either Push, Toggle or Hold buttons, depending on the configuration in the Generic Remote setup. You cannot set behavior in the Stream Deck editor - it all depends on the Generic Remote configuration.

  • Push Button always send an "on" command (e.g. "Play"). (lower flags in the Generic Remote configuration has only "P" selected)
  • A Toggle Button toggles between "on" and "off" every other time it is pressed (e.g. "Cycle"). (lower flags has only "T" selected)
  • A Hold Button keeps the command "on" while the button is pressed and "off" when the button is released (e.g. "forward" and "rewind"). (lower flags has both "P" and "T" selected)

Status information

The plugin tries to determine - as far as possible - that everything is configured OK. It checks that it have found the Cubase definition files and can read the configuration of Generic Remote commands. It also checks that the predefined Midi ports are active and connected (i.e. that the plugin is connected to the Midi ports) and that the Generic Remote configuration in Cubase is set to connect to those Midi ports. (Please note: the plugin can verify that Cubase is configured correctly, but cannot verify that Cubase actually has connected to the midi ports - something that can fail e.g. if loopMIDI is started after Cubase)

If everything is OK there is a green check mark for the status information - if anything is found to be a problem there's an error icon and you can expand the details to see what's wrong.

Midi ports

Prior to version 1.5, Midi ports were fixed to StreamDeck2Daw and Daw2StreamDeck. Starting with version 1.5 these port names are still the default port names but you can change them if needed. The port settings are common to all Cubase midi buttons on your Stream Deck - if you change for one button it will automatically be changed for all other button. You cannot have different Stream Deck buttons (using the Cubase plugin) that use different midi ports.

The Verify ports checkbox (also common for all buttons) determine if the plugin should verify that Cubase is using the matching midi ports in the Generic Remote configuration(s).

  • If the box is checked the plugin will verify that the port the Stream Deck is sending on is the same port Cubase is listening on, and vice versa. If there is a mismatch this will be indicated as a error in the status information.
  • If the box is cleared it will not check if port names match but will still warn if the Generic Remote is not connected to any ports at all. If you have a virtual midi port solution that is routing messages (e.g. Bome Midi Translator) you can clear this checkbox to avoid false midi port assignment alerts.

  • On Windows Cubase saves the used port names in the configuration file, and this checkbox is activated by default.
  • On MacOS Cubase saves some numeric reference that probably have some meaning to Cubase but not to the plugin. The checkbox is disabled by default.
Icon

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

The MIDI action is defined to have two states and hence have two icons. The first icon is used for the off/inactive state and an icons displaying this state should be chosen. The second icon is used for on/active state and an icon indicating this should be selected.

Some actions are instant actions that really haven't any on or off states (e.g. "go to next marker"). These actions need only have the first icon configured.

Cubase integration

The plugin automatically integrate with Cubase in real time. Any addition/removal of Generic Remote commands in Cubase will immediately be reflected in the Command dropdown in the plugin. The plugin will immediately adapt if a command already used in the plugin is changed. There is no need to restart or refresh the plugin in order to make changes in Cubase visible and used.