Send requests to OBS Studio.
DeviceJockey → OBS Studio
Use item commands to send configured OBS WebSocket requests.
- Examples
- Change a scene, control recording, or update a source
- Used by
- OBS Value and OBS Range commands
DeviceJockey Interfaces
OBS Studio Interface
Control OBS Studio and reflect its current state on your DeviceJockey panel.
OBS WebSocket connection
One connection works in both directions.
The OBS Studio interface connects DeviceJockey to the WebSocket server built into OBS Studio. Commands send requests to OBS. Incoming events and responses can update items or start commands through Remote Options.
React to the current OBS state.
OBS Studio → DeviceJockey
Events match incoming OBS messages and apply their values to supported items.
- Examples
- Show the active scene, a changing value, or connection statistics
- Used by
- OBS events and their Remote Options
You only add one OBS Studio interface.
The same WebSocket connection carries outgoing requests, incoming responses, and OBS events.
Setup
Connect DeviceJockey to OBS Studio.
1
Enable the WebSocket server
Open the WebSocket server settings in OBS Studio and enable the server.
2
Add the interface
Add an OBS Studio interface to the scene that contains your panel and controls.
3
Enter the connection details
Set the host, port, and password manually, or scan a compatible OBS WebSocket QR code.
4
Add commands and events
Assign the OBS interface to the items that should control OBS or display its state.
Connection settings
Use the address of the computer running OBS.
Enter the IP address or host name of the computer running OBS Studio.
Use the port configured for the OBS WebSocket server. The standard port for OBS WebSocket 5 is 4455.
Enter the authentication password from the OBS WebSocket server settings.
Scan an obsws:// connection code to fill in host, port, and an optional password.
Use protocol version 5 for current OBS Studio installations.
The interface displays the RPC version negotiated with OBS after connecting.
Commands
Send fixed or continuous values.
OBS requests are represented as JSON. DeviceJockey can replace Swaps before sending a request, so one command can adapt to the active configuration. The required request type and data depend on the function in OBS.
Send a configured JSON request. Use it for a fixed action or state.
Insert an item’s current position into a selected JSON attribute and map it between configured minimum and maximum values.
Clear the interface buffer before starting a new request and response sequence.
Choose an entry from an OBS list and write the selected value to a Swap.
Use a list when names can change.
Selecting an available scene, input, or hotkey from OBS is safer than typing its name into several controls.
Events and feedback
Make a panel reflect the state of OBS.
An OBS event compares an incoming WebSocket message with its configured JSON structure. Depending on the item and event type, DeviceJockey can use a matching value, a numeric range, a label, an enabled state, or OBS statistics.
React when an incoming response or event matches the configured value.
Read a dynamic numeric attribute and map it to the range of the item.
Read a selected attribute and show it as the item label.
Allow or protect supported item interaction when the configured OBS state matches.
Display selected OBS statistics such as CPU usage, memory usage, or available disk space.
The event choices shown in DeviceJockey depend on the selected item and the event being configured.
Bidirectional control
Combine an action with its feedback.
A scene button can send a request to change the current OBS scene. A corresponding event can react when OBS reports that scene as active. The button then reflects changes made from DeviceJockey, OBS itself, or another controller.
Events can do more than change appearance.
Use Remote Options when a matching OBS event should execute commands.
Learn about Remote Options →Troubleshooting
If DeviceJockey cannot connect to OBS.
Check the server.
Confirm that the WebSocket server is enabled in OBS Studio.
Verify host and port.
Compare the interface settings with the computer address and WebSocket port shown in OBS.
Check authentication.
Enter the current WebSocket password again or scan a newly generated connection QR code.
Check the network.
Make sure both devices can reach each other and that a firewall is not blocking the configured port.
Check the protocol.
Use protocol version 5 with current OBS Studio installations.