JSPM

casparcg-connection

0.17.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2640
  • Score
    100M100P100Q172222F
  • License MIT

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

Package Exports

  • casparcg-connection

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

Build Status GitHub version npm version dependencies Status

##Introduction

CasparCG 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.

  • Node.js
  • npm package
  • TypeScript/Javascript, strongly typed
  • ES5 (easily compiled to ES6)
  • API docs
  • CasparCG AMCP 2.0 and 2.1 protocol implemented
  • Parsing and validation of command parameters and response
  • Queueing of commands
  • Promise-based commands for easy chaining and sequences
  • Helper functions for parsing of Config, Version and System info
  • MIT license

##Example

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

var connection = new CasparCG();
connection.play(1, 1, "amb");

##Documentation Join the discussion in the CasparCG Forum thread.

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

Examples and tutorials in the wiki.

##About

Created and published by SuperFly.tv

##Roadmap

  1. AMCP 2.1 parity
  2. Parsing of return data to Objects and Arrays
  3. Validating of responses against AMCP protocol
  4. OSC events parsing
  5. Smart queue with linked and grouped commands

##Acknowledgements: