Skip to content
master
Switch branches/tags
Code

Streaming Remote

Streaming Remote provides secure remote control of OBS Studio or XSplit via TCP sockets or WebSockets.

A StreamDeck plugin and basic Web UI are also provided.

Installation

Download files from the latest release; most users will not want the 'debug-' downloads.

For instructions, see INSTALL.md

Web UI

The web UI is tested on Chrome and Safari; it is known not to work on Edge.

If local storage is available, the web UI will save connection settings; local storage is not available when opening the index.html file directly in Safari, but it works in Chrome.

Connection Screen

connection screen

OBS

OBS with no active outputs OBS with active streaming and recording

XSplit

XSplit with 3 outputs, 1 active

Capabilities

  • retrieve a list of outputs and states
  • start an output (stream or recording)
  • stop an output
  • push notifications for output state changes
  • software-agnostic: there are no protocol or client differences when using OBS vs XSplit
  • modern security (authentication and encryption) via libsodium

We expect to expand the capabilities in the future.

Building Native Components From Source

Requirements

  • CMake
  • Qt5 the web UI or the XSplit plugin
  • OBS Studio - built from source - if building the OBS plugin
  • Visual Studio 2019 or recent XCode

Building

streaming-remote$ mkdir build
streaming-remote$ cd build
build$ cmake .. \
  -DWITH_XSPLIT=ON \
  -DWITH_OBS_ON \
  -DOBS_SOURCE_DIR=/path/to/obs-studio \
  -DOBS_BUILD_DIR=/path/to/obs-studio/build
build$ cmake --build . --parallel

The XSplit plugin can be built on all platforms, even though XSplit itself is only available on Windows. This is useful when working on changes that affect the StreamingSoftware class on a non-Windows machine.

Building TypeScript Components from source

Requirements

  • typescript
  • yarn (preferred) or npm

Instructions

  1. in js-client-lib, run yarn install && tsc
  2. in xsplit-js-plugin, streamdeck-plugin, and webui, run: yarn install && yarn run webpack --mode production

Protocol

There are two message-based protocols:

Message Passing

For WebSockets, the standard binary mesage functions are used.

For TCP sockets, Unix sockets (MacOS, Linux), and named pipes (Windows), an ASCII Content-Length: header is sent containing the number of bytes, then CRLF CRLF, then the blob. The next Content-Length header immediately follows the blob.

"Content-Length: 7\r\n"
"\r\n
"hello, Content-Length: 6\r\n"
"\r\n"
"world."

License

This repository is mostly licensed under the MIT license, though some parts of the OBS plugin are licensed under the GNU General Public License, version 2, as are the OBS plugin binaries.

See the [LICENSE](LICENSE file) and individual source files for details.