Broadcasters

OBS Studio

Configure Streamer.bot to interact with your OBS Studio instances
You must enable the OBS WebSocket connection. Check out the Get Started Guide for details.
Navigate to Stream Apps > OBS in Streamer.bot

OBS Studio Configuration

Configuration

To add a new connection, Right-Click anyhere in the panel area and select Add:

OBS Studio Add Connection

Configuration options are outlined below:

Namerequired
Text

Enter any name or label to describe this OBS instance, e.g. Local OBS

Versionrequired
Select

Select the version of OBS WebSocket to use for this connection.

As of OBS Studio v28.0.0, OBS WebSocket v5 is included by default.
  • To continue using OBS WebSocket v4.9+, you must install the obs-websocket-4.9.1-compat plugin
  • It is recommended to update to if you are currently using an older version.
Hostrequired
Text
default:127.0.0.1

Enter the host address of your OBS WebSocket Server

If OBS Studio is running on the same machine as Streamer.bot, keep 127.0.0.1

For multi-pc setups you can configure this with another LAN IP address, e.g. 192.168.1.10

Portrequired
Number
default:4455

Enter the port of your OBS WebSocket Server

  • Default: 4455 (v5+) or 4444 (v4.9+)
    It is recommended to keep the defaults unless you are using multiple OBS portable installs on the same desktop.
Password
Text

If you configured authentication in OBS, enter the password for your OBS WebSocket Server

Auto Connect on Startup
Toggle

Automatically connect to this OBS Studio instance when Streamer.bot starts up

Reconnect on Disconnect
Toggle

Automatically reconnect to this OBS Studio instance when the connection is disrupted

Retry Interval
Number
default:30

Change the interval of reconnection attempts when Reconnect on Disconnect is enabled

Context Menu

Right-Click on a configured connection to reveal the context menu:

Add

Add a new OBS Studio connection

Edit

Edit the selected OBS Studio connection

Delete

Delete the selected OBS Studio connection

Auto Connect

Quickly toggle the Auto Connect on Startup configuration option for the selected connection

Reconnect

Quickly toggle the Reconnect on Disconnect configuration option for the selected connection

Default

Set this connection as the default when importing actions

If no default is set, imported actions will default to the first connection in the list

Force

Temporarily override all OBS Studio connections to use the selected connection.

This setting does not persist when you restart Streamer.bot

Update All Actions To...

Reconfigure all actions utilizing an OBS Studio connection to use the selected connection

Connect

Manually attempt to connect to the selected connection

Status Panel

Selecting a connected OBS instance in the left panel will reveal additional realtime information about that instance on the right panel.

OBS Information

Shows the version numbers of OBS Studio and WebSocket plugin

Current Scene

Shows the name of the currently broadcasting scene on the selected connection

Stream Status

Shows the status of the current streaming and recording activity

Sources

Lists all sources present on the currently selected scene

Usage

28Sub Actions

OBS Studio Sub-Actions

Complete control of your broadcast with OBS WebSocket support
Explore
8Triggers

OBS Studio Triggers

React to connection events & client specific events from OBS Studio
Explore
66Methods

C# Methods

Reference of all methods available within your custom C# code actions
Explore