ScreenSource

Defined in: core/source/screen.ts:38

The ScreenSource class represents the sources of the screen device items that has been added to the stage. A single source could have multiple items linked into it and any changes to the source would affect all items linked to it.

Each item is represented by the ScreenItem class. See: #core/ScreenItem Core/ScreenItem

Inherits from: #core/Source Core/Source

Basic Usage

var xjs = require('xjs');

xjs.Scene.getActiveScene().then(function(scene) {
  scene.getSources().then(function(sources) {
  for (var i in sources) {
      if (sources[i] instanceof XJS.ScreenSource) {
        // Manipulate your screen source here
        sources[i].setSilenceDetectionEnabled(true);
      }
    }
  })
})

All methods marked as Chainable resolve with the original ScreenSource instance.

Extends

Source

Implements

ISourceScreen

Constructors

Constructor

new ScreenSource(props?): ScreenSource

Defined in: core/source/source.ts:75

Parameters

props?

Returns

ScreenSource

Inherited from

Source.constructor

Properties

getCaptureArea

getCaptureArea: () => Promise<Rectangle>

Defined in: core/source/screen.ts:92

See: #core/ISourceScreen#getCaptureArea getCaptureArea

Returns

Promise<Rectangle>

Implementation of

ISourceScreen.getCaptureArea

getCaptureLayered

getCaptureLayered: () => Promise<boolean>

Defined in: core/source/screen.ts:52

See: #core/ISourceScreen#getCaptureLayered getCaptureLayered

Returns

Promise<boolean>

Implementation of

ISourceScreen.getCaptureLayered

getCustomName

getCustomName: () => Promise<string>

Defined in: core/source/source.ts:291

See: #core/ISource#getCustomName getCustomName

Returns

Promise<string>

Inherited from

Source.getCustomName

getId

getId: () => Promise<string>

Defined in: core/source/source.ts:316

See: #core/ISource#getId getId

Returns

Promise<string>

Inherited from

Source.getId

getItemList

getItemList: () => Promise<Item[]>

Defined in: core/source/source.ts:321

See: #core/ISource#getItemList getItemList

Returns

Promise<Item[]>

Inherited from

Source.getItemList

getKeepLoaded

getKeepLoaded: () => Promise<boolean>

Defined in: core/source/source.ts:306

See: #core/ISource#getKeepLoaded getKeepLoaded

Returns

Promise<boolean>

Inherited from

Source.getKeepLoaded

getName

getName: () => Promise<string>

Defined in: core/source/source.ts:281

See: #core/ISource#getName getName

Returns

Promise<string>

Inherited from

Source.getName

getOptimizedCapture

getOptimizedCapture: () => Promise<boolean>

Defined in: core/source/screen.ts:62

See: #core/ISourceScreen#getOptimizedCapture getOptimizedCapture

Returns

Promise<boolean>

Implementation of

ISourceScreen.getOptimizedCapture

getShowMouse

getShowMouse: () => Promise<boolean>

Defined in: core/source/screen.ts:82

See: #core/ISourceScreen#getShowMouse getShowMouse

Returns

Promise<boolean>

Implementation of

ISourceScreen.getShowMouse

getShowMouseClicks

getShowMouseClicks: () => Promise<boolean>

Defined in: core/source/screen.ts:72

See: #core/ISourceScreen#getShowMouseClicks getShowMouseClicks

Returns

Promise<boolean>

Implementation of

ISourceScreen.getShowMouseClicks

getType

getType: () => Promise<ItemTypes>

Defined in: core/source/source.ts:331

See: #core/ISource#getType getType

Returns

Promise<ItemTypes>

Inherited from

Source.getType

getValue

getValue: () => Promise<string | XML>

Defined in: core/source/source.ts:296

See: #core/ISource#getValue getValue

Returns

Promise<string | XML>

Inherited from

Source.getValue

isClientArea

isClientArea: () => Promise<boolean>

Defined in: core/source/screen.ts:102

See: #core/ISourceScreen#isClientArea isClientArea

Returns

Promise<boolean>

Implementation of

ISourceScreen.isClientArea

isStickToTitle

isStickToTitle: () => Promise<boolean>

Defined in: core/source/screen.ts:42

See: #core/ISourceScreen#isStickToTitle isStickToTitle

Returns

Promise<boolean>

Implementation of

ISourceScreen.isStickToTitle

refresh

refresh: () => Promise<Source>

Defined in: core/source/source.ts:326

See: #core/ISource#refresh refresh

Returns

Promise<Source>

Inherited from

Source.refresh

setCaptureArea

setCaptureArea: (dimension) => Promise<ScreenSource>

Defined in: core/source/screen.ts:97

See: #core/ISourceScreen#setCaptureArea setCaptureArea

Parameters

dimension

Rectangle

Returns

Promise<ScreenSource>

Implementation of

ISourceScreen.setCaptureArea

setCaptureLayered

setCaptureLayered: (value) => Promise<ScreenSource>

Defined in: core/source/screen.ts:57

See: #core/ISourceScreen#setCaptureLayered setCaptureLayered

Parameters

value

boolean

Returns

Promise<ScreenSource>

Implementation of

ISourceScreen.setCaptureLayered

setClientArea

setClientArea: (value) => Promise<ScreenSource>

Defined in: core/source/screen.ts:107

See: #core/ISourceScreen#setClientArea setClientArea

Parameters

value

boolean

Returns

Promise<ScreenSource>

Implementation of

ISourceScreen.setClientArea

setCustomName

setCustomName: () => Promise<Source>

Defined in: core/source/source.ts:286

See: #core/ISource#setCustomName setCustomName

Returns

Promise<Source>

Inherited from

Source.setCustomName

setKeepLoaded

setKeepLoaded: (value) => Promise<Source>

Defined in: core/source/source.ts:311

See: #core/ISource#setKeepLoaded setKeepLoaded

Parameters

value

boolean

Returns

Promise<Source>

Inherited from

Source.setKeepLoaded

setName

setName: (value) => Promise<Source>

Defined in: core/source/source.ts:276

See: #core/ISource#setName setName

Parameters

value

string

Returns

Promise<Source>

Inherited from

Source.setName

setOptimizedCapture

setOptimizedCapture: (value) => Promise<ScreenSource>

Defined in: core/source/screen.ts:67

See: #core/ISourceScreen#setOptimizedCapture setOptimizedCapture

Parameters

value

boolean

Returns

Promise<ScreenSource>

Implementation of

ISourceScreen.setOptimizedCapture

setShowMouse

setShowMouse: (value) => Promise<ScreenSource>

Defined in: core/source/screen.ts:87

See: #core/ISourceScreen#setShowMouse setShowMouse

Parameters

value

boolean

Returns

Promise<ScreenSource>

Implementation of

ISourceScreen.setShowMouse

setShowMouseClicks

setShowMouseClicks: (value) => Promise<ScreenSource>

Defined in: core/source/screen.ts:77

See: #core/ISourceScreen#setShowMouseClicks setShowMouseClicks

Parameters

value

boolean

Returns

Promise<ScreenSource>

Implementation of

ISourceScreen.setShowMouseClicks

setStickToTitle

setStickToTitle: (value) => Promise<ScreenSource>

Defined in: core/source/screen.ts:47

See: #core/ISourceScreen#setStickToTitle setStickToTitle

Parameters

value

boolean

Returns

Promise<ScreenSource>

Implementation of

ISourceScreen.setStickToTitle

setValue

setValue: (value) => Promise<Source>

Defined in: core/source/source.ts:301

See: #core/ISource#setValue setValue

Parameters

value

string | XML

Returns

Promise<Source>

Inherited from

Source.setValue

Methods

getAllSources()

static getAllSources(): Promise<Source[]>

Defined in: core/source/source.ts:220

return: Promise<Source[]>

Get all unique Source from every scene. Total number of Sources returned may be less than total number of items on all the scenes due to Linked items only having a single Source.

Usage

xjs.Source.getAllSources().then(function(sources) {
  for(var i = 0 ; i < sources.length ; i++) {
     if(sources[i] instanceof xjs.HtmlSource) {
       // Manipulate HTML Source here
     }
   }
})

Returns

Promise<Source[]>

Inherited from

Source.getAllSources

getCurrentSource()

static getCurrentSource(): Promise<Source>

Defined in: core/source/source.ts:108

return: Promise

Get the current source (when function is called by sources), or the source that was right-clicked to open the source properties window (when function is called from the source properties window)

Usage

xjs.Source.getCurrentSource().then(function(source) {
  // This will fetch the current source (the plugin)
}).catch(function(err) {
  // Handle the error here. Errors would only occur
  // if we try to execute this method on Extension plugins
});

Returns

Promise<Source>

Inherited from

Source.getCurrentSource

getItemList()

static getItemList(): Promise<Item[]>

Defined in: core/source/source.ts:167

return: Promise<Item[]>

Get the item List of the current Source. The item list is a list of items linked to a single Source.

Usage

xjs.Source.getItemList()
.then(function(items) {
  // This will fetch the item list of the current Source
  for (var i = 0 ; i < items.length ; i++) {
    // Manipulate each item here
  }
});

This is just the shorter way of getting items that are linked to a single source. See the long version below:

xjs.Source.getCurrentSource()
.then(source.getItemList)
.then(function(items) {
// Manipulate the items here
})

Returns

Promise<Item[]>

Inherited from

Source.getItemList