/streamlabs-obs-api-docs

API documentation + web-client example

Primary LanguageHTML

Streamlabs-OBS API documentation

Streamlabs-OBS Has API for interacting with the application. You can use this API to speed up some UI actions or for writing drivers for any kind of remote controllers.

GOTO DOCUMENTATION PAGES

This repo also includes a simple web-interface for Streamlabs-OBS that you can use as an example to start to work with API. This web-interface demonstrates some basic features like shitching between scenes, show/hide, mute/unmute sources.

Launch web-interface

Screenshoot1

How to connect web-application to Streamlabs-OBS

  • run Streamlabs-OBS with --adv-settings parameter
  • enable websokets in settings->API
  • Launch web-interface
  • click connect button on the top of the page

The web-interface also includes a simple console for testing direct API requests Screenshoot1

How to run web-application on the local machine

  • clone the repo
  • install the web-interface application via npm install
  • run npm start to start simple HTTP server
  • open one of the suggested URLs in a browser