Knowledge Base

03 Advanced

This will be a lengthier and more detailed rundown of the IRLToolkit server

Table of Contents


Control many of the basic features of the server.

  1. Navigation links to the Dashboard, Remote OBS, Settings, current stream destination, as well as shutdown and logout buttons
  2. Start and Stop buttons for the server. These control whether you are live on Twitch, YouTube or any other supported stream destination.
  3. Ingest controls. Mute buttons, current bitrate and a fix button used in case of buggy or non-responsive ingest.
  4. Scene switcher controls. You'll start with the default three: Ingest, Ingest Low-bitrate, and Ingest Offline.
  5. Screenshot pane gives you a periodic glimpse at what the server is currently receiving on the ingest.
  6. Bitrate graph gives you a 1 minute historical look at your ingest's bitrate.
  7. Server streaming status, uptime and bitrate status at the bottom for convenient at-a-glance updates

Nothing to configure here.

The bitrate graph and server status footer will only reflect the state of the Main Ingest.

OBS > Scene Collections

This list will be populated by the scene collections you create in the Remote OBS.
By default it will only have default-sc.
Currently, you cannot import scene collections made elsewhere.

If you plan on creating multiple Scene Collections, it is recommended to duplicate default-sc before making any changes so you can continue to use it as a clean template.

OBS > Remote

A cloud implementation of OBS.
Much of your server customization can be done through here.

Create new scenes, add and modify almost any source available to vanilla OBS in the same way you would on a PC.
However, many other settings will be locked and grayed out on this custom build of OBS.

The three default scenes Ingest, Ingest Low-bitrate, Ingest Offline cannot be renamed and are required for the automatic scene-switching system.

Included plugins are: StreamFX, Advanced Scene Switcher, and pango
Additional plugins may be added by request.

Small files (<100MB) can be uploaded by simply dragging them into the window.
Contact IRLToolkit staff to upload larger files.

In order to transfer clipboard contents you must push ctrl + alt + shift together to bring out the flyout panel and use the Clipboard box to transfer text to or from the remote OBS.

For example, to copy a widget URL to the remote OBS:

  • First copy the widget URL on your local PC.
  • Go to the remote OBS window and push ctrl + alt + shift and paste it into the panel.
  • ctrl + alt + shift once again to close the panel and now you'll be able to paste it into the desired line in remote OBS.

Extra things to note about Remote OBS

  • Cropping a source by dragging its boundary may differ from your previous experience with OBS.
    If alt alone does not work try alt + shift together.
  • Interacting with Remote OBS will reset the idle timeout built into your IRLToolkit server (it shuts down after 15 minutes of inactivity if it is not actively streaming).
  • Turning on the stream will turn off the preview pane in OBS, if it was enabled. If necessary, you can still go into Remote OBS while you are live and enable preview. However, be aware that you are interacting with a VNC and the more actively moving elements there are on the preview screen the more sluggish the remote will feel (only the remote, the stream itself will not be affected in normal circumstances).
    • Some of this can be alleviated by shrinking your browser window or dragging the dock handle above the Audio Mixer to shrink the preview area view port.
    • If you are making changes while offline, it's recommended to temporarily hide high motion visuals to improve responsiveness.
    • It's also good practice to disable the preview once you are finished and return to the Dashboard.

Settings > Destinations

You can have one Twitch destination via the connect with [Twitch] button.
Any subsequent connections made with the [Twitch] button will update the existing Twitch destination.

However, you can add as many Custom RTMP destinations as you like.
By using Twitch's Ingest Endpoints (US West recommended) you can also add any number of Twitch destinations by adding the corresponding stream keys manually.

Only one destination can be active.

Settings > System

Auto Scene Switcher

Configure the bitrate thresholds under which you want the server to consider your feed Low-bitrate or Offline.

The Auto Scene Switching system governs only the three default scenes: Ingest, Ingest Low-bitrate, Ingest Offline.
This means that as long as the current active scene is one of these three, scene switching logic will be determined by the Main Ingest bitrate.
However, if the current active scene is not one of the three default scenes then the auto scene switcher is temporarily paused. It will remain paused until you manually change scenes to one of the three default scenes, signaling the Auto Scene Switching system to resume control.

Example Scenario 1:

You turn on the server and set it to your custom made Intro scene.
You start the server and it begins streaming to Twitch.
Your viewers will be watching the Intro scene.
Now you turn on your streaming phone and verify that your server is receiving your phone's feed.
However, your viewers are still watching the Intro scene until you switch to Ingest.
You select Ingest and now your viewers can see your phone's feed but after a few minutes the network signal quality drops to 600 Kbps so the server seamlessly switches to the Ingest Low-bitrate scene.
You change locations to improve the bitrate and the server returns to the Ingest scene.

Example Scenario 2:

You've been streaming outdoors for a while but need to temporarily stop the stream so you can use the toilet.
You try selecting Ingest Offline but it instantly switches back to Ingest.
This is because your phone is still streaming to the server and if the server is receiving a feed with good bitrate then the Auto Scene Switching system's programming tells it to stay on the Ingest scene.
Instead, what you should do is turn off the phone's stream.
Then you can safely stow the phone and go about your business.
The server will see that the feed was interrupted and switch to Ingest Offline automatically.
Your server will still be online and streaming.
Once you are ready, you can turn the phone's stream back on and the server will switch back to Ingest.

When Scene Switch Mode is set to Default (when streaming) it will only engage while the server itself is streaming to your configured destination, even if there is an active ingest feed.
However, if it is set to Override (always) then scene switching logic will occur according to the Main Ingest bitrate, even when the server is not streaming. But only if the scene switching system is not otherwise paused (such as when the current scene is a custom scene created by the user.
Whereas, when set to Disabled (off) the Auto Scene Switcher will never change scenes.
This may be useful if you intend to program your own scene switching logic. The built-in system was designed for RTMP ingests and as such does not take into account an SRT ingest's round-trip time (RTT) parameter.

Twitch Bot

Enabling the IRLToolkit Twitch Bot allows it to receive chat commands and report certain status changes to your designated Twitch channel.
You can list multiple Twitch channels separated by a comma ,.

Ingest Locations

These are the ingest URLs and stream keys you will need so your streaming encoders and apps stream to IRLToolkit servers.
Keep this info private!!

Guides to configure specific encoders and phone apps for IRLToolkit

Main Ingest

If you only have one ingest, it is your Main Ingest.
If you have more than one ingest, you can select your Main Ingest under Ingest Locations by pushing the [Set as Main Ingest] button next to the corresponding Ingest Key.
The Dashboard screenshot preview, bitrate graph and server status footer will only reflect the state of the Main Ingest.

Some users may have an ingest named "Main Ingest" but if they have more than one ingest, it will not necessarily be their server's Main Ingest.

obs-websocket Access

Remote control access for your IRLToolkit Remote OBS.
Allows you to monitor, control and automate with an obs-websocket client.
Currently supporting protocol version 4.
Password is required.

More information on the obs-websocket GitHub

Settings > Video

Select your Remote OBS Canvas and Output resolution, FPS and bitrate.

Settings > API

Coming Soon!

Settings > Alerts

This is visible in the Settings menu while on the Dashboard.
Enabling it will play an audio alert when the Main Ingest bitrate falls below the Low-bitrate or Offline threshold.
This may be useful for IRL streamers with the web dashboard loaded on a companion app such as IRL Chat so they can hear an audio cue when bitrate has fallen.

Settings > Password

Change your password here.

Other Features

Custom OBS Browser Source JavaScript Events

Please rate this article to help us improve our Knowledge Base.

1 0