obs-websocket

YOU HAVE STUMBLED UPON THE DEV BRANCH FOR V5.0.0

• You can find the main protocol spec here: PROTOCOL.md.
• You can find the planned requests sheet here

WebSockets API for OBS Studio.

Downloads

Binaries for Windows, MacOS, and Linux are available in the Releases section.

Homebrew

If you're using MacOS you can use Homebrew for installation as well:

brew install obs-websocket

Using obs-websocket

Here is a list of available web clients: (compatible with tablets and other touch interfaces)

• Python 3.7+ (Asyncio): simpleobsws by IRLToolkit

It is highly recommended to protect obs-websocket with a password against unauthorized control. To do this, open the "Websocket server settings" dialog under OBS' "Tools" menu. In the settings dialogs, you can enable or disable authentication and set a password for it.

(Psst. You can use --websocket_port(value), --websocket_password(value), and --websocket_debug(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, ...)

For developers

The server is a typical Websockets server running by default on port 4444 (the port number can be changed in the Settings dialog). The protocol understood by the server is documented in PROTOCOL.md.

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

• (No known apis supporting 5.0.0)

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

Securing obs-websocket (via TLS/SSL)

If you are intending to use obs-websocket outside of a LAN environment, it is highly recommended to secure the connection using a tunneling service.

See the SSL tunnelling guide for easy instructions on how to encrypt your websocket connection.

Compiling obs-websocket

See the build instructions.

Translations

Your help is welcome on translations.

Please join the localization project on Crowdin

Contributors

Code Contributors

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

Financial Contributors

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

Individuals

Organizations

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