@sat-mtl/scenic-api

ScenicAPI

The Scenic suite is a telepresence software stack that allows for real-time transmission of audiovisual and arbitrary data over any IP network. Telepresence systems can be used in various artistic contexts, so that two different creative spaces can communicate with each other in real-time and present a combined performance.

Scenic API is a wrapper around socket.io-client in order to handle the SwitcherIO API easily.

Using the REPL

For troubleshooting sessions, a convenient REPL is provided on top of the scenic-api and can be used on top of a running switcher instance:

node bin/repl.js

Consult the REPL help here.

Debugging local changes

When local changes are made, some new features can remain unavailable in a new NodeJS environment. Building and linking the scenic-api bundle directly should help:

1. Rebuild the scenic-api bundle.

npm install
npm run build

2. Open a NodeJS environment from the local build.

// you should be in a nodeJS env by using the `node` command
const api = require('./dist/scenic-api.js')