https://github.com/dev1an/atem

Implementation of BlackMagicDesign's ATEM v6.8 communication protocol in javascript (written for nodejs).
https://github.com/dev1an/atem

atem blackmagicdesign-atem bmd javascript nodejs

Last synced: about 1 month ago
JSON representation

Implementation of BlackMagicDesign's ATEM v6.8 communication protocol in javascript (written for nodejs).

• Host: GitHub
• URL: https://github.com/dev1an/atem
• Owner: Dev1an
• License: mit
• Created: 2015-03-19T16:08:32.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2018-05-27T19:16:19.000Z (over 6 years ago)
• Last Synced: 2024-11-08T14:57:57.391Z (about 2 months ago)
• Topics: atem, blackmagicdesign-atem, bmd, javascript, nodejs
• Language: JavaScript
• Homepage:
• Size: 56.6 KB
• Stars: 67
• Watchers: 8
• Forks: 8
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Atem

Implementation of BlackMagicDesign's ATEM communication protocol (version 6.8) in javascript (written for nodejs).

[![Join the chat at https://gitter.im/Dev1an/Atem](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Dev1an/Atem?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

![Licensed under MIT](https://img.shields.io/badge/License-MIT-blue.svg)

### ⚠️ Recent development 🚨

This library is more than 3 years old and although I am still maintaining it, I started a new version of the implementation written from the ground up in Swift. It is developed under [Swift-Atem](https://github.com/Dev1an/Swift-Atem) and implements the protocol in a more flexible manner. The same code can be used to implement both directions of the protocol. This means that you can not only use it to control atem switchers but also to connect to your control panels without the need for a switcher. Opening a whole new world of applications for the Atem control panels.

## Usage

### Connect to an atem

To connect to an atem, simply create a new `Atem` instance and pass an IP address as first parameter of the constructor:

```js

var Atem = require('atem') // Load the atem module

var myAtemDevice = new Atem("10.1.0.9") // Create a new Atem instace with an IP address

```

You can also create a new `Atem` instance and specify the IP address later on. Notice that if you do this, you need to call the `connect` method yourself:

```js

var Atem = require('atem') // Load the atem module

var myAtemDevice = new Atem() // Create a new Atem instace without an IP address

myAtemDevice.ip = "10.1.0.9" // specify the ip address

myAtemDevice.connect() // manually connect to the atem

```

### Receive notifications from your atem

To receive notifications about the connection state:

```js

var Atem = require('atem') // Load the atem module

var myAtemDevice = new Atem() // Create a new Atem instace without an IP address

myAtemDevice.on('connectionStateChange', function(state) {

  console.log('state', state);

});

```

These events are currently implemented: 

- previewBus

- programBus

- inputTally

- sourceTally

- sourceConfiguration

- auxiliaryOutput

- connectionStateChange

- connectionLost

If you need other events, create an issue. You can also fall back to the `rawCommand` event and interpret the raw data coming from the atem yourself.

You can read more about all the available events in the [API reference](http://dev1an.github.io/Atem/Device.html)