Casparcg-state

This library tracks the state of CasparCG Servers and generates commands to be used in casparcg-connection.

As an example, this library is used in the Sofie TV News Studio Automation System.

Dev install instructions:

• Install yarn https://yarnpkg.com

• Install jest yarn global add jest

• Install dependencies yarn or yarn install

Then you can:

• Build: yarn build

• run test jest

• watch yarn watch

Changelog

All notable changes to this project will be documented in this file. See Convential Commits for commit guidelines.

3.0.4 (Thu Oct 23 2025)

Fixes

• loadBg inPoint not set correctly 568639d
• Foreground play command uses correct audio- and video filter parameter names. (#91) ca087ef

3.0.3 (Tue Jan 02 2024)

3.0.2 (Mon Jan 16 2023)

Fixes

• filters from background trigger command f8f66ea

3.0.1 (Fri Nov 11 2022)

3.0.0 (Fri Nov 11 2022)

Breaking changes

Features

• ! adjust for casparcg-connection rewrite 74dbe01

2.1.2 (2022-10-28)

Bug Fixes

• pass in to LoadCommand (c8da760)

2.1.1 (2022-04-19)

Bug Fixes

• dont issue a seek when going from clip with playTime, to playTime=null (#67) (6ffd80d)
• MIN_TIME_SINCE_PLAY was defined in seconds, it should be in ms (e0f5aad)

2.1.0 (2020-11-16)

Features

• ffmpeg style filter strings (57db8fa)

Bug Fixes

• add customOptions property on transitions, for pass-through of data blob (adf60ac)

2.0.0 (2020-09-29)

⚠ BREAKING CHANGES

• refactoring of CasparCGState
• drop node 8 support

Features

• drop node 8 support (afdfa2c)
• full refactor of all typings, and making it clearer what is frames and what is milliseconds (5333a12)
• refactoring of CasparCGState (92468c7)
• ci: prerelease workflow + optionally skip audit (b18e3f8)

Bug Fixes

• compare route modes (b5dc3ae)
• standardize frame - time conversions (2d5673a)
• timings (b7f3507)

1.12.0 (2020-03-11)

Features

• decklink filter parameter (4e970f4)

1.11.2 (2019-12-11)

Bug Fixes

• state mutations when nextUp routes change (#41) (7c6b605)

1.11.1 (2019-12-05)

Bug Fixes

• do not send empty LOAD command (7e66cd1)

1.11.0 (2019-11-22)

Features

• add support for FRAMES_DELAY on route (f1904af)

Bug Fixes

• change framesDelay to delay and use miliseconds instead of frames (97b69b0)
• changed routing delay triggers new command (343b170)

1.10.0 (2019-11-18)

Features

• clear_on_404 parameter for PLAY/LOAD/LOADBG (8ef80e7)

1.9.1 (2019-11-07)

1.9.0 (2019-11-07)

Features

• sting transition fade parameters (00a0713)
• update ci to run for node 8,10,12 (51b7047)

Bug Fixes

• sting transition fade parameters are in ms (a2ded80)

1.8.1 (2019-08-07)

Bug Fixes

• add support for deep object comparison (b0b2138)
• changing clip transition after load (d7fefcc)
• downgrade gh-pages due to bug in 2.1.0 (22260b1)

1.8.0 (2019-06-05)

Features

• Add context to all commands (6d7f466)

1.7.0 (2019-04-11)

Bug Fixes

• update dependencies (e133436)
• update dependencies + TS3 (72b44da)

Features

• add support for inPoint, seek, length & loop. (3173c9e)

1.6.0 (2019-02-06)

Features

• remove currentTime function and replacing it with time parameter, to allow for processing at multiple concurrent points in time. (60553e0)

1.5.1 (2018-12-16)

1.5.0 (2018-12-13)

Features

• channel_layout for ffmpeg and route producer (2b1871f)

1.4.3 (2018-12-13)

Bug Fixes

• lint error (fb05381)
• update dependencies, linting & switch from nsp to yarn audit (f07ba70)

1.4.2 (2018-11-23)

Bug Fixes

• do not reload bg on stop command (851147f)
• only do loadbg empty if another clip was preloaded (adf3e52)

1.4.1 (2018-11-19)

Bug Fixes

• broken test (9c7b60d)
• make transition obj type check more durable (e5005fd)
• transition obj building if type is uppercase sting (d3c452e)

1.4.0 (2018-11-12)

Bug Fixes

• lint error (f3efb9c)
• lint error & updated yarn.lock file (976a1f1)

Features

• added support & tests for clearing the nextUp / loadbg (3e0ea2c)
• order commands for execution time (e99722a)

1.3.3 (2018-09-22)

Bug Fixes

• a route should not reload when it was preloaded (6afa888)
• loadbg with loop + seek (0c3daf0)

1.3.2 (2018-09-11)

1.3.1 (2018-08-31)

Bug Fixes

• empty bg layer before loadbg'ing (40654bc)

1.3.0 (2018-08-31)

Bug Fixes

• decklink play command should not get null parameters (7671a83)
• minTimeSincePlay is a public property and defaults to 150ms (6c4be29)

Features

• loadbg routes (401f3b0)

1.2.0 (2018-08-16)

Bug Fixes

• default minTimeSIncePlay in ms (acbda87)
• looping does not interfere with play / pause (3141581)

Features

• native route command (86f6298)

1.1.5 (2018-08-10)

Bug Fixes

• maintain background layer when a clip is played on foreground (c1ccb9f)

1.1.4 (2018-08-07)

Bug Fixes

• behaviour for empty foreground layers (facf466)

1.1.3 (2018-08-03)

Bug Fixes

• don't resend transitions that were set on the background layer (4afe3d9)
• refactored handling of commands (9398c51)

1.1.2 (2018-08-02)

Bug Fixes

• empty layers get stop command, not clear command (08ad7ce)

1.1.1 (2018-08-02)

1.1.0 (2018-08-02)

Bug Fixes

• logic around playing after loadbg (2f219ac)
• use resume command when possible (82907cc)

Features

• background/next routes (ee241bd)
• sting transition (f5b8a47)
• support preloading (903315d)

1.0.5 (2018-06-15)

1.0.4 (2018-06-14)

1.0.3 (2018-06-14)

Bug Fixes

• added yarn publish --verbose to see why publish fails (8a50fee)

1.0.2 (2018-06-14)

1.0.1 (2018-06-10)

1.0.0 (2018-06-09)

Feat

• implemented tests for all mixerCommands (b3108c4)

BREAKING CHANGES

• changed API to better reflekt casparcg-connection: mixer.blend => mixer.blendmode

0.1.1 (2018-06-08)

Bug Fixes

• remove private: true (19b1469)

0.1.0 (2018-06-08)

Bug Fixes

• add circleCI badge (26cdbef)
• important standard-version update (b501c87)
• resolve ts-related issues (27cdf56)
• set correct ssh fingerprint (58c12f9)
• update packages and format tslint.json (a2ecbb5)
• update scripts, script-info, devDeps, and contributors (4942fbd)

Features

• add license (afd8b6b)
• add missing files (32007be)
• added more tests and some minor fixes (de8f3f7)
• added multiple tests and some minor fixes, typing & linting (b84c433)
• added support for transition for Routes (658ad0a)
• added support for transitions for decklnik-input (fa1a6c1)
• Major refactoring (14d27f4)