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
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.
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
Custom label
Add in your custom label.
API URL
Open the “Tools Menu” in your control app and select “Manage Access”
“Generate” shared URLs, copy the API URL, modify it to work with Singular's APIv1, and paste it into the companion configuration.
IMPORTANT! Do not skip this step: The Companion plugin only works with Singular AP1 Version 1. Modify your API URL to use APIv1. Replace /apiv2/ with /apiv1/ .
To finish, hit the red “Apply changes” button in Companion.
5 - Confirm Status
Check the status of your connection by going to the “Instances” tab and making sure the Status box says OK.
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.
6 - Create IN button
Select a blank button
Select a 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 In”.
Then select the Composition you want to control. In this example, we have chosen “Panel Left - Image”
Skip the KEY UP/OFF ACTIONS and the INSTANCE FEEDBACK fields. These are currently unnecessary.
7 - Create OUT button
Select a blank button
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”.
Then select the Composition you want to control. In this example, we have again chosen “Panel Left - Image”
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.
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.
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.
Comments
4 comments