You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Remote UI: edit OBS from another machine without remote desktop (properties schema, preview stream, graph as data)
#2509
This proposes an API-first path to a remote UI for OBS: the parts a client on another machine needs to edit a scene, not only to press buttons. It follows #1078 (headless and unattended OBS) and connects to #845 (filter graphs) and #2375 (an MCP server on obs-websocket).
1. The problem
Some people run OBS on a box without a monitor: a streaming PC in a rack, a VM or container with a GPU, a kiosk. See obsproject/obs-studio#12650. Control works well today: obs-websocket v5 with Companion, a Stream Deck or a script starts and stops outputs, switches scenes, mutes inputs.
Editing does not. To change a source's settings, add a filter or look at the preview, you open a remote desktop (VNC, RDP) into the box and use the Qt UI there. On my production box (Debian 13 LXC, RTX 3060) that is:
sluggish: the preview and every dialog go through a screen scraper;
not free: x11vnc alone costs about 0.9 of a core and 15 W while it runs (measured with our load test);
one session, one screen size, no touch layout.
2. Three levels
Remote desktop with GPU encode (Sunshine + Moonlight, or similar). No code and the full Qt UI; the stream is GPU-encoded, so it should be much smoother than VNC (I have not measured it on this box yet). It is still a remote desktop: one client, the box's screen layout, and it needs a display server and a desktop session on the box. It is also a setup task: a host service, pairing, ports, a client app on every device. For someone who is not technical, that is a lot more than opening a page in a browser, and that does not change with how well the stream performs.
An API-first remote UI. The box exposes what a UI needs over the network; the Qt UI is one client, a web or tablet UI is another. This is the proposal below.
Headless libobs without the frontend. Smallest, but it loses scene collections, profiles, output settings, transitions, hotkeys and every obs-frontend-api plugin (obs-websocket itself, DistroAV outputs). Only for a fixed appliance.
3. What is missing for level 2
obs-websocket v5 already has most of the control surface. Three gaps stop a client from editing:
A properties schema. A client can read and write a source's settings (GetInputSettings, SetInputSettings) and the items of one list (GetInputPropertiesListPropertyItems), but not the properties themselves: which fields exist, their types, limits, units, list items, groups, visibility and buttons. Without that, a client cannot draw a source's settings dialog; it has to know every source type by heart. The fork already has obs_properties in Rust (rust/obs-properties), so a JSON form of it is a small step.
AGENTS.md keeps the C++ obs-websocket plugin unchanged as a compatibility check. obs-websocket v5 has vendor requests for this: another plugin registers its own requests and events (obs_websocket_register_vendor), and clients call them over the same connection (CallVendorRequest). So a remote-ui plugin (Rust or C) can add requests such as GetPropertiesSchema (for an input, a filter, a transition or an output) without a change to obs-websocket, and existing clients keep working.
A suggested order:
GetPropertiesSchema as a vendor request. Useful on its own: Companion, scripts and an MCP server could build settings forms from it.
A preview stream (start with one, for example WHEP for the program output).
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
Uh oh!
There was an error while loading. Please reload this page.
This proposes an API-first path to a remote UI for OBS: the parts a client on another machine needs to edit a scene, not only to press buttons. It follows #1078 (headless and unattended OBS) and connects to #845 (filter graphs) and #2375 (an MCP server on obs-websocket).
1. The problem
Some people run OBS on a box without a monitor: a streaming PC in a rack, a VM or container with a GPU, a kiosk. See obsproject/obs-studio#12650. Control works well today: obs-websocket v5 with Companion, a Stream Deck or a script starts and stops outputs, switches scenes, mutes inputs.
Editing does not. To change a source's settings, add a filter or look at the preview, you open a remote desktop (VNC, RDP) into the box and use the Qt UI there. On my production box (Debian 13 LXC, RTX 3060) that is:
2. Three levels
obs-frontend-apiplugin (obs-websocket itself, DistroAV outputs). Only for a fixed appliance.3. What is missing for level 2
obs-websocket v5 already has most of the control surface. Three gaps stop a client from editing:
GetInputSettings,SetInputSettings) and the items of one list (GetInputPropertiesListPropertyItems), but not the properties themselves: which fields exist, their types, limits, units, list items, groups, visibility and buttons. Without that, a client cannot draw a source's settings dialog; it has to know every source type by heart. The fork already hasobs_propertiesin Rust (rust/obs-properties), so a JSON form of it is a small step.4. How, without touching obs-websocket
AGENTS.md keeps the C++ obs-websocket plugin unchanged as a compatibility check. obs-websocket v5 has vendor requests for this: another plugin registers its own requests and events (
obs_websocket_register_vendor), and clients call them over the same connection (CallVendorRequest). So aremote-uiplugin (Rust or C) can add requests such asGetPropertiesSchema(for an input, a filter, a transition or an output) without a change to obs-websocket, and existing clients keep working.A suggested order:
GetPropertiesSchemaas a vendor request. Useful on its own: Companion, scripts and an MCP server could build settings forms from it.5. Questions
If this settles on a shape, the properties schema would be the first issue.
All reactions