OBS

OBS WebSocket: What It Is and How to Turn It On

Nemo · · 6 min read

OBS WebSocket is a remote control server built into OBS Studio 28 and newer. It lets other apps start and stop recordings, switch scenes and read OBS’s status. Turn it on in Tools > WebSocket Server Settings with Enable WebSocket server. The default port is 4455, and Show Connect Info shows the password.

It is off until you enable it, and nothing can use it without the port and, with authentication on, the password.

What is the OBS WebSocket server?

It is a small server inside OBS that listens for commands from other programs. A stream deck app, a phone remote, a bot or a script connects to it and asks OBS to do something (switch to this scene, start the recording, save the replay) or asks what OBS is doing right now.

It started as a plugin called obs-websocket that you had to install. Since OBS Studio 28 it ships with OBS on Windows, macOS and Linux, so there is nothing to download. The built-in version speaks the 5.x protocol and uses port 4455 by default. The old 4.x plugin used port 4444 and a different protocol, which is why very old tools and tutorials don’t match what you see today.

How do you turn on the WebSocket server in OBS?

  1. Open OBS Studio 28 or newer.
  2. Open Tools > WebSocket Server Settings.
  3. Tick Enable WebSocket server.
  4. Leave Server Port on 4455 unless another program already uses it.
  5. Keep Enable Authentication ticked.
  6. Click Show Connect Info to see the server address, the port and the password.
  7. Click Apply, then OK.

Type the port and the password into the app you want to connect. OBS remembers these settings, so you do this once.

What do the WebSocket settings mean?

Setting What it does What to choose
Enable WebSocket server Turns the server on or off On only if an app you use needs it
Server Port The port apps connect to 4455, the default
Enable Authentication Requires a password to connect On
Server Password The password apps must send The generated one, or your own long one
Show Connect Info Shows the address, port and password, with a QR code for phone remotes Open it when you set up an app

OBS generates a password the first time the server loads. You can replace it with your own or generate a new one in the same window. After a password change, every connected app needs the new one.

What do apps use OBS WebSocket for?

Anything you could do by clicking in OBS, done from somewhere else. The OBS project’s own remote control guide lists clients such as Touch Portal, Macro Deck, Streamer.bot, Bitfocus Companion and OBS Blade. Typical uses:

  • Control surfaces: a button on a deck or a phone switches scenes or starts the recording.
  • Automation: a bot changes the scene when a stream event happens.
  • Status: an app shows whether OBS is recording and for how long.
  • Recording helpers: an app starts and stops the recording and learns where the file was saved.

The server gives a connected app wide control over OBS: outputs, scenes, sources and settings. That is what makes it useful, and it is the reason to treat the password with care.

Is OBS WebSocket safe?

Used on your own computer with authentication on, yes. The risks come from switching the password off or exposing the port.

  • Keep authentication on. Without a password, any program or device that can reach the port can control OBS.
  • Keep the password private. The Connect Info window shows it in plain text and as a QR code. Don’t leave it open on a screen you are streaming or recording.
  • Keep it local. Don’t forward port 4455 on your router or open it to the internet. Apps on the same computer, or on your own home network, are the intended use.
  • Connect only apps you trust. An app with the password can stop your recording or change your scenes.
  • Turn it off when nothing uses it. Untick Enable WebSocket server and the port closes.

If you ever showed the password by accident, generate a new one and re-enter it in your apps.

How does GameClip use the OBS WebSocket server?

GameClip is a desktop app for macOS and Windows that turns a gameplay recording into clips: one highlights video and vertical cuts for Shorts, Reels and TikTok. It is one example of a recording helper. Since version 0.3.0 it connects to OBS Studio’s WebSocket server so that OBS records and GameClip drives the recording and receives the file.

  1. Enable the server in OBS as described above.
  2. In GameClip, open the Recorder tab and pick OBS Studio under Record with.
  3. Type the port and the password and press Connect. The panel shows “Connected to OBS Studio” with the OBS version.

After that it reconnects by itself whenever both apps are open. F9 starts OBS’s recording, F10 pauses and resumes it, F11 stops it, and F8 and F7 mark the last 30 seconds and the last 2 minutes. When the recording stops, OBS’s file opens as a session with each mark already a clip on the timeline.

The limits: OBS and GameClip must be on the same computer, OBS must be version 28 or newer, and GameClip does not change OBS settings, scenes or sources and does not stream. The full steps are in the guide to connecting OBS Studio, and connection errors are covered in OBS troubleshooting. You can download GameClip here.

For the OBS side of the same workflow, see how to clip with OBS and the OBS Replay Buffer guide; the recording itself is covered in OBS settings for recording gameplay.

FAQ

What port does OBS WebSocket use?

Port 4455 by default in OBS Studio 28 and newer. You can change it under Server Port in Tools > WebSocket Server Settings. The old 4.x plugin used port 4444.

Where is the OBS WebSocket password?

Open Tools > WebSocket Server Settings and click Show Connect Info. The window shows the server address, the port and the password. You can also set your own password in the settings window.

Do I need to install the obs-websocket plugin?

Not on OBS Studio 28 or newer: the server is part of OBS. Only older OBS versions need the separate plugin, and current apps expect the built-in 5.x version.

Why can’t my app connect to OBS WebSocket?

Check that Enable WebSocket server is ticked, that the port in the app matches Server Port, and that the password is the current one from Show Connect Info. OBS must be running, and a firewall can block connections from another device.

Does the WebSocket server slow OBS down?

Not in a way you would notice. It only answers requests from connected apps and sends them status events. Encoding the video is what uses your GPU and CPU.

Can I use OBS WebSocket from another computer or a phone?

Yes, on your own network: use the address from Show Connect Info and keep authentication on. Some apps, GameClip included, only work with OBS on the same computer.

Contact

Licence keys, billing, bugs and ideas. We reply by email.