Singular and Elgato Streamdeck

Option 1: Bitfocus Companion Module

Bitfocus Companion enables the Elgato Streamdeck to be a professional shotbox surface for an increasing amount of different presentation switchers, video playback software and broadcast equipment. 

Companion version 2.1.1 includes a module to trigger Singular animations, set control nodes, trigger buttons, and change checkbox states.. Companion allows assigning multiple actions to one button, e.g., switch the scene in OBS and show a specific Subcomposition / layer in Singular. 

1 - Download Companion Build 2.1.1

Streamdeck_1.jpg

You can download the Companion here (Make sure to download the latest build!): https://bitfocus.io/user/downloads

If you are interested, you can check out the code on GitHub here: https://github.com/bitfocus/companion-module-singularlive-studio

2 - Login

Add your login username and password.

Start Stream Deck by selecting "Launch GUI"

If users are interested, they can check out the code on GitHub here: https://github.com/bitfocus/companion-module-singularlive-studio

3 - Create “Singular.live Studio” Instance

Head over to the “Instances” tab and search for Singular. Add the appearing “Singular.live Studio” option.

Streamdeck_2.jpg

Note if you cannot find “Singular.live Studio” check the app UI to see if there is a notice to update your app version. If there is, update it.

4 - Configuration

Streamdeck_3.jpg

Custom label

Add in your custom label.

API URL

Open the “Tools Menu” in your control app and select “Manage Access”

Streamdeck_4.jpg

“Generate” shared URLs and copy the API URL and paste it into the companion configuration.

Streamdeck_5.jpg

To finish, hit the red “Apply changes” button.

5 - Confirm Status

Check the status of your connection by going to the “Instances” tab and making sure the Status box says OK.

Streamdeck_6.jpg

You should also check the Log and see if any warnings have popped up. Typically at this time you’ll see a warning related to the control app not being found. If this is the case, double check that you entered the correct Control App ID.

Streamdeck_7.jpg

6 -  Create IN button

Streamdeck_8.jpg

Select a blank button

Select a blank button in the BUTTON LAYOUT panel.

Streamdeck_12.jpg

Add key down/on action

Now shift your attention to the “Edit button” panel. Inside the KEY DOWN/ON ACTIONS space, hit “+ Add key down/on action” and choose “singular: Animate In”.

Streamdeck_10.jpg

Then select the Composition you want to control. In this example, we have chosen “Panel Left - Image”

Streamdeck_11.jpg

Skip the KEY UP/OFF ACTIONS and the INSTANCE FEEDBACK fields. These are currently unnecessary.

7 - Create OUT button

Select a blank button

Streamdeck_9.jpg

Select a new blank button in the BUTTON LAYOUT panel. 

Add key down/on action

Now shift your attention to the “Edit button” panel. Inside the KEY DOWN/ON ACTIONS space, hit “+ Add key down/on action” and choose “singular: Animate Out”.

Streamdeck_13.jpg

Then select the Composition you want to control. In this example, we have again chosen “Panel Left - Image”

Streamdeck_14.jpg

Skip the KEY UP/OFF ACTIONS and the INSTANCE FEEDBACK fields. These are currently unnecessary.

8 - Test

Pull up either the web buttons or the mobile buttons to test your buttons. In this example we have pulled up the web buttons.

Streamdeck_15.jpg

If you click your IN button, your overlay should animate on in your output. Similarly, if you click your OUT button, the overlay should animate out in your output.

Streamdeck_16.jpg

If something isn’t working, refresh your Companion app browser window and try again. Sometimes this will resolve the issue. If refreshing doesn’t work, try changing the Composition selection of each button to another Composition and back to the one you previously chose.

Limitations Notes: 

  • You will also have to update the contents of your ovelays inside of the Composition and not the Control App as this plugin reads the Composition.
  • The plugin doesn't evaluate the current animation states of Subcompositions in the same logic layer.
  • In the future, the plugin should read the animation states of the Subcomposition in the app instance and update the status of buttons accordingly.

Option 2: Native Stream Deck Plugin (In Development)

Required Hardware and Software

Streamdeck_17.jpg

1 - Start Stream Deck

Double click the app to start.

Streamdeck_18.jpg

2 - Prep the button

Streamdeck_19.jpg

Drag and drop the "Singular Control v1.0" plugin onto an empty button. If you can’t find the plugin, search for it in the search bar in the upper right.

Once the plugin has been added to a button, select the button and enter:

Title

This should already be defined for In and Out states but you can change this.

Shared API URL
This can be accessed by selecting the gear icon in your Studio show and choosing the "Manage Access" button.

Streamdeck_20.jpg

Then, hit the "Generate" button and copy the API URL.

Streamdeck_21.jpg

Subcomposition

The name of the individual overlay/subcomposition that you want to control. Now your button is set for control!

3 - Operate

Clicking on the Stream Deck button toggles the animation state of the subcomposition

The icon on the button changes from green = IN to red = OUT 

Limitations Notes: 

  • You will also have to update the contents of your overlays inside of the Composition and not the Control App as this plugin reads the Composition.
  • The plugin doesn't evaluate the current animation states of Subcompositions in the same logic layer.
  • In the future, the plugin should read the animation states of the Subcomposition in the app instance and update the status of buttons accordingly.

 

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.