Code Docs

StreamUP Product Documentation

CodecMoments-InstallGuide.png


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

  1. When you run the settings action, then press save and close. You will be prompted to finish the setup in OBS with the following message:

    image.png

  2. In OBS there will be a properties window open. Select the Clone dropdown and select the source you wish to take photos of. Then press OK

    image.png

  3. You can then unlock the Codec Moments • Camera source then resize and move it to fit in the right box. You can also choose to hide the browser source if you want to show the animated static effect.

    image.png

  4. You need to set how you want this effect to trigger by selecting the Actions tab. Under the Actions window on the left select Codec Moments • Action. Under the Triggers window on the right, right click and add the method you want this effect to trigger. You will need to use something that has a users message. Such as a Donation, Cheer, Super Chat, Channel Point etc.

    image.png

Animating The Codec With Audio

  1. Go to the StreamUP FX • Codec Moments scene and right click the Codec Moments • Waveform source and select Properties

    Codec Moments FX - Edit Waveform 1.png

  2. Under the Audio Source option. Select the audio source you would like the waveform to animate to

    Codec Moments FX - Edit Waveform 2.png

  3. You may want to adjust the Floor and Ceiling options to adjust the sensitivity of the waveform to your audio source

    Codec Moments FX - Edit Waveform 3.png

Make It Your Own!

We have set this product up to be modular. This means you could create your own action in Streamer.Bot using the Actions provided.

You can utilise the following actions so you can create your own unique codec calls on stream and even end the call whenever you like.

Action Result
Codec Moments • Custom • 1. Codec Call Received This will start ringing the codec.
Codec Moments • Custom • 2. Start Codec Call This will transition to the codec scene and open the codec
Codec Moments • Custom • 3. End Codec Call This will end the codec call and return to the previous scene

Settings

This is an overview of what all the settings do. You can access this menu by going to the Codec Moments • Settings action then right clicking the Test trigger, then press Test Trigger.


General Settings

OBS Connection Number

Random Codec Frequency Number

image.png


Performance Settings

Text Glow Effect

Window Glow Effect

Window Outline Effect

Window Scan Line Effect

Choppy Old School Frame Rate