obs-websocket

Websocket API for OBS Studio.

How to use

The Websocket API server runs on port 4444. A settings window is available in "Websocket server settings" under OBS' "Tools" menu.
There's currently no frontend or language API available for obs-websocket. However, the full protocol reference is available in PROTOCOL.md.

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 (like the AGDQ overlay does)
• Automate scene switching with a third-party program (e.g. : auto-pilot, foot pedal, ...)

How to build

You'll need QT 5.7 with QtWebSockets, CMake, and a working development environment for OBS Studio installed on your computer.
In CMake, you'll have to set the following variables :

• QTDIR (path) : location of the Qt environment suited for your compiler and architecture
• LIBOBS_INCLUDE_DIR (path) : location of the libobs subfolder in the source code of OBS Studio
• LIBOBS_LIB (filepath) : location of the obs.lib file
• OBS_FRONTEND_LIB (filepath) : location of the obs-frontend-api.lib file

After building the obs-websocket binary, copy its Qt dependencies (QtCore, QtNetwork and QtWebSockets library binaries) in the same folder.