Remote control of OBS Studio made easy.
Follow the project on Twitter for news & updates : @obswebsocket
Binaries for Windows and Linux are available in the Releases section.
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, ...)
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 :
- C#/VB.NET: obs-websocket-dotnet
- Python 2 and 3: obs-websocket-py by Guillaume Genty a.k.a Elektordi
- Python 3.5+ with asyncio: obs-ws-rc by Kirill Mysnik
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 !
See the build instructions.
We need your help on translations. Please join the localization project on Crowdin: https://crowdin.com/project/obs-websocket
In order of appearance:
- Brendan H. : Code contributions and gooder English in the Protocol specification
- Mikhail Swift : Code contributions
- Tobias Frahmer : German localization
- Genture : Simplified Chinese and Traditional Chinese localizations
- Larissa Gabilan : Portuguese localization
- Andy Asquelt : Polish localization
- Marcel Haazen : Dutch localization
- Peter Antonvich : Code contributions
- yinzara : Code contributions
- Chris Angelico : Code contributions
- Guillaume "Elektordi" Genty : Code contributions
- Marwin M : Code contributions
- Logan S. : Code contributions
- RainbowEK : Code contributions
- RytoEX : CI script and code contributions
- Theodore Stoddard : Code contributions
- Philip Loche : Code contributions
And also: special thanks to supporters of the project!
They have contributed financially to the project and made possible the addition of several features into obs-websocket. Many thanks to them!
Support Class designs and develops professional livestreams, with services ranging from broadcast graphics design and integration to event organization, along many other skills.
MediaUnit is a Norwegian media company developing products and services for the media industry, primarly focused on web and events.