JSPM

casparcg-connection

5.2.0-nightly-feat-rewrite-20221028-094226-a95a5509.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2857
  • Score
    100M100P100Q172449F
  • License MIT

Node.js Javascript/Typescript library for CasparCG connection and commands.

Package Exports

  • casparcg-connection
  • casparcg-connection/dist/enums
  • casparcg-connection/dist/enums.js
  • casparcg-connection/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (casparcg-connection) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

casparcg-connection

GitHub license npm

API Docs Guide

Introduction

CasparCG Server is an open source graphics- and video server for broadcast and streaming productions. This library lets you connect and interact with CasparCG Servers from Node.js in Javascript. This library is also a part of the Sofie TV News Studio Automation System.

Features

  • CasparCG AMCP 2.3 protocol implemented
  • Parsing of command parameters and response
  • Queueing of commands
  • Promise-based commands for easy chaining and sequences

Project

Getting started

Installing with NPM

npm install casparcg-connection --save

This installs the full project with sourcecode and dependencies, typescript project files and the compiled .js output with typings.

In your code, include and use the CasparCG object from this library with a code similar to:

const {CasparCG} = require("casparcg-connection");

var connection = new CasparCG();
connection.play({ channel: 1, layer: 1, clip: "amb"});

Note: starting with version 4.0.0 the default queue mode is now SALVO. You can optionally set the queue mode back to sequential if you need compatibility with CasparCG 2.0.7 or earlier. Note that the implementation of scheduled commands requires asynchronous behaviour and therefore only works in salvo mode.

Build from source

Installing from NPM adds the dev-dependencies needed to compile TypeScript and using Gulp as build tool. A set of commands help you managing development and testing:

  • npm run gulp Runs the build command and watches all /src files for changes, re-running the build upon each file change.
  • npm run clean Empties the /js directory.
  • npm run build Runs a single build command without watching for changes.
  • npm run cleanBuild Runs the clean command before a build command.
  • npm run lint Runs code linting. Pull Requests won't be accepted without lint compliance.
  • npm run test Runs code tests through Jest.

Documentation

Visit https://superflytv.github.io/casparcg-connection/ for API documentation.

About

Created and published by SuperFly.tv

Acknowledgements: