Replay

Defined in: system/replay.ts:47

The Class for combining several Items into a group. This can be initialized with an optional object parameter, which may contain the following:

• buffer - the replay time, which ranges from 1-120 seconds. Default is 10.
• channelName - the name of the channel where the replay will come from. Default is auto.
• hotkey - the numerical equivalent of the keyboard combination to trigger the replay. Default is 0. - This allots for the modifiers shift(65536), ctrl(131072), and alt(262144) keys - Sample computation for Ctrl + Shift + K = (keycode.which | 131072) | 65536 = 75 | 131072 | 65536 = 196683

Basic Usage

var XJS = require('xjs');
var Replay = XJS.Replay;
xjs.Output.getOutputList()
.then(function(outputs) {
  return outputs[0].getName();
}).then(function(name) {
  var newReplay = new Replay({
    buffer: 20,
    channelName: name
  });
  newReplay.addToScene();
})

Implements

• Addable

Constructors

Constructor

new Replay(replayOptions?): Replay

Defined in: system/replay.ts:53

Parameters

replayOptions?

Object

Returns

Replay

Methods

addToScene()

addToScene(value?): Promise<any>

Defined in: system/replay.ts:106

param: (value?: number | Scene)

return: Promise<any>

Adds this replay object to the current scene by default. Accepts an optional parameter value, which, when supplied, points to the scene where item will be added instead. If ready config {listenToItemAdd: true} it returns item id, else returns boolean.

Note: There is yet no way to detect error responses for this action.

Parameters

value?

number | Scene

Returns

Promise<any>

Implementation of

Addable.addToScene

---

toXML()

toXML(): XML

Defined in: system/replay.ts:60

Returns

XML