ReplaySource

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

The ReplaySource class represents the sources of the replay 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 ReplayItem class. See: #core/ReplayItem Core/ReplayItem

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

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

Extends

• Source

Implements

• IAudio
• ISourceReplay

Constructors

Constructor

new ReplaySource(props?): ReplaySource

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

Parameters

props?

Returns

ReplaySource

Inherited from

Source.constructor

Properties

getChannel

getChannel: () => Promise<string>

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

See: #core/ISourceReplay#getChannel getChannel

Returns

Promise<string>

Implementation of

ISourceReplay.getChannel

---

getCustomName

getCustomName: () => Promise<string>

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

See: #core/ISource#getCustomName getCustomName

Returns

Promise<string>

Inherited from

Source.getCustomName

---

getHotkey

getHotkey: () => Promise<number>

Defined in: core/source/replay.ts:48

See: #core/ISourceReplay#getHotkey getHotkey

Returns

Promise<number>

Implementation of

ISourceReplay.getHotkey

---

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

---

getReplayState

getReplayState: () => Promise<number>

Defined in: core/source/replay.ts:66

See: #core/ISourceReplay#getReplayState getReplayState

Returns

Promise<number>

Implementation of

ISourceReplay.getReplayState

---

getReplayTime

getReplayTime: () => Promise<number>

Defined in: core/source/replay.ts:54

See: #core/ISourceReplay#getReplayTime getReplayTime

Returns

Promise<number>

Implementation of

ISourceReplay.getReplayTime

---

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

---

getVolume

getVolume: () => Promise<number>

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

See: #core/IAudio#getVolume getVolume

Returns

Promise<number>

Implementation of

IAudio.getVolume

---

isAudioAvailable

isAudioAvailable: () => Promise<boolean>

Defined in: core/source/replay.ts:101

See: #core/IAudio#isAudioAvailable isAudioAvailable

Returns

Promise<boolean>

Implementation of

IAudio.isAudioAvailable

---

isAutoMute

isAutoMute: () => Promise<boolean>

Defined in: core/source/replay.ts:83

See: #core/IAudio#isAutoMute isAutoMute

Returns

Promise<boolean>

Implementation of

IAudio.isAutoMute

---

isAutostartOnSceneLoad

isAutostartOnSceneLoad: () => Promise<boolean>

Defined in: core/source/replay.ts:69

See: #core/ISourceReplay#isAutostartOnSceneLoad isAutostartOnSceneLoad

Returns

Promise<boolean>

Implementation of

ISourceReplay.isAutostartOnSceneLoad

---

isMute

isMute: () => Promise<boolean>

Defined in: core/source/replay.ts:80

See: #core/IAudio#isMute isMute

Returns

Promise<boolean>

Implementation of

IAudio.isMute

---

isStreamOnlyAudio

isStreamOnlyAudio: () => Promise<boolean>

Defined in: core/source/replay.ts:95

See: #core/IAudio#isStreamOnlyAudio isStreamOnlyAudio

Returns

Promise<boolean>

Implementation of

IAudio.isStreamOnlyAudio

---

refresh

refresh: () => Promise<Source>

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

See: #core/ISource#refresh refresh

Returns

Promise<Source>

Inherited from

Source.refresh

---

setAutoMute

setAutoMute: (value) => Promise<ReplaySource>

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

See: #core/IAudio#setAutoMute setAutoMute

Parameters

value

boolean

Returns

Promise<ReplaySource>

Implementation of

IAudio.setAutoMute

---

setAutostartOnSceneLoad

setAutostartOnSceneLoad: (value) => Promise<ReplaySource>

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

See: #core/ISourceReplay#setAutostartOnSceneLoad setAutostartOnSceneLoad

Parameters

value

boolean

Returns

Promise<ReplaySource>

Implementation of

ISourceReplay.setAutostartOnSceneLoad

---

setChannel

setChannel: (channel) => Promise<ReplaySource>

Defined in: core/source/replay.ts:45

See: #core/ISourceReplay#setChannel setChannel

Parameters

channel

string

Returns

Promise<ReplaySource>

Implementation of

ISourceReplay.setChannel

---

setCustomName

setCustomName: () => Promise<Source>

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

See: #core/ISource#setCustomName setCustomName

Returns

Promise<Source>

Inherited from

Source.setCustomName

---

setHotkey

setHotkey: (hotkey) => Promise<ReplaySource>

Defined in: core/source/replay.ts:51

See: #core/ISourceReplay#setHotkey setHotkey

Parameters

hotkey

number

Returns

Promise<ReplaySource>

Implementation of

ISourceReplay.setHotkey

---

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<ReplaySource>

Defined in: core/source/replay.ts:89

See: #core/IAudio#setMute setMute

Parameters

value

boolean

Returns

Promise<ReplaySource>

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

---

setReplayTime

setReplayTime: (buffer) => Promise<ReplaySource>

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

See: #core/ISourceReplay#setReplayTime setReplayTime

Parameters

buffer

number

Returns

Promise<ReplaySource>

Implementation of

ISourceReplay.setReplayTime

---

setStreamOnlyAudio

setStreamOnlyAudio: (value) => Promise<ReplaySource>

Defined in: core/source/replay.ts:98

See: #core/IAudio#setStreamOnlyAudio setStreamOnlyAudio

Parameters

value

boolean

Returns

Promise<ReplaySource>

Implementation of

IAudio.setStreamOnlyAudio

---

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

---

setVolume

setVolume: (value) => Promise<ReplaySource>

Defined in: core/source/replay.ts:86

See: #core/IAudio#setVolume setVolume

Parameters

value

number

Returns

Promise<ReplaySource>

Implementation of

IAudio.setVolume

---

startReplay

startReplay: () => Promise<ReplaySource>

Defined in: core/source/replay.ts:60

See: #core/ISourceReplay#startReplay startReplay

Returns

Promise<ReplaySource>

Implementation of

ISourceReplay.startReplay

---

stopReplay

stopReplay: () => Promise<ReplaySource>

Defined in: core/source/replay.ts:63

See: #core/ISourceReplay#stopReplay stopReplay

Returns

Promise<ReplaySource>

Implementation of

ISourceReplay.stopReplay

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