Skip to content

stream-labs/streamlabs-desktop-api-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Streamlabs Desktop API documentation

Streamlabs Desktop Has a local 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 Desktop that you can use as an example to start working with the API. This web-interface demonstrates some basic features like switching between scenes, show/hide, mute/unmute sources.

Launch web-interface

Screenshoot1

How to connect the web-application to Streamlabs Desktop

  • Remote connections are disabled by default. To enable it go to Settings->Remote Control and click on the QR-Code and than on show details
  • copy the token
  • Launch web-interface
  • inset your token in the token field on the top of the page
  • click the connect button

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

How to run this app 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