Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.


Getting started

Executing a yarn command should perform all necessary steps to develop the module, if it does not then follow the steps below.

This project is written in typescript. As companion core does not currently provide typescript definitions, we need to 'inject' them to satisfy the requirements set out by the compiler. This can be done manually with yarn fix-types. These types will need updating if the interfaces in companion change, or when adding anything that was previously missed. Hopefully these can soon be merged upstream, and looked after as part of the core project.

The module can be built once with yarn build. This should be enough to get the module to be loadable by companion.

While developing the module, by using yarn build:watch the compiler will be run in watch mode to recompile the files on change.



  • Change transition selection
  • Set SuperSource box On Air
  • Change SuperSource geometry properties
  • Change media player source


  • Update atem-connection to support v8 firmware.
  • Add support for ATEM Constellation.
  • Rewrite in Typescript with some linting and formatting rules.
  • Fix changing supersource box resetting other properties
  • Fix keyer toggles sometimes getting stuck
  • Add support for setting transition type and rate


  • Module in ES6 format (no self and use of =>)
  • this.states[] use abstracted to getXX(...) and updateXX(...) calls
  • Model parameters moved to 'CONFIG_MODEL' array
You can’t perform that action at this time.