⏵ Home ⏵ Join The Aitum Discord ⏵ Getting Started ⏵ FAQ
Rules
⏵ Rules ⏵ Triggers ⏵ Checks ⏵ Actions ⏵ Local Variables ⏵ Queues
Concepts
⏵ Devices ⏵ Integrations ⏵ Global Variables ⏵ Extensions ⏵ Settings
Advanced
← Previous
OBS Studio
For OBS version 28.0 and higher
Aitum supports integrating with OBS Studio. This allows you to control your OBS instance, including switching scenes, managing sources, and more. You can also use scene switches as triggers to activate rules in Aitum. While there are many forks and derivatives of OBS, we only guarantee support with OBS Studio. If you are using Streamlabs Desktop, we support that separately.
Setup
To get started, open OBS and go to Tools → Websocket Server Settings in the toolbar. On this window, you will see the settings for your OBS websocket. Ensure that “Enable WebSocket server” is checked under Plugin Settings, then make a note of the port and optionally enable authentication. The settings you see on this page will be used within the Aitum app to configure the integration with OBS.
After configuring OBS websocket, open Aitum and then go to the Settings tab. Click on Integrations to access the integrations page. Click New Integration to open the new integration wizard, and then select OBS. Give your integration a unique name that you will remember it by (useful if you have multiple OBS instances!), and then enter the port and the password of your OBS websocket. You only need to enter a password if you checked “Enable Authentication” on the OBS websocket settings.
After you press Save, Aitum will automatically try and connect to your OBS websocket. If the connection failed, you will be informed by an error message on the app.
Aitum with automatically connect to OBS if you already have OBS running when launching the Aitum App. If Aitum is running prior to starting OBS, you will need to recconect by going to the integrations page and pressing the ‘Reconnect’ button on your OBS integration.
Triggers
Actions
Change Scene Filter Visibility
Open Projector
Broadcast Custom Message
Set Browser Source Properties
Set Display Source Properties
Change Source Filter Settings
Change Scene Filter Settings
Send Vendor Request
Screenshot
Vertical: Change Scene
Vertical: Start/Stop Streaming
Vertical: Toggle Streaming
Vertical: Start/Stop Recording
Vertical: Toggle Recording
Vertical: Start/Stop Backtrack
Vertical: Toggle Backtrack
Actions
Open Projector
Use this to open a projector window for a source in OBS.
Fields:
Field | Required | Field Type | Allows Variables | Description |
Preview Type | Yes | Text (dropdown) | Yes | The type of projector you want |
Monitor | No | Text (dropdown) | Yes | The monitor you want to display the projector on (fullscreen) |
Name | No | Text | Yes | The name of the source you wish to display |
Broadcast Custom Message
Use this to broadcast a custom websocket message in OBS.
Fields:
Field | Required | Field Type | Allows Variables | Description |
Message | Yes | Text | Yes | The message you want to broadcast. Please read the OBS websocket documentation for more info |
Set Browser Source Properties
Use this to change a browser source settings in OBS.
Fields:
Field | Required | Field Type | Allows Variables | Local Variable Usage | Description |
Browser Source | Yes | Text (dropdown) | No | Yes | Name of the browser source |
URL | No | Text (dropdown) | No | Yes | The URL of the a webpage |
FPS | No | Text | No | Yes | How many frame per seconds to play the browser source back |
Route Audio to OBS | No | Switch | No | No | Choose whether or not for OBS to control the audio level |
Set Display Source Properties
Use this to change a display source settings in OBS.
Fields:
Field | Required | Field Type | Allows Variables | Local Variable Usage | Description |
Display Source | Yes | Text (dropdown) | No | Yes | Name of the Display Source |
Display | No | Text (dropdown) | No | Yes | The display screen to be selected |
Show Cursor | No | Text | Yes | No | Show cursor on the display source |
Change Source Filter Settings
This is an advanced feature.
Use this to change source filter settings in OBS.
When editing the filter settings data, you should use valid JSON. Aitum will validate your JSON as you are typing. However, Aitum has no knowledge of what keys or values are valid for a filter. Therefore, there may be some filters which have ranges or restrictions, and it is down to you to know what restrictions there are.
For example, a filter in the OBS interface may have a parameter which can be between 1-100. If you set the value of that filter parameter to 101 in Aitum, the request will fail silently. You should also ensure that you are using the correct data types. Some filter parameters may use numbers instead of strings, for example.
When you first select a filter, Aitum will pre-populate the JSON textbox with your current settings for that filter, to give you hints on what you can change.
Fields:
Field | Required | Field Type | Allows Variables | Local Variable Usage | Description |
Source | Yes | Text (dropdown) | No | Yes | Name of the source |
Filter | Yes | Text (dropdown) | No | Yes | Name of the filter |
Edit Filter Settings (Data) | Yes | String | No | Yes | Change the filter properties in a JSON string |
Change Scene Filter Settings
This is an advanced feature.
Use this to change scene filter settings in OBS.
When editing the filter settings data, you should use valid JSON. Aitum will validate your JSON as you are typing. However, Aitum has no knowledge of what keys or values are valid for a filter. Therefore, there may be some filters which have ranges or restrictions, and it is down to you to know what restrictions there are.
For example, a filter in the OBS interface may have a parameter which can be between 1-100. If you set the value of that filter parameter to 101 in Aitum, the request will fail silently. You should also ensure that you are using the correct data types. Some filter parameters may use numbers instead of strings, for example.
When you first select a filter, Aitum will pre-populate the JSON textbox with your current settings for that filter, to give you hints on what you can change.
Fields:
Field | Required | Field Type | Allows Variables | Local Variable Usage | Description |
Scene | Yes | Text (dropdown) | No | Yes | Name of the scene |
Filter | Yes | Text (dropdown) | No | Yes | Name of the filter |
Edit Filter Settings (Data) | Yes | String | No | Yes | Change the filter properties in a JSON string |
← Previous