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

There are a few different ways of triggering this poll.

1. If you are a Twitch affiliate you can create a poll as normal on Twitch and it will be automatically reflected in OBS.
2. If you are a YouTube streamer or not an affiliate on Twitch you can use the StreamUP Poll system to trigger the poll. Just install the free system with the link below and create a poll. It will automatically be sent to OBS. https://streamup.tips/product/poll-system

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.

General Settings

Force all text to uppercase

• Description: Converts all displayed text to uppercase.
• Usage: Check this option if you want all text in the poll widget to be displayed in uppercase.

Add Transparency to the background

• Description: Makes the background of the poll widget transparent.
• Usage: Check this option to add transparency to the poll widget's background, allowing your stream content to be visible behind it.

Add Rounded Corners

• Description: Adds rounded corners to the poll widget.
• Usage: Check this option to apply rounded corners to the poll widget for a smoother appearance.

The text displayed when a poll completes

• Description: Customizable message shown when a poll ends.
• Usage: Enter the message you want to display when a poll is completed.

How long the poll stays on screen when completed

• Description: Duration (in milliseconds) that the completed poll message remains on screen.
• Usage: Select the desired duration from the dropdown menu.

The text displayed when a poll is terminated

• Description: Customizable message shown when a poll is cancelled or terminated.
• Usage: Enter the message you want to display when a poll is terminated.

How long the poll stays on screen when terminated

• Description: Duration (in milliseconds) that the terminated poll message remains on screen.
• Usage: Select the desired duration from the dropdown menu.

Colour Settings

Customize the appearance of the poll widget by selecting colours for various elements.

Title text colour

• Description: Sets the colour of the poll title text.
• Usage: Click the "Pick a colour" button to select a colour .

Answer text colour

• Description: Sets the colour of the answer choices text.
• Usage: Click the "Pick a colour" button to select a colour.

Background colour

• Description: Sets the background colour of the poll widget.
• Usage: Click the "Pick a colour" button to select a colour.

Dividers colour

• Description: Sets the colour of the dividers between choices.
• Usage: Click the "Pick a colour" button to select a colour.

Amount bar colour (How many votes)

• Description: Sets the colour of the bar indicating the number of votes each choice received.
• Usage: Click the "Pick a colour" button to select a colour.

Amount text colour (How many votes)

• Description: Sets the colour of the text showing the number of votes each choice received.
• Usage: Click the "Pick a colour" button to select a colour.

Winning animation colour

• Description: Sets the colour of the animation that appears when a choice wins.
• Usage: Click the "Pick a colour" button to select a colour.

Countdown bar colour

• Description: Sets the colour of the countdown bar showing the remaining time for the poll.
• Usage: Click the "Pick a colour" button to select a colour.