obs-websocket
Remote control of OBS Studio made easy.
Follow the project on Twitter for news & updates : @obswebsocket
Downloads
Binaries for Windows and Linux are available in the Releases section.
Using obs-websocket
A web client and frontend made by t2t2 (compatible with tablets and other touch interfaces) is available here : http://t2t2.github.io/obs-tablet-remote/
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.
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, ...)
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 :
- Javascript (browser & nodejs) : obs-websocket-js by haganbmj
- C#/VB.NET : obs-websocket-dotnet
I'd like to know what you're building with or for obs-websocket. If you do something in this fashion, feel free to drop me an email at contact at slepin dot fr !
Special thanks
- Brendan H. : Code contributions and better English in the Protocol specification
- Mikhail Swift : Code contributions
- Tobias Frahmer : German translation
- G-monitor : Simplified Chinese and Traditional Chinese translations
- Larissa Gabilan : Portuguese translation
Compiling obs-websocket
See the build instructions.