Skip to content

obsproject/obs-websocket

Folders and files

NameName
Last commit message
Last commit date

Latest commit

896bacf · Jan 16, 2024
Aug 16, 2023
May 14, 2022
Dec 22, 2023
Dec 5, 2023
Jan 16, 2024
Jul 28, 2022
Jan 16, 2024
Jun 8, 2022
Mar 26, 2023
May 14, 2022
Apr 4, 2023
Jul 15, 2023
Feb 19, 2022
Dec 17, 2021
Dec 22, 2023
Mar 8, 2021
May 28, 2023

Repository files navigation

obs-websocket

WebSocket API for OBS Studio.

Discord Financial Contributors on Open Collective

Downloads

obs-websocket is now included by default with OBS Studio 28.0.0 and above. As such, there should be no need to download obs-websocket if you have OBS Studio > 28.0.0.

Binaries for OBS Studio < 28.0.0 on Windows, MacOS, and Linux are available in the Releases section.

Using obs-websocket

It is highly recommended to keep obs-websocket protected with a password against unauthorized control. obs-websocket generates a password for you automatically when you load it for the first time. To change this, open the "obs-websocket Settings" dialog under OBS' "Tools" menu. In the settings dialog, you can enable or disable authentication and set a password for it.

(Psst. You can use --websocket_port(value), --websocket_password(value), --websocket_debug(flag) and --websocket_ipv4_only(flag) on the command line to override the configured values.)

Possible use cases

  • Remote control OBS from a phone or tablet on the same local network
  • Change your stream overlay/graphics based on the current scene
  • Automate scene switching with a third-party program (e.g. : auto-pilot, foot pedal, ...)

Client software

Client libraries (for developers)

Here's a list of available language APIs for obs-websocket:

The 5.x server is a typical WebSocket server running by default on port 4455 (the port number can be changed in the Settings dialog under Tools). The protocol we use is documented in PROTOCOL.md.

We'd like to know what you're building with obs-websocket! If you do something in this fashion, feel free to drop a message in #project-showoff in the discord server!

Contributors

Code Contributors

This project exists thanks to all the people who contribute. Contribute Code.

Financial Contributors

Become a financial contributor and help us sustain our community. Contribute Financially

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. Contribute