Settings-OBS-Recording-Plugin

OBS Recording Configuration

OBS Recording settings

Integrates QUP with OBS Studio via WebSocket so each singer's performance is automatically recorded as a separate file. OBS must be running with the WebSocket server enabled.

OBS Recording comes with QUP. Its settings are in Preferences → Plugins → OBS Recording (Preferences is Ctrl+P).

The connection status is shown at the top of the panel. It reads "Not connected" until you click Test Connection, then shows "Connected to OBS v…" or "Connection failed:" with the reason.

Enable OBS recording — Turns automatic recording on or off. When enabled, QUP tells OBS to start recording when a karaoke song begins and stop when it ends. Click Save Settings after turning it on.

Connection

Host — The IP address of the machine running OBS. Default is 127.0.0.1 (localhost) if OBS is on the same computer as QUP.

Port — The WebSocket port OBS is listening on. Default is 4455, which matches OBS's default WebSocket server port.

Password — The WebSocket password configured in OBS. Leave blank if you have not set a password in OBS's WebSocket settings.

Recording

Each recording is renamed to the date, the singer and the song, for example October 31, 2026 Marla Quint Amazing Grace.mkv. If that name is already taken, QUP adds (2), (3) and so on.

Output directory — Where finished recordings end up. Leave it blank to keep them in OBS's own recording folder (QUP asks OBS where that is). Enter a folder to have each finished recording moved there.

File extension — Default .mkv. QUP doesn't change OBS's recording format: set the format in OBS (Settings > Output > Recording) and enter the same extension here. MKV is recommended because it is resilient to crashes — if OBS or QUP stops unexpectedly, the file is still playable. You can remux to MP4 later from within OBS.

Scene Control

QUP can automatically switch OBS scenes at different points during a performance, giving your stream or recording a polished, professional look. Leave any scene name blank to skip that step. Scene names must match the names in OBS exactly.

Enable scene switching — Turns automatic scene switching on or off.

Intro scene — The OBS scene to switch to when the song starts, just after recording begins.

Intro duration (sec) — How long the intro scene is shown before switching to the singing scene (0 to 30 seconds, default 0).

Singing scene — The OBS scene to display while the singer is performing.

Applause scene — The OBS scene to switch to when the song ends. Use this to show a "great job" graphic or an applause animation.

Idle scene — Used when a song ends and no Applause scene is set: OBS switches to this scene instead. This could be your venue branding or a filler screen.

Lower Third

Displays the current singer's name and song title as a lower-third overlay in OBS — the text banner typically shown at the bottom of a video feed.

Enable lower third — Turns the lower third overlay on or off.

Source name — The name of the OBS text source that QUP will update. Create a text source in OBS and enter its exact name here. QUP writes the singer's name on the first line and the song title on the second.

Clear on song end — On by default. When enabled, the lower third text is cleared when the song finishes. Disable this if you want the text to remain visible during the applause scene.

Cheer overlay (1.2.0)

Add the Cheer overlay to OBS — Puts the Cheer stream overlay into the scene that is live in OBS now, as a Browser Source named "Cheer overlay", or updates the one already there. Turn on Show Cheer on the stream first (the Cheer panel, OBS overlay…). OBS draws a Browser Source only while its scene is live, so add it to each scene you stream from. The result shows in the status line. This needs OBS Recording 1.2.0 and QUP 2.37.3 or newer.

Save Settings — Saves your OBS recording configuration and applies it straight away. Settings are also saved when you close the Preferences window.

Test Connection — Attempts to connect to OBS using the current host, port, and password settings, and shows the result in the status line at the top. Use this to verify OBS is reachable before going live.

Enabling WebSocket Server in OBS Studio

Before QUP can control OBS, you need to enable the WebSocket server inside OBS. OBS version 28 and later includes WebSocket support built in — no plugins required.

  1. Open OBS Studio.
  2. Go to Tools → WebSocket Server Settings. OBS Studio Tools menu
  3. Check Enable WebSocket Server. OBS Studio WebSocket Server Settings
  4. The default port is 4455. Leave this as-is unless another application is using that port.
  5. If you want password protection, check Enable Authentication and set a password. Enter the same password in QUP's OBS Recording connection settings.
  6. Click Apply or OK.

If you are running OBS on a different computer than QUP, make sure the OBS machine's firewall allows incoming connections on the WebSocket port (default 4455). Enter that machine's IP address in QUP's Host field instead of 127.0.0.1.

If you are running OBS version 27 or earlier, you will need to install the obs-websocket plugin (version 5 or later; QUP does not speak the older 4.x protocol) separately from the obs-websocket GitHub releases page. Version 28+ does not need this.

After enabling the WebSocket server in OBS, return to QUP and click Test Connection to verify everything is working.

Updated on version 2.37.3, November 13, 2026