OBS control
Let a gift switch your scene, show a source, turn on a filter or write into a text source
Vfinity can drive OBS Studio through the WebSocket server built into OBS. An event or a Quick Deck pad can then switch your scene, show or hide a source, turn a filter on or off, or write into a text source.
Connect to OBS
Switch on the server in OBS
In OBS, choose Tools → WebSocket Server Settings. Turn the server on and copy its password.
Open the OBS card in Vfinity
Go to SettingsConnections. Under Apps, find OBS Studio and turn on Control OBS.
Enter the address and password
Leave IP Address as 127.0.0.1 and Port as 4455 when OBS runs on this
PC. Paste the password into Server password.
Connect
Click Connect to OBS. When it connects, the card says how many scenes and sources it found.
The OBS password is kept in a place of its own on this PC, not in your settings. A backup carries it only if you tick Include passwords and tokens, and it is blanked out of an exported support log.
Add an OBS step
In an event or a Quick Deck pad, add a step and choose Control OBS. Then pick What it does:
| Choice | Fields | What happens |
|---|---|---|
| Switch scene | Scene | Switches the program scene. |
| Show or hide a source | Scene, Source, State | Shows, hides or toggles a source in a scene. |
| Turn a filter on or off | Source, Filter, State | Turns a source's filter on, off or toggles it. |
| Write into a text source | Text source, Text | Replaces the text in a text source. |
State is Turn on, Turn off or Toggle. In Text, use {name},
{gift}, {count} and {diamonds} to name who set it off, as in
Thanks {name} for the {gift}!.
Try picking an action type below: the fields change as they do in the app.
Pick an event type and a step type. The fields change with them, as they do in the app.
Put things back afterwards
Put back after undoes the change after that many seconds, the way a hotkey toggles itself off: switch to a "Hype" scene for 10 seconds, then back to the one you were on. Leave it empty to keep the change.
Pick names from OBS, or type them
While OBS is connected, the Scene, Source and Filter fields fill themselves with what OBS has open. While it is closed, you can still type the names; spell them exactly as OBS does.
When OBS is not running
An OBS step checks OBS for itself. If OBS is not connected, that step reports "OBS is not connected", and the other steps in the same event, such as VTube Studio hotkeys, still run.
Overlays do not need this
Browser-source widgets such as alerts, goals and games work without an OBS connection. You only need it for Vfinity to change OBS itself.