Screen

Defined in: system/screen.ts:32

The Screen Class is the object returned by #system/System System Class getAvailableScreens method. It provides you with methods to add the screen object to the current scene or any scene specified or use it’s static method to fire a selector for you to manually select a screen/screen region to capture and add on your selected scene.

Basic Usage

var XJS = require('xjs');
var System = XJS.System;

System.getAvailableScreens().then(function(screens) {
 for (var i in screens) {
   screens[i].addToScene();
 }
});

Implements

• Addable

Constructors

Constructor

new Screen(props?): Screen

Defined in: system/screen.ts:38

Parameters

props?

Returns

Screen

Methods

addToScene()

addToScene(value?): Promise<any>

Defined in: system/screen.ts:59

param: (value?: number | Scene)

return: Promise<any>

Adds the prepared screen instance to the current screen by defualt. Accpets optional parameter value, whhich when supplied, points to the scene where the 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

---

addToScene()

static addToScene(value?): Promise<any>

Defined in: system/screen.ts:98

param: (value?: number | Scene)

return: Promise<any>

Initializes the screen region selector crosshair so user may select a desktop region or a window to add to the stage in the current scene. 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>

---

parse()

static parse(screenInfo): Screen

Defined in: system/screen.ts:128

param: Object

return Screen

Converts an object into a Screen object.

Usage

var XJS = require('xjs');
var screen = XJS.Screen.parse(jsonObj);

Parameters

screenInfo

any

Returns

Screen