Code Docs
StreamUP Product Documentation
General Notices
<aside>
<img src="/icons/info-alternate_blue.svg" alt="/icons/info-alternate_blue.svg" width="40px" /> Please make sure you have followed the standard product installation steps for StreamUP products.
Install the product into OBS.
Getting Started
Install the product into Streamer.Bot and use our DLL so make sure you follow the instructions below!
Installing Products into Streamer.Bot
All these links go to the same page but for easy of access I included them all so that you can clearly see what is required to do before continuing!
</aside>
User Guide
Alright, now that you have installed everything that is required into Streamer.Bot it is time to start using the product. If you are unsure what some of the settings were and what they did you can see explanations at the bottom of this guide.
<aside>
<img src="/icons/info-alternate_blue.svg" alt="/icons/info-alternate_blue.svg" width="40px" /> If there is an tiny image, you can click on the image to see a enhanced version of it.
</aside>
How to Use
You can use any trigger with this product. If you are using the setting ‘Manually end the effect’ the first time its triggered it will begin the animation. You can then trigger it a second time to end it. We would recommend setting the trigger as a hotkey or even use the Streamer.Bot stream deck plugin.
Settings
This is an overview of what all the settings do. You can access this menu by going to the Minim Poll • Settings action then right clicking the Test trigger, then press Test Trigger.
Buttons
Reset Button
- Function: Resets all settings to their default values.
- Location: Bottom-left corner of the UI.
- Action: Click to reset all settings to default.
Save Button
- Function: Saves the current settings.
- Location: Bottom-centre of the UI.
- Action: Click to save your changes.
Cancel Button
- Function: Discards any changes and closes the settings window.
- Location: Bottom-right corner of the UI.
- Action: Click to discard changes and exit the settings menu.
General Settings
OBS Connection Number
- Description: Specifies the OBS connection number. This number can be found on the left of your OBS connection in the 'Stream Apps -> OBS' tab.
- Usage: Select the appropriate OBS connection number to link Minim Poll with your OBS setup.
Full screen mode
- Description: Enables full screen mode for the Twitch disconnect effect.
- Usage: Check this option to display the Twitch disconnect effect in full screen.
Manually end the effect
- Description: Allows the user to manually end the Twitch disconnect effect.
- Usage: Check this option if you want to manually end the Twitch disconnect effect.
How long the source freezes before looking like it is buffering (in ms)
- Description: Duration (in milliseconds) that the source freezes before appearing to buffer.
- Usage: Enter the desired duration in the input field.
How long the buffering animation lasts (in ms)
- Description: Duration (in milliseconds) that the buffering animation lasts.
- Usage: Enter the desired duration in the input field.
How long the twitch disconnection animation plays (in ms)
- Description: Duration (in milliseconds) that the Twitch disconnection animation plays. This setting is ignored if 'Manually end the effect' is enabled.
- Usage: Enter the desired duration in the input field.