AudioSource

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

The AudioSource class represents the sources of the audio 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 AudioItem class. See: #core/AudioItem Core/AudioItem

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

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

Extends

Source

Implements

Constructors

Constructor

new AudioSource(props?): AudioSource

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

Parameters

props?

Returns

AudioSource

Inherited from

Source.constructor

Properties

getAudioOffset

getAudioOffset: () => Promise<number>

Defined in: core/source/audio.ts:59

See: #core/ISourceAudio#getAudioOffset getAudioOffset

Returns

Promise<number>

Implementation of

ISourceAudio.getAudioOffset

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

getSilencePeriod

getSilencePeriod: () => Promise<number>

Defined in: core/source/audio.ts:53

See: #core/ISourceAudio#getSilencePeriod getSilencePeriod

Returns

Promise<number>

Implementation of

ISourceAudio.getSilencePeriod

getSilenceThreshold

getSilenceThreshold: () => Promise<number>

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

See: #core/ISourceAudio#getSilenceThreshold getSilenceThreshold

Returns

Promise<number>

Implementation of

ISourceAudio.getSilenceThreshold

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

ISourceAudio.getValue

Inherited from

Source.getValue

getVolume

getVolume: () => Promise<number>

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

See: #core/IAudio#getVolume getVolume

Returns

Promise<number>

Implementation of

IAudio.getVolume

isAudioAvailable

isAudioAvailable: () => Promise<boolean>

Defined in: core/source/audio.ts:91

See: #core/IAudio#isAudioAvailable isAudioAvailable

Returns

Promise<boolean>

Implementation of

IAudio.isAudioAvailable

isAutoMute

isAutoMute: () => Promise<boolean>

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

See: #core/IAudio#isAutoMute isAutoMute

Returns

Promise<boolean>

Implementation of

IAudio.isAutoMute

isMute

isMute: () => Promise<boolean>

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

See: #core/IAudio#isMute isMute

Returns

Promise<boolean>

Implementation of

IAudio.isMute

isSilenceDetectionEnabled

isSilenceDetectionEnabled: () => Promise<boolean>

Defined in: core/source/audio.ts:41

See: #core/ISourceAudio#isSilenceDetectionEnabled isSilenceDetectionEnabled

Returns

Promise<boolean>

Implementation of

ISourceAudio.isSilenceDetectionEnabled

isStreamOnlyAudio

isStreamOnlyAudio: () => Promise<boolean>

Defined in: core/source/audio.ts:85

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

setAudioOffset

setAudioOffset: (value) => Promise<SourceAudio>

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

See: #core/ISourceAudio#setAudioOffset setAudioOffset

Parameters

value

number

Returns

Promise<SourceAudio>

Implementation of

ISourceAudio.setAudioOffset

setAutoMute

setAutoMute: (value) => Promise<AudioSource>

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

See: #core/IAudio#setAutoMute setAutoMute

Parameters

value

boolean

Returns

Promise<AudioSource>

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

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

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

See: #core/IAudio#setMute setMute

Parameters

value

boolean

Returns

Promise<AudioSource>

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

setSilenceDetectionEnabled

setSilenceDetectionEnabled: (value) => Promise<AudioSource>

Defined in: core/source/audio.ts:44

See: #core/ISourceAudio#setSilenceDetectionEnabled setSilenceDetectionEnabled

Parameters

value

boolean

Returns

Promise<AudioSource>

Implementation of

ISourceAudio.setSilenceDetectionEnabled

setSilencePeriod

setSilencePeriod: (value) => Promise<AudioSource>

Defined in: core/source/audio.ts:56

See: #core/ISourceAudio#setSilencePeriod setSilencePeriod

Parameters

value

number

Returns

Promise<AudioSource>

Implementation of

ISourceAudio.setSilencePeriod

setSilenceThreshold

setSilenceThreshold: (value) => Promise<AudioSource>

Defined in: core/source/audio.ts:50

See: #core/ISourceAudio#setSilenceThreshold setSilenceThreshold

Parameters

value

number

Returns

Promise<AudioSource>

Implementation of

ISourceAudio.setSilenceThreshold

setStreamOnlyAudio

setStreamOnlyAudio: (value) => Promise<AudioSource>

Defined in: core/source/audio.ts:88

See: #core/IAudio#setStreamOnlyAudio setStreamOnlyAudio

Parameters

value

boolean

Returns

Promise<AudioSource>

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>

Implementation of

ISourceAudio.setValue

Inherited from

Source.setValue

setVolume

setVolume: (value) => Promise<AudioSource>

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

See: #core/IAudio#setVolume setVolume

Parameters

value

number

Returns

Promise<AudioSource>

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