https://github.com/mint-dewit/hyperdeck-server-connection

Typescript Node.js library for emulating a Blackmagic Hyperdeck
https://github.com/mint-dewit/hyperdeck-server-connection

Last synced: 3 months ago
JSON representation

Typescript Node.js library for emulating a Blackmagic Hyperdeck

• Host: GitHub
• URL: https://github.com/mint-dewit/hyperdeck-server-connection
• Owner: mint-dewit
• License: mit
• Created: 2019-09-10T21:11:28.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-07-09T11:46:58.000Z (7 months ago)
• Last Synced: 2024-11-01T18:51:33.350Z (3 months ago)
• Language: TypeScript
• Size: 593 KB
• Stars: 10
• Watchers: 1
• Forks: 5
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Hyperdeck server connection

[![CircleCI](https://circleci.com/gh/baltedewit/hyperdeck-server-connection.svg?style=svg)](https://circleci.com/gh/baltedewit/hyperdeck-server-connection)

## Technology highlights

- Typescript

- Yarn

- Jest

- standard-version

- codecov

## Installation

For library developers installation steps are as following:

```sh

git clone https://github.com/baltedewit/hyperdeck-server-connection

yarn build

```

If you want to make a contribution, feel free to open a PR.

## Usage

```javascript

const { HyperdeckServer } = require('../dist/server')

const myHyperdeck = new Hyperdeck()

const s = new HyperdeckServer()

s.onPlay = async (cmd) => {

	console.log('playing', cmd)

	status.status = 'play'

	s.notifyTransport({

		...status,

		speed: '100',

		'slot id': '1',

		'clip id': '1',

		'single clip': 'true',

		'video format': '1080i50',

		loop: false

	})

}

```

### Events

## Test

This module will run tests by jest. (TBD)

```sh

$ yarn unit

```

## Acknowledgements

- Inspired by [CasparCG Hyperdeck](https://github.com/peschuster/casparcg-hyperdeck) from [peschuster](https://github.com/peschuster)

- Parser and some constants are derived from [hyperdeck-connection](https://github.com/nrkno/tv-automation-hyperdeck-connection)

- The public callback-promise API was inspired by [mos-connection](https://github.com/nrkno/tv-automation-mos-connection)