WebSockets API for OBS Studio
Clone or download
Latest commit 94dcd58 Nov 8, 2018

README.md

obs-websocket

Remote control of OBS Studio made easy.

Follow the project on Twitter for news & updates : @obswebsocket

Gitter chat Build Status - Windows Build Status - Linux & OS X

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 :

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 !

Compiling obs-websocket

See the build instructions.

Translations

We need your help on translations. Please join the localization project on Crowdin: https://crowdin.com/project/obs-websocket

Special thanks

In order of appearance:

And also: special thanks to supporters of the project!

Supporters

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.

Support Class


MediaUnit is a Norwegian media company developing products and services for the media industry, primarly focused on web and events.

MediaUnit