- Why does this need an explanation?
In the Stream Deck editor you can define icon(s) for your buttons and in most cases that method is sufficient. In the Mackie Control action, this is the method used when you create buttons that act as Mackie Control switches (Play, Solo etc). As long as static images should be displayed this method works without problems.
When it comes to faders and V-pots the Mackie Control action can create dynamic images that give a graphic view of the fader or V-pot position and state. In these cases the plugin creates the images by layering state images upon a background image and displays the resulting image on the button. Unfortunately the Stream Deck software does not give the plugin any information about which image that is selected for the button in the editor, and if you select any image in the editor that image will be displayed no matter what the plugin does.
So...in order for the plugin to be able to dynamically create and display images all the image information must be defined directly in the plugin, not in the ordinary icon selection in the editor.
- Faders and V-pots
Mackie Control faders and V-pots work very differently.
- A fader is very detailed and will send a value between 0 and 16.386 depending on position.
- A V-pot have 11 LEDs that can be lit in various patterns depending on which function you are controlling. A V-pot sends turn speed rather than position.
- Fader images
As mentioned above the background image must be selected in the plugin, not in the editors icon selection. Just click Select file... and locate the file you want to have as background image on the button. (if no image is selected, a simple white backgound is used)
Whenever fader state changes - either by pressing the Stream Deck button or by moving the fader in the daw - a new image will be created and a vertical or horizontal bar representing the current fader position will be painted upon the background image and displayed on the button.
- V-pot images
For the pre-defined patterns Ring and Horizontal bar you only need to select the background image to use. Just click Select file... and locate the file you want to have as background image on the button. (if no image is selected, a simple white backgound is used)
Whenever V-pot state changes - either by pressing the Stream Deck button or by moving the target parameter in the daw - a new image will be created and state images will be layered upon the background image and displayed on the button.
State images are stored in folders and if you want some other design you can create your own state images (see below). To select the folder for your own state images you must select a file (any file) in that folder. Unfortunately there is no "Select folder" dialog available in Stream Deck so we must use the "Select File" dialog. The folder containing the file you select will be used as state image folder.
- Create your own V-pot images
On a Mackie Control, the V-pot is designed with 11 LEDs around the pot (labeled 1-B in the picture). These LEDs can be lit in various patterns depending on what the V-pot is controlling. Examples: When controling pan, they are lit from the center (6) and towards the side the track is panned. When controlling send level they are lit from position 1 and up.
To give a visual representation of the V-pot state the plugin expects to find one image for each LED position, and depending on the information received from the daw the correct images will be layered upon the background image.
Guidelines for creating state images:
- The images must be .png images with transparent backgrounds.
- The images shoud be square. The default image size for a Stream Deck button is 144x144 pixels but images of other sizes will be resized.
- Images must be named LED1.png, LED2.png.....LED11.png with reference to the LED positions (A=10, B=11)
- Each image should contain the state for that single LED in its On position.
- If you want to have a "frame" image that show the position of all LEDs in their Off position, you should add a LED0.png with this information. (optional)
When building button images, the plugin does this:
- The background image is loaded (or the background is painted white if no image is selected).
- If the file LED0.png exists in the folder, that image is layered upon the background image. This is always done regardless of the state information for the LEDs. If the file doesn't exist this step is skipped.
- Depending on the information received from the daw the plugin determines which state files that should be loaded, loads them one by one and layer them upon the previously combined image.
- When all images are combined the final image is displayed on the button.
- Windows folder: "%appdata%\
Elgato\ StreamDeck\ Plugins\ se.trevligaspel.midi.sdPlugin\ Images\ RotaryRing"
- Mac folder: "~/Library/
Application Support/ com.elgato.StreamDeck/ Plugins/ se.trevligaspel.midi.sdPlugin/ Images/ RotaryRing"
If your create some cool state image folders, please share them on the forum :-)