The StreamDeck is a customizable OLED button control interface.
By creating a StreamDeck object under the object tree allows you to directly connect to a StreamDeck device and configure the buttons’ design and functions within SP.
StreamDeck Setup
StreamDeck
Name | Description |
---|---|
Connected | Status indicator on whether the device is connected |
Device | Dropdown list for available devices that matches the type of the object |
Open Editor | Button to open up the Editor window to configure the StreamDeck |
Brightness | Controls the overall brightness of the connected StreamDeck |
Editor
The editor is a representation of the associated StreamDeck device. The layout of number of rows/columns should match the associated StreamDeck.
Pages
There is support for multiple pages on the StreamDeck.
To do so, it is similar to how you would be add a new board:
Open the Editor window for the StreamDeck. At the top of the Editor window tab, there is a down arrow.
Click on the down arrow icon to open the additional menu. Within that menu, there is the option to create a new page, and switch between different pages.
At the top right corner for the Editor window, there is an indicator for the current page that you are on.
Next to the Page indicator, there is another icon. Pressing this button would push the current page to the device, and make the device jump into the current page.
Buttons
Within the editor, click on any of the button to select it and to bring up the inspector to configure it.
Name | Description |
---|---|
Button Type |
|
Icon | choose from a variety of different included icons |
Label | define the text to be displayed inside the button |
Sub label | only shown when using 2 Lines Label option |
Highlight Color | only shown when using the Broadcast option |
Within each button, there is the typical option of creating events and actions just a normal button on the board. There are 2 types of events available:
- On Down – when the button is pressed
- On Up- when the button is released
For more information about events and actions please refer to here