OBS Studio
Control OBS scenes, sources and filters and react to OBS events.
AlphaCapabilities
- Run actions against scenes, scene items, inputs, filters, recording, replay and streaming.
- Receive supported OBS events, including scene, recording, replay and stream changes.
- Manage reusable OBS slots, assets and bindings in the OBS workspace.
Signals6 items
| Name | Description |
|---|---|
| OBS Recording Started | Trigger when OBS starts recording. |
| OBS Recording Stopped | Trigger when OBS stops recording. |
| OBS Replay Saved | Trigger after OBS saves a replay-buffer clip. |
| OBS Scene Changed | Trigger when the current OBS program scene changes. |
| OBS Stream Started | Trigger when OBS starts streaming. |
| OBS Stream Stopped | Trigger when OBS stops streaming. |
Steps38 items
| Name | Description |
|---|---|
| OBS: Audio Mute | Mute an OBS audio source or configured slot. |
| OBS: Audio Set Monitor Type | Set the monitoring mode for an OBS audio source. |
| OBS: Audio Set Sync Offset | Set the audio synchronization offset. |
| OBS: Audio Set Volume (dB) | Set audio volume in decibels. |
| OBS: Audio Set Volume (mul) | Set audio volume as a multiplier. |
| OBS: Audio Toggle Mute | Toggle the muted state of an audio source. |
| OBS: Audio Unmute | Unmute an OBS audio source or configured slot. |
| OBS: Filter Disable | Disable a filter on an OBS source. |
| OBS: Filter Enable | Enable a filter on an OBS source. |
| OBS: Filter Get Settings | Read the current settings of an OBS filter. |
| OBS: Filter Set Settings | Update the settings of an OBS filter. |
| OBS: Slot Restart Media | Restart media assigned to a configured OBS slot. |
| OBS: Slot Set Asset | Assign a reusable OBS asset to a configured slot. |
| OBS: Recording Get Status | Read the current OBS recording status. |
| OBS: Recording Get Time | Read the elapsed recording time. |
| OBS: Recording Start | Start recording in OBS. |
| OBS: Recording Stop | Stop recording in OBS. |
| OBS: Recording Toggle | Start or stop recording according to its current state. |
| OBS: Replay Get Last Saved | Read information about the last saved replay. |
| OBS: Replay Get Status | Read the current replay-buffer status. |
| OBS: Replay Save | Save the current replay buffer. |
| OBS: Replay Start Buffer | Start the OBS replay buffer. |
| OBS: Replay Stop Buffer | Stop the OBS replay buffer. |
| OBS: Get Current Program Scene | Read the current program scene. |
| OBS: Scene Transition | Switch to another scene with a transition. |
| OBS: Source Get Transform | Read a scene item's position, scale, rotation, crop and bounds. |
| OBS: Source Hide | Hide an OBS scene item. |
| OBS: Source Media Action | Run a supported playback action on a media source. |
| OBS: Source Refresh Browser | Refresh an OBS browser source. |
| OBS: Source Set Text | Update the text of a supported OBS source. |
| OBS: Source Set Transform | Set a scene item's position, scale, rotation, crop or bounds. |
| OBS: Source Show | Show an OBS scene item. |
| OBS: Source Toggle | Toggle the visibility of an OBS scene item. |
| OBS: Stream Get Status | Read the current OBS streaming status. |
| OBS: Stream Get Time | Read the elapsed streaming time. |
| OBS: Stream Start | Start streaming in OBS. |
| OBS: Stream Stop | Stop streaming in OBS. |
| OBS: Stream Toggle | Start or stop streaming according to its current state. |
Integration signals can start automations. Integration actions are added as steps.
Requirements
- OBS Studio with obs-websocket support enabled.
- A reachable WebSocket address, port and password when authentication is enabled.
Connect
- In OBS, open Tools → WebSocket Server Settings.
- Enable Enable WebSocket server. Keep authentication enabled unless you have a specific local setup that does not need it, then select Apply.
- Select Show Connect Info and keep the displayed server IP, port and password available.
- In Streaming Hub, open Services → OBS, or double-click OBS in the status bar.
- Enter the OBS server IP or host, port and password in the matching fields.
- Select Apply or Save, then confirm that Diagnostics reports Connected: True.
Verify the connection
The OBS service indicator shows a connected state and Diagnostics reports Connected: True. Open the OBS workspace and select Refresh to confirm that current OBS resources can be read.
OBS entities and bindings
After connecting, open the OBS workspace to create reusable Slots and Assets. Bind each portable Slot to the matching scene, text source, media source, filter or other item in the connected OBS instance.
Use Assets for reusable images, media, playlists and other content that a Slot can reference. The image path in this example has been hidden for privacy.
See OBS workspace for the annotated interface and the difference between Slots and Assets.
Limitations
Actions depend on the names and identifiers available in the connected OBS instance. Renaming or removing OBS resources can invalidate saved references.
Troubleshooting
Check the service status and filter the Log panel by the integration source. Reopen the integration settings to check connection details, enabled options and required external-service permissions.