npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

casparcg-connection

v6.3.0

Published

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

Downloads

29,171

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
  • CasparCG AMCP 2.1 protocol largely implemented
  • Parsing of command parameters and response
  • Queueing of commands
  • Promise-based commands for easy chaining and sequences

Project

  • Node.js
  • npm package
  • TypeScript, strongly typed
  • ES2020 target
  • Linted with standard ESLint rules
  • API Docs
  • MIT license

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')

const connection = new CasparCG()
const { error, request } = await connection.play({ channel: 1, layer: 1, clip: 'amb' })
if (error) {
	console.log('Error when sending', error)
} else {
	const response = await request
	console.log(response)
}

Note: as of 6.0.0 the library has had a major rewrite with significant API changes and support for CasparCG 2.0 was dropped.

Build from source

Installing with yarn adds the dev-dependencies needed to compile TypeScript. A set of commands help you managing development and testing:

  • yarn clean Empties the /dist directory.
  • yarn build Runs a single build command without watching for changes.
  • yarn build -w Rebuilds on every change.
  • yarn lint Runs code linting. Pull Requests won't be accepted without lint compliance.
  • yarn test Runs code tests through Jest.

Doing a release

Run yarn changelog to generate the changelog, tags and commit. Push these changes and the newly made tag.

Documentation

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

About

Created and published by SuperFly.tv

Acknowledgements:

  • Many thanks to SVT for the CasparCG project
  • Inspired by https://github.com/respectTheCode/node-caspar-cg