e:cue Programmer Connector

Basic Usage

const {actions, connection, constants} = require('ecue-programmer-connector');
const programmer = connection();

const { systemFlags } = constants;

const cyan={r:0, g: 255, b:255};

const commandList = [
      actions.proClear(),
      actions.sysSetFlag({flag: systemFlags.blind, value:true}),
      actions.proSetGroupColor({group: 'U1', color:cyan}),
      actions.cueRecord({cuelist:3,
                         name: 'Cyan Cue',
                         waitTime: 3000,
                         inFadeTime:5000}),
      actions.proClear({flag: systemFlags.blind, value:true}),
      actions.sysSetFlag({flag: systemFlags.blind, value:false}),
      actions.gotoCue({cuelist: 3, cue: -1, jump:false})
      ];

programmer.sendAction(commandList);

Querying the server

const {actions, connection} = require('ecue-programmer-connector');
const programmer = connection();

async function testGetActions(){
  const res = await programmer.sendAction(actions.get.cuelists));
  console.log(res.cuelists[2].name);
}

groups

Returns an array of group names

{
  replyTo: "a94045ec-cee4-41f3-9cc2-905967db73ae",
  groups: ["Group1", "Group2", "Group 3"],
  responseTime: 230
}

vmNames

Returns an array of versatile master names

{
  replyTo: "a94045ec-cee4-41f3-9cc2-905967db73ae",
  vmNames: ["VersatileMaster#1", "VersatileMaster#2", "VersatileMaster#3"],
  responseTime: 230
}

vmLevels

Returns an array of with the current level value of each versatile master (0-4096) Example Output:

{
  replyTo: "a94045ec-cee4-41f3-9cc2-905967db73ae",
  vmNames: ["VersatileMaster#1", "VersatileMaster#2", "VersatileMaster#3"],
  responseTime: 230
}

cuelistState

Returns an array with the current cue and submaster level value for each cuelist.

Example Output:

{ replyTo: '03289ead-a117-4c00-9cf0-ade7ac979b1a',
  cuelistState:
   [ { currentCue: 1, submasterLevel: 4096 },
     { currentCue: -1, submasterLevel: 4096 },
     { currentCue: -1, submasterLevel: 1418 },
    ],
  responseTime: 42
}

cuelists

Return an array with the structure of all cuelists & cues.

Example Response:

{ replyTo: 'c49a2b09-47ad-4a26-aa0b-7a331d863b0c',
  cuelists:
   [ { name: 'Cuelist 1',
       index: 0,
       cueCount: 2,
       properties:
        { playWhileRunning: 0,
          startOnFaderUp: 0,
          releaseOnFaderDown: 0,
          speedMaster: 0,
          fxSpeedMaster: 0,
          extraSubMaster: 0,
          releaseTime: 1000,
          autoReleaseOnEnd: 0,
          useHTP: 1,
          smooth: 0,
          priority: 3,
          trackingMode: 1,
          trackingNotInJumps: 0,
          masterInfluenceAutomatic: 1,
          masterInfluenceIntensity: 0,
          masterInfluenceFocus: 0,
          masterInfluenceColor: 0,
          masterInfluenceBeam: 0,
          mutualExcludeGroup: 0,
          protectedGroup: 0,
          chaserType: 0,
          chaserSpeed: 0,
          chaserCrossfade: 0,
          bPMTeachIn: 1,
          chaserSpeedFromAudioDsp: 0 },
       cues:
        [ { name: 'QL1 / Q1',
            inFadeTime: 2000,
            inDelayTime: 0,
            inDelayMode: 0,
            inPathType: 0,
            outFadeTime: 0,
            command: 0 },
          { name: 'QL1 / Q2',
            inFadeTime: 2000,
            inDelayTime: 0,
            inDelayMode: 0,
            inPathType: 0,
            outFadeTime: 0,
            command: 0 },
         ]
    ]
}

currentCues

Returns an array containing the zero-index cue number of the currently playing cue for each cuelist. A value of -1 means no cue is playing.

{ replyTo: 'e3a59601-0f1b-48f1-9988-cad2a594cf7e',
  currentCues: [ 2, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1 ],
  responseTime: 55 }

Redux-style actions

const { connection, reduxAction } = require('ecue-programmer-connector');
const programmer = connection();

const magenta= { r: 255, g: 0, b: 255 };

const ac = reduxAction({
  type:'proSetGroupColor',
  payload:{group: 'U4', color: magenta},
});

programmer.sendAction(ac);