CameraSource

Defined in: core/source/camera.ts:40

The CameraSource class represents the sources of the camera 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 CameraItem class. See: #core/CameraItem Core/CameraItem

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.CameraSource) {
        // Manipulate your camera device source here
        sources[i].setSilenceDetectionEnabled(true);
      }
    }
  })
})

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

Extends

Source

Implements

IAudio
ISourceCamera

Constructors

Constructor

new CameraSource(props?): CameraSource

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

Parameters

props?

Returns

CameraSource

Inherited from

Source.constructor

Properties

getAudioInput

getAudioInput: () => Promise<MicrophoneDevice>

Defined in: core/source/camera.ts:55

See: #core/ISourceCamera#getAudioInput getAudioInput

Returns

Promise<MicrophoneDevice>

Implementation of

ISourceCamera.getAudioInput

getAudioOffset

getAudioOffset: () => Promise<number>

Defined in: core/source/camera.ts:49

See: #core/ISourceCamera#getAudioOffset getAudioOffset

Returns

Promise<number>

Implementation of

ISourceCamera.getAudioOffset

getCustomName

getCustomName: () => Promise<string>

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

See: #core/ISource#getCustomName getCustomName

Returns

Promise<string>

Inherited from

Source.getCustomName

getDelay

getDelay: () => Promise<number>

Defined in: core/source/camera.ts:73

See: #core/ISourceCamera#getDelay getDelay

Returns

Promise<number>

Implementation of

ISourceCamera.getDelay

getDeviceId

getDeviceId: () => Promise<string>

Defined in: core/source/camera.ts:43

See: #core/ISourceCamera#getDeviceId getDeviceId

Returns

Promise<string>

Implementation of

ISourceCamera.getDeviceId

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

getResolution

getResolution: () => Promise<Rectangle>

Defined in: core/source/camera.ts:46

See: #core/ISourceCamera#getResolution getResolution

Returns

Promise<Rectangle>

Implementation of

ISourceCamera.getResolution

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>

Implementation of

ISourceCamera.getValue

Inherited from

Source.getValue

getVolume

getVolume: () => Promise<number>

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

See: #core/IAudio#getVolume getVolume

Returns

Promise<number>

Implementation of

IAudio.getVolume

isActive

isActive: () => Promise<boolean>

Defined in: core/source/camera.ts:70

See: #core/ISourceCamera#isActive isActive

Returns

Promise<boolean>

Implementation of

ISourceCamera.isActive

isAudioAvailable

isAudioAvailable: () => Promise<boolean>

Defined in: core/source/camera.ts:111

See: #core/IAudio#isAudioAvailable isAudioAvailable

Returns

Promise<boolean>

Implementation of

IAudio.isAudioAvailable

isAutoMute

isAutoMute: () => Promise<boolean>

Defined in: core/source/camera.ts:93

See: #core/IAudio#isAutoMute isAutoMute

Returns

Promise<boolean>

Implementation of

IAudio.isAutoMute

isForceDeinterlace

isForceDeinterlace: () => Promise<boolean>

Defined in: core/source/camera.ts:79

See: #core/ISourceCamera#isForceDeinterlace isForceDeinterlace

Returns

Promise<boolean>

Implementation of

ISourceCamera.isForceDeinterlace

isHardwareEncoder

isHardwareEncoder: () => Promise<boolean>

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

See: #core/ISourceCamera#isHardwareEncoder isHardwareEncoder

Returns

Promise<boolean>

Implementation of

ISourceCamera.isHardwareEncoder

isMute

isMute: () => Promise<boolean>

Defined in: core/source/camera.ts:90

See: #core/IAudio#isMute isMute

Returns

Promise<boolean>

Implementation of

IAudio.isMute

isStreamOnlyAudio

isStreamOnlyAudio: () => Promise<boolean>

Defined in: core/source/camera.ts:105

See: #core/IAudio#isStreamOnlyAudio isStreamOnlyAudio

Returns

Promise<boolean>

Implementation of

IAudio.isStreamOnlyAudio

isStreamPaused

isStreamPaused: () => Promise<boolean>

Defined in: core/source/camera.ts:61

See: #core/ISourceCamera#isStreamPaused isStreamPaused

Returns

Promise<boolean>

Implementation of

ISourceCamera.isStreamPaused

refresh

refresh: () => Promise<Source>

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

See: #core/ISource#refresh refresh

Returns

Promise<Source>

Inherited from

Source.refresh

setAudioInput

setAudioInput: (value) => Promise<ISourceCamera>

Defined in: core/source/camera.ts:58

See: #core/ISourceCamera#setAudioInput setAudioInput

Parameters

value

MicrophoneDevice

Returns

Promise<ISourceCamera>

Implementation of

ISourceCamera.setAudioInput

setAudioOffset

setAudioOffset: (value) => Promise<ISourceCamera>

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

See: #core/ISourceCamera#setAudioOffset setAudioOffset

Parameters

value

number

Returns

Promise<ISourceCamera>

Implementation of

ISourceCamera.setAudioOffset

setAutoMute

setAutoMute: (value) => Promise<CameraSource>

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

See: #core/IAudio#setAutoMute setAutoMute

Parameters

value

boolean

Returns

Promise<CameraSource>

Implementation of

IAudio.setAutoMute

setCustomName

setCustomName: () => Promise<Source>

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

See: #core/ISource#setCustomName setCustomName

Returns

Promise<Source>

Inherited from

Source.setCustomName

setDelay

setDelay: (value) => Promise<ISourceCamera>

Defined in: core/source/camera.ts:76

See: #core/ISourceCamera#setDelay setDelay

Parameters

value

number

Returns

Promise<ISourceCamera>

Implementation of

ISourceCamera.setDelay

setForceDeinterlace

setForceDeinterlace: (value) => Promise<ISourceCamera>

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

See: #core/ISourceCamera#setForceDeinterlace setForceDeinterlace

Parameters

value

boolean

Returns

Promise<ISourceCamera>

Implementation of

ISourceCamera.setForceDeinterlace

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

setMute

setMute: (value) => Promise<CameraSource>

Defined in: core/source/camera.ts:99

See: #core/IAudio#setMute setMute

Parameters

value

boolean

Returns

Promise<CameraSource>

Implementation of

IAudio.setMute

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

setStreamOnlyAudio

setStreamOnlyAudio: (value) => Promise<CameraSource>

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

See: #core/IAudio#setStreamOnlyAudio setStreamOnlyAudio

Parameters

value

boolean

Returns

Promise<CameraSource>

Implementation of

IAudio.setStreamOnlyAudio

setStreamPaused

setStreamPaused: (value) => Promise<ISourceCamera>

Defined in: core/source/camera.ts:64

See: #core/ISourceCamera#setStreamPaused setStreamPaused

Parameters

value

boolean

Returns

Promise<ISourceCamera>

Implementation of

ISourceCamera.setStreamPaused

setValue

setValue: (value) => Promise<Source>

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

See: #core/ISource#setValue setValue

Parameters

value

string | XML

Returns

Promise<Source>

Implementation of

ISourceCamera.setValue

Inherited from

Source.setValue

setVolume

setVolume: (value) => Promise<CameraSource>

Defined in: core/source/camera.ts:96

See: #core/IAudio#setVolume setVolume

Parameters

value

number

Returns

Promise<CameraSource>

Implementation of

IAudio.setVolume

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