Singular and Elgato Streamdeck Using Bitfocus Companion

Bitfocus Companion enables the Elgato Streamdeck to be a professional shotbox surface your Singular graphics.

Companion includes a module to trigger Singular animations, set control nodes, trigger buttons, change checkbox states and more. 

1 - Download Bitfocus Companion (Latest Stable Version)

Companion-v3.2.2-#1.jpg

You can download the Bitfocus 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 - Add "Singular.live" Connection 

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

Companion-v3.2.2-#3.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.

3 - Connection Configuration

Companion-v3.2.2-#5.jpg

Custom label

Add in your custom label.

Public App Token

Click on your desired Singular.live app within your Singular Dashboard and select the Dashboard Inspector (i) button.

Screen Shot 2024-04-23 at 7.09.54 PM.png

Copy the Public App Token. Then paste into the API URL/Token field within the Companion field.

To finish, hit the green “Save” button in Companion.

4 - Confirm Status

Check the status of your connection by making sure the Status box of your Singular connection has a green checkmark.

Screen Shot 2024-04-23 at 7.11.25 PM.png

5 -  Create Button

Head to the Buttons tab.

Create a button

Select a blank button in the BUTTON LAYOUT panel.

Streamdeck_12.jpg

Then select the Create button option in the Edit Button panel on the right side.

Screen Shot 2024-04-23 at 7.26.26 PM.png

Add a "Press action"

In the “Edit button” panel, scroll down to the "Actions" tab section.

Screen Shot 2024-04-23 at 7.30.34 PM.png

Select the Red folder icon next to the Press actions section (or Release actions but lets stick to Press for now) to find a Singular.live action. Then browse the actions and choose your desired Singular action:

Screen Shot 2024-04-23 at 7.35.07 PM.png

Then select the Composition/graphic you want to control:

Screen Shot 2024-04-23 at 7.33.54 PM.png

6 - Test

Test your button directly in the module by selecting the test icon on the top of the panel:

Screen Shot 2024-04-23 at 7.34.50 PM.png

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.

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

Comments

4 comments

  • It would be ideal for the Subcomposition field in Stream Deck to target Overlay Name instead of Subcomposition. We have a few Overlays of the same Template, and we can only trigger the first one added to the project unless we duplicate Subcompositions.

    0
  • Hi Daniel,
    Thank you very much for your comment!
    I assume that with "overlay name," you refer to items in the Studio app playlist.
    The Stream Deck Companion Module and the Stream Deck Plugin use the Singular REST API (https://api.singular.live/) to control the Singular output directly. The REST API provides endpoints to send data to your composition and trigger animations.
    The Singular Studio App does not have a REST API and cannot be controlled with Stream Deck today.
    We've received some requests to control Studio Playlists with Stream Deck. We are discussing this pretty complex topic.

    0
  • We recently started using Companion in our Workflow and love it and the integration with Singular. First, I have a bit of an issue. It seems like the "Activate Button" control does not work.

    Also, I concur with the above. We use a number of Google Sheet data sources and have found that we need to put these elements into program once before we call them from companion. Otherwise it pulls the default data from the comp, Lastly, I noticed that there is a new companion beta out but no plugin for Singular. Will there be one?

    Thanks

    0
  • Hi jbenton1,

    Please submit a ticket to the support portal, including the following details:

    • Which "Activate Button" do you refer to?
    • App instance URL
    • Composition URL

    Updating the Singular plugin for Companion v3 is on the R&D to-do list. We haven't yet specified a release date. Please follow our newsletter for updates.

    tm

    0

Please sign in to leave a comment.