Executing a yarn
command should perform all necessary steps to develop the module, if it does not then follow the steps below.
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.
Each model of ATEM has a definition file in src/models describing the functionality of the device. This allows us to know this information for offline programming. If the module is left on auto-detect, we match the definition to use based on the model the atem reports, and if one is not defined we can build the definition on the fly from the ATEM. This generally gives us good results, but there are a few things we don't know how to detect from the atem.
To add a new model to the list:
- Create a new file in
src/models/
for the new model, based on one of the others (mini.ts is a nice and simple one) - Run
yarn ts-node-esm dump-model.ts 10.42.6.125
(substitute in the atem ip) - Copy the contents of state.json to the file you created, replacing the existing spec
- In the new file, replace any magic numbers with their enums (this aids readability, but is not essential)
- Add the new spec to the
ALL_MODELS
array insrc/models/index.ts
- Recompile the code and test it out!
- Fix device discovery for recent models/firmwares
-
Support USB Webcam on Mini/SDI range
-
Mediaplayer source from variables
-
Easing curves for fades
-
Supersource art sources from variables
-
Fix missing labels for mini multiview status sources
-
Fix fairlight source solo
-
Add camera continuous zoom action
-
Support for Constellation 1ME 4K and 2ME 4K
- Improve increment camera iris and exposure
- Add PREV TRANS support
- Add fairlight solo support
- Improve fairlight headphone support
- Add incrementing camera control
- Add timecode as a variable
- Actions to set the ATEM timecode
- Fix bug in model selection
- Fix ISO record feedback not updating
- Add support for fairlight audio delay (this may not be correctly defined for all models)
- Expose record filename as a variable, and support variables in action
- Add action to delete a still
- Add action to set media player source from a variable
- Support switching upstream keyer type
- Build tooling update
- Build tooling update
- Build tooling update
- Enable/disable ISO recording
- Multiviewer layout control
- Basic camera control
- Stream cache variable
- Fix auto-detect not reporting state correctly
- Add variables for fairlight audio master/monitor
- Add definitions for TVS 4K8
- Use Companion builtin ATEM discovery
- Track last connected model, to provide a better experience when offline
- New action to arbitrarily alter the presence of every component in the next selection
- Attempt to make discovery a bit more reliable
- Add definitions for Constellation 4K 4ME
- Support variables in 'Stream: Set service' #256
- New tally feedback, to provide tally for ME2 #188
- Fix potential feedback reactivity issue
- Add multiviewer window source variables #245
- Add CUT preset #224
- Adjust master pan in classic audio mixer #180
- Set T-bar position #241
- Use builtin invert support for all feedbacks
- Update atem library, to get more responsive multiviewer feedbacks
- Fix TVS HD8 ISO being based off wrong model
- Fix connection stuck in a crash loop unable to open configuration
- Fix SSrcBoxSourceVariables feedback
- Add Television Studio HD8 models
- Fix build errors
- Some feedbacks off by one on me index
-
Add capture still action
-
Add display-clock actions
-
Add feedbacks which support variables
-
Add more actions which support variables
- Updates for Companion 3.0
- fix audo feedbacks
-
add macro looping action/feedback
-
fix reset peaks actions
-
expose device ip as variable
-
add variables with input ids
-
add invert checkbox to some feedbacks
-
add actions to set inputs from variables
- fix 'Fairlight Audio: Audio fader gain' feedback missing
- fix unable to set multiviewer label to blank
-
fix performance issues with fairlight input updates
-
hide multiview label when name set to nothing
-
add sdi model range (untested)
-
add dsk rate
-
add dsk premultiplied key
-
add usk mask
-
add usk dve properties
-
more granular supersource actions and feedbacks
-
support learning values for actions and feedbacks
- fix constellation hd high cpu usage
-
add constellation hd models (untested)
-
correct order of input fields for some actions and feedbacks
-
fix macros to use name not description
-
flying key control
-
atem mini extreme headphone basic controls
-
audo mixer master gain control
- set input names (both text and multiviewer)
-
duration variables have a ms variant
-
save and clear startup state actions
-
variables for supersource box inputs
- rewrite upgrade scripts to new api
-
fix supersource art feedbacks
-
supersource art action has more flexible placement control
-
discover and suggest atems in the instance config panel
-
reset audio peaks
-
atem mini recording filename accepts variables
-
supersource art source
- feedbacks updated to new format. allows more customisation of style
- fix utf8 characters in variables
- fix build issues
- fix in electron (in new module workflow)
- Add mini-extreme and mini-extreme-iso
- fix offline programming
- fix on windows
-
fix companion exiting on uncaughtException
-
fix 1me models having supersource commands
-
fix tvs4kpro erroring when generating actions list
-
Relative fader levels adjustments
-
Fader level fades
-
Expose missing audio faders (madi & trs)
-
fix aux variables not updating
-
fix autodetect model being a bit broken
-
fix supersource2 not being a valid source
-
mini-pro streaming and recording
-
Classic audio input actions and feedback
-
Fairlight audio input actions and feedback
-
Improved connection library
-
Add mini-pro-iso
-
Feedback for running transition
-
Add action to go to next/previous still in media player
-
Add action to do relative changes to supersource boxes
-
Fix downstream key input action
-
Add presets for transition selection component
-
Add dsk tie
-
Send multiview to aux on mini-pro
-
Add individual transition selection component control
- Add mini-pro
- Revert connection library change
- More stable connection library
- Variables for media pool
- Variables for media players
- Add definitions for Mini
- Add tally feedback
- Set fade to black rate
- Execute fade to/from black
- Variables for current aux source
- Add definitions for TVS Pro models
- 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