OBS Integration

The OBS Integration plugin connects MultiShock to OBS Studio. Its trigger nodes react to scene, stream, recording, audio, and filter changes, and its action nodes change scenes, toggle sources and filters, and start or stop streaming and recording. This page describes version 1.3.0. Install it from Manage plugins → Browse. See how nodes work for how to read the node diagrams.

Setup

Plugin pages are hidden from the sidebar until you turn them on; see showing a plugin's pages.

OBS Integration needs OBS Studio 28 or later, which has the WebSocket server built in.

  1. In OBS, open Tools → WebSocket Server Settings, check Enable WebSocket server, and note the port (4455 by default). Set a password if you want one, then click Apply.
  2. In MultiShock, open OBS Integration in the sidebar.
  3. Under Connection Settings, enter the Host (localhost when OBS runs on the same computer), the Port, and the Password if you set one.
  4. Click Connect. Turn on Auto-connect on startup to connect whenever MultiShock starts.

The connection does not reconnect by itself. If you close OBS, click Connect on the OBS Integration page again after reopening it. The page also shows an event log and a button for each of your scenes.

Errors

OBS action nodes always continue through Done, even when the request fails. Check the Success output, and read Error for the reason, for example OBS not connected or Source 'Webcam' not found in scene 'Main'. Send Success into an If node when later steps depend on the action working.

Names are matched exactly as they appear in OBS. Where a node has both an input and a property with the same name, a connected, non-empty input is used instead of the property.

Triggers

Trigger filters are optional. An empty filter matches everything; otherwise the name must match exactly, ignoring capitalization.

Scene Changed

Fires when the program scene changes. Scene changes in Studio Mode's preview do not fire it.

Scene ChangedTriggeredScene Name
Outputs
TriggeredFlow
Scene NameString
The new program scene.
Properties
Scene Filter
Only fire for this scene. Empty fires for every scene.

Source Visibility Changed

Fires when a source in a scene is shown or hidden.

Source Visibility ChangedTriggeredScene NameScene Item IDEnabled
Outputs
TriggeredFlow
Scene NameString
Scene Item IDNumber
OBS's ID for the item. The source's name is not included.
EnabledBoolean
True when the item is now visible.
Properties
Scene Filter
Only fire for this scene. Empty fires for every scene.
State Filter
Any Change, When Enabled, or When Disabled. Default Any Change.

Stream State Changed

Fires when streaming starts, stops, or is in the middle of starting or stopping.

Stream State ChangedTriggeredActiveState
Outputs
TriggeredFlow
ActiveBoolean
True while the stream is live.
StateString
OBS's state name, such as OBS_WEBSOCKET_OUTPUT_STARTED.
Properties
State Filter
Any Change, Started, Stopped, Starting, or Stopping. Default Any Change.

Record State Changed

Fires when recording starts, stops, pauses, or resumes.

Record State ChangedTriggeredActiveStateOutput Path
Outputs
TriggeredFlow
ActiveBoolean
True while recording.
StateString
OBS's state name, such as OBS_WEBSOCKET_OUTPUT_PAUSED.
Output PathString
The recording file, when OBS provides it.
Properties
State Filter
Any Change, Started, Stopped, Starting, Stopping, Paused, or Resumed. Default Any Change.

Input Mute Changed

Fires when an audio input is muted or unmuted.

Input Mute ChangedTriggeredInput NameMuted
Outputs
TriggeredFlow
Input NameString
MutedBoolean
Properties
Input Filter
Only fire for this input. Empty fires for every input.
Mute Filter
Any Change, When Muted, or When Unmuted. Default Any Change.

Filter Enabled Changed

Fires when a filter on a source is turned on or off.

Filter Enabled ChangedTriggeredSource NameFilter NameEnabled
Outputs
TriggeredFlow
Source NameString
Filter NameString
EnabledBoolean
Properties
Source Filter
Only fire for this source. Empty fires for every source.
Filter Filter
Only fire for this filter. Empty fires for every filter.
State Filter
Any Change, When Enabled, or When Disabled. Default Any Change.

Actions

Set Scene

Switches the program scene.

Set SceneExecuteScene NameDoneSuccessError
Inputs
ExecuteFlow
Scene NameString
Outputs
DoneFlow
SuccessBoolean
ErrorString
Properties
Scene Name
The scene to switch to.

Source Visibility

Shows, hides, or toggles a source in a scene.

Source VisibilityExecuteScene NameSource NameDoneSuccessNew StateError
Inputs
ExecuteFlow
Scene NameString
Source NameString
Outputs
DoneFlow
SuccessBoolean
New StateBoolean
True when the source is now visible.
ErrorString
Properties
Scene Name
The scene that contains the source. Empty uses the current program scene.
Source Name
The source to show or hide.
Mode
Show, Hide, or Toggle. Default Toggle.

Filter Enabled

Enables, disables, or toggles a filter on a source.

Filter EnabledExecuteSource NameFilter NameDoneSuccessNew StateError
Inputs
ExecuteFlow
Source NameString
Filter NameString
Outputs
DoneFlow
SuccessBoolean
New StateBoolean
True when the filter is now enabled.
ErrorString
Properties
Source Name
The source that has the filter.
Filter Name
The filter to change.
Mode
Enable, Disable, or Toggle. Default Toggle.

Stream

Starts, stops, or toggles streaming.

StreamExecuteDoneSuccessError
Inputs
ExecuteFlow
Outputs
DoneFlow
SuccessBoolean
ErrorString
Properties
Mode
Start, Stop, or Toggle. Default Toggle.

Record

Starts, stops, or toggles recording. There is no pause or resume action.

RecordExecuteDoneSuccessError
Inputs
ExecuteFlow
Outputs
DoneFlow
SuccessBoolean
ErrorString
Properties
Mode
Start, Stop, or Toggle. Default Toggle.

Input Mute

Mutes, unmutes, or toggles an audio input.

Input MuteExecuteInput NameDoneSuccessNew StateError
Inputs
ExecuteFlow
Input NameString
Outputs
DoneFlow
SuccessBoolean
New StateBoolean
True when the input is now muted. Always false in Toggle mode.
ErrorString
Properties
Input Name
The audio input to change.
Mode
Mute, Unmute, or Toggle. Default Toggle.

In Toggle mode the node does not read the new state back from OBS, so New State is always false. Use Mute or Unmute when a later step needs to know the result.

Trigger Hotkey

Presses an OBS hotkey by its internal name.

Trigger HotkeyExecuteHotkey NameDoneSuccessError
Inputs
ExecuteFlow
Hotkey NameString
Outputs
DoneFlow
SuccessBoolean
ErrorString
Properties
Hotkey Name
OBS's internal hotkey name, not the key combination.

Contributors

Thank you to everyone who has helped improve this documentation.

bwmpbwmp