AudioItem

Defined in: core/items/audio.ts:39

The AudioItem class represents an audio device that has been added to the stage.

Inherits from: #core/Item Core/Item

Implements: #core/IAudio Core/IAudio

Basic Usage

var XJS = require('xjs');

XJS.Scene.getActiveScene().then(function(scene) {
  scene.getItems().then(function(items) {
    for (var i in items) {
      if (items[i] instanceof XJS.AudioItem) {
        // Manipulate your audio device item here
        items[i].setSilenceDetectionEnabled(true);
      }
    }
  });
});

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

Extends

• Item

Implements

• ISourceAudio
• IAudio

Constructors

Constructor

new AudioItem(props?): AudioItem

Defined in: core/items/item.ts:88

Parameters

props?

Returns

AudioItem

Inherited from

Item.constructor

Properties

bringForward

bringForward: () => Promise<Item>

Defined in: core/items/item.ts:617

See: #core/IItemLayout#bringForward bringForward

Returns

Promise<Item>

Inherited from

Item.bringForward

---

bringToFront

bringToFront: () => Promise<Item>

Defined in: core/items/item.ts:622

See: #core/IItemLayout#bringToFront bringToFront

Returns

Promise<Item>

Inherited from

Item.bringToFront

---

getAudioOffset

getAudioOffset: () => Promise<number>

Defined in: core/items/audio.ts:61

See: #core/AudioSource#getAudioOffset getAudioOffset

Returns

Promise<number>

Implementation of

ISourceAudio.getAudioOffset

---

getCanvasRotate

getCanvasRotate: () => Promise<number>

Defined in: core/items/item.ts:642

See: #core/IItemLayout#getCanvasRotate getCanvasRotate

Returns

Promise<number>

Inherited from

Item.getCanvasRotate

---

getCropping

getCropping: () => Promise<Object>

Defined in: core/items/item.ts:647

See: #core/IItemLayout#getCropping getCropping

Returns

Promise<Object>

Inherited from

Item.getCropping

---

getCustomName

getCustomName: () => Promise<string>

Defined in: core/items/item.ts:758

See: #core/Source#getCustomName getCustomName

Returns

Promise<string>

Inherited from

Item.getCustomName

---

getEnhancedRotate

getEnhancedRotate: () => Promise<number>

Defined in: core/items/item.ts:652

See: #core/IItemLayout#getEnhancedRotate getEnhancedRotate

Returns

Promise<number>

Inherited from

Item.getEnhancedRotate

---

getId

getId: () => Promise<string>

Defined in: core/items/item.ts:267

return: Promise

Get the ID of the Item

Usage

item.getId().then(function(id) {
  // The rest of your code here
});

Returns

Promise<string>

Inherited from

Item.getId

---

getItemList

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

Defined in: core/items/item.ts:513

See: #core/Source#getItemList getItemList

Returns

Promise<Item[]>

Inherited from

Item.getItemList

---

getKeepLoaded

getKeepLoaded: () => Promise<boolean>

Defined in: core/items/item.ts:773

See: #core/Source#getKeepLoaded getKeepLoaded

Returns

Promise<boolean>

Inherited from

Item.getKeepLoaded

---

getName

getName: () => Promise<string>

Defined in: core/items/item.ts:748

See: #core/Source#getName getName

Returns

Promise<string>

Inherited from

Item.getName

---

getPosition

getPosition: () => Promise<Rectangle>

Defined in: core/items/item.ts:657

See: #core/IItemLayout#getPosition getPosition

Returns

Promise<Rectangle>

Inherited from

Item.getPosition

---

getRotateX

getRotateX: () => Promise<number>

Defined in: core/items/item.ts:667

See: #core/IItemLayout#getRotateX getRotateX

Returns

Promise<number>

Inherited from

Item.getRotateX

---

getRotateY

getRotateY: () => Promise<number>

Defined in: core/items/item.ts:662

See: #core/IItemLayout#getRotateY getRotateY

Returns

Promise<number>

Inherited from

Item.getRotateY

---

getRotateZ

getRotateZ: () => Promise<number>

Defined in: core/items/item.ts:672

See: #core/IItemLayout#getRotateZ getRotateZ

Returns

Promise<number>

Inherited from

Item.getRotateZ

---

getSilencePeriod

getSilencePeriod: () => Promise<number>

Defined in: core/items/audio.ts:55

See: #core/AudioSource#getSilencePeriod getSilencePeriod

Returns

Promise<number>

Implementation of

ISourceAudio.getSilencePeriod

---

getSilenceThreshold

getSilenceThreshold: () => Promise<number>

Defined in: core/items/audio.ts:49

See: #core/AudioSource#getSilenceThreshold getSilenceThreshold

Returns

Promise<number>

Implementation of

ISourceAudio.getSilenceThreshold

---

getType

getType: () => Promise<ItemTypes>

Defined in: core/items/item.ts:786

See: #core/Source#getType getType

Returns

Promise<ItemTypes>

Inherited from

Item.getType

---

getValue

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

Defined in: core/items/item.ts:763

See: #core/Source#getValue getValue

Returns

Promise<string | XML>

Implementation of

ISourceAudio.getValue

Inherited from

Item.getValue

---

getVolume

getVolume: () => Promise<number>

Defined in: core/items/audio.ts:69

See: #core/IAudio#getVolume getVolume

Returns

Promise<number>

Implementation of

IAudio.getVolume

---

isAudioAvailable

isAudioAvailable: () => Promise<boolean>

Defined in: core/items/audio.ts:93

See: #core/IAudio#isAudioAvailable isAudioAvailable

Returns

Promise<boolean>

Implementation of

IAudio.isAudioAvailable

---

isAutoMute

isAutoMute: () => Promise<boolean>

Defined in: core/items/audio.ts:75

See: #core/IAudio#isAutoMute isAutoMute

Returns

Promise<boolean>

Implementation of

IAudio.isAutoMute

---

isEnhancedResizeEnabled

isEnhancedResizeEnabled: () => Promise<boolean>

Defined in: core/items/item.ts:637

See: #core/IItemLayout#isEnhancedResizeEnabled isEnhancedResizeEnabled

Returns

Promise<boolean>

Inherited from

Item.isEnhancedResizeEnabled

---

isKeepAspectRatio

isKeepAspectRatio: () => Promise<boolean>

Defined in: core/items/item.ts:627

See: #core/IItemLayout#isKeepAspectRatio isKeepAspectRatio

Returns

Promise<boolean>

Inherited from

Item.isKeepAspectRatio

---

isMute

isMute: () => Promise<boolean>

Defined in: core/items/audio.ts:72

See: #core/IAudio#isMute isMute

Returns

Promise<boolean>

Implementation of

IAudio.isMute

---

isPositionLocked

isPositionLocked: () => Promise<boolean>

Defined in: core/items/item.ts:632

See: #core/IItemLayout#isPositionLocked isPositionLocked

Returns

Promise<boolean>

Inherited from

Item.isPositionLocked

---

isSilenceDetectionEnabled

isSilenceDetectionEnabled: () => Promise<boolean>

Defined in: core/items/audio.ts:43

See: #core/AudioSource#isSilenceDetectionEnabled isSilenceDetectionEnabled

Returns

Promise<boolean>

Implementation of

ISourceAudio.isSilenceDetectionEnabled

---

isStreamOnlyAudio

isStreamOnlyAudio: () => Promise<boolean>

Defined in: core/items/audio.ts:87

See: #core/IAudio#isStreamOnlyAudio isStreamOnlyAudio

Returns

Promise<boolean>

Implementation of

IAudio.isStreamOnlyAudio

---

refresh

refresh: () => Promise<Source>

Defined in: core/items/item.ts:783

See: #core/Source#refresh refresh

Returns

Promise<Source>

Inherited from

Item.refresh

---

sendBackward

sendBackward: () => Promise<Item>

Defined in: core/items/item.ts:677

See: #core/IItemLayout#sendBackward sendBackward

Returns

Promise<Item>

Inherited from

Item.sendBackward

---

sendToBack

sendToBack: () => Promise<Item>

Defined in: core/items/item.ts:682

See: #core/IItemLayout#sendToBack sendToBack

Returns

Promise<Item>

Inherited from

Item.sendToBack

---

setAudioOffset

setAudioOffset: (value) => Promise<SourceAudio>

Defined in: core/items/audio.ts:64

See: #core/AudioSource#setAudioOffset setAudioOffset

Parameters

value

number

Returns

Promise<SourceAudio>

Implementation of

ISourceAudio.setAudioOffset

---

setAutoMute

setAutoMute: (value) => Promise<AudioItem>

Defined in: core/items/audio.ts:84

See: #core/IAudio#setAutoMute setAutoMute

Parameters

value

boolean

Returns

Promise<AudioItem>

Implementation of

IAudio.setAutoMute

---

setCanvasRotate

setCanvasRotate: (value) => Promise<Item>

Defined in: core/items/item.ts:687

See: #core/IItemLayout#setCanvasRotate setCanvasRotate

Parameters

value

number

Returns

Promise<Item>

Inherited from

Item.setCanvasRotate

---

setCropping

setCropping: (value) => Promise<Item>

Defined in: core/items/item.ts:692

See: #core/IItemLayout#setCropping setCropping

Parameters

value

Object

Returns

Promise<Item>

Inherited from

Item.setCropping

---

setCroppingEnhanced

setCroppingEnhanced: (value) => Promise<Item>

Defined in: core/items/item.ts:697

See: #core/IItemLayout#setCroppingEnhanced setCroppingEnhanced

Parameters

value

Object

Returns

Promise<Item>

Inherited from

Item.setCroppingEnhanced

---

setCustomName

setCustomName: () => Promise<Item>

Defined in: core/items/item.ts:753

See: #core/Source#setCustomName setCustomName

Returns

Promise<Item>

Inherited from

Item.setCustomName

---

setEnhancedResizeEnabled

setEnhancedResizeEnabled: (value) => Promise<Item>

Defined in: core/items/item.ts:717

See: #core/IItemLayout#setEnhancedResizeEnabled setEnhancedResizeEnabled

Parameters

value

boolean

Returns

Promise<Item>

Inherited from

Item.setEnhancedResizeEnabled

---

setEnhancedRotate

setEnhancedRotate: (value) => Promise<Item>

Defined in: core/items/item.ts:702

See: #core/IItemLayout#setEnhancedRotate setEnhancedRotate

Parameters

value

number

Returns

Promise<Item>

Inherited from

Item.setEnhancedRotate

---

setKeepAspectRatio

setKeepAspectRatio: (value) => Promise<Item>

Defined in: core/items/item.ts:707

See: #core/IItemLayout#setKeepAspectRatio setKeepAspectRatio

Parameters

value

boolean

Returns

Promise<Item>

Inherited from

Item.setKeepAspectRatio

---

setKeepLoaded

setKeepLoaded: (value) => Promise<Item>

Defined in: core/items/item.ts:778

See: #core/Source#setKeepLoaded setKeepLoaded

Parameters

value

boolean

Returns

Promise<Item>

Inherited from

Item.setKeepLoaded

---

setMute

setMute: (value) => Promise<AudioItem>

Defined in: core/items/audio.ts:81

See: #core/IAudio#setMute setMute

Parameters

value

boolean

Returns

Promise<AudioItem>

Implementation of

IAudio.setMute

---

setName

setName: (value) => Promise<Item>

Defined in: core/items/item.ts:743

See: #core/Source#setName setName

Parameters

value

string

Returns

Promise<Item>

Inherited from

Item.setName

---

setPosition

setPosition: (value) => Promise<Item>

Defined in: core/items/item.ts:722

See: #core/IItemLayout#setPosition setPosition

Parameters

value

Rectangle

Returns

Promise<Item>

Inherited from

Item.setPosition

---

setPositionLocked

setPositionLocked: (value) => Promise<Item>

Defined in: core/items/item.ts:712

See: #core/IItemLayout#setPositionLocked setPositionLocked

Parameters

value

boolean

Returns

Promise<Item>

Inherited from

Item.setPositionLocked

---

setRotateX

setRotateX: (value) => Promise<Item>

Defined in: core/items/item.ts:732

See: #core/IItemLayout#setRotateX setRotateX

Parameters

value

number

Returns

Promise<Item>

Inherited from

Item.setRotateX

---

setRotateY

setRotateY: (value) => Promise<Item>

Defined in: core/items/item.ts:727

See: #core/IItemLayout#setRotateY setRotateY

Parameters

value

number

Returns

Promise<Item>

Inherited from

Item.setRotateY

---

setRotateZ

setRotateZ: (value) => Promise<Item>

Defined in: core/items/item.ts:737

See: #core/IItemLayout#setRotateZ setRotateZ

Parameters

value

number

Returns

Promise<Item>

Inherited from

Item.setRotateZ

---

setSilenceDetectionEnabled

setSilenceDetectionEnabled: (value) => Promise<AudioItem>

Defined in: core/items/audio.ts:46

See: #core/AudioSource#setSilenceDetectionEnabled setSilenceDetectionEnabled

Parameters

value

boolean

Returns

Promise<AudioItem>

Implementation of

ISourceAudio.setSilenceDetectionEnabled

---

setSilencePeriod

setSilencePeriod: (value) => Promise<AudioItem>

Defined in: core/items/audio.ts:58

See: #core/AudioSource#setSilencePeriod setSilencePeriod

Parameters

value

number

Returns

Promise<AudioItem>

Implementation of

ISourceAudio.setSilencePeriod

---

setSilenceThreshold

setSilenceThreshold: (value) => Promise<AudioItem>

Defined in: core/items/audio.ts:52

See: #core/AudioSource#setSilenceThreshold setSilenceThreshold

Parameters

value

number

Returns

Promise<AudioItem>

Implementation of

ISourceAudio.setSilenceThreshold

---

setStreamOnlyAudio

setStreamOnlyAudio: (value) => Promise<AudioItem>

Defined in: core/items/audio.ts:90

See: #core/IAudio#setStreamOnlyAudio setStreamOnlyAudio

Parameters

value

boolean

Returns

Promise<AudioItem>

Implementation of

IAudio.setStreamOnlyAudio

---

setValue

setValue: (value) => Promise<Item>

Defined in: core/items/item.ts:768

See: #core/Source#setValue setValue

Parameters

value

string | XML

Returns

Promise<Item>

Implementation of

ISourceAudio.setValue

Inherited from

Item.setValue

---

setVolume

setVolume: (value) => Promise<AudioItem>

Defined in: core/items/audio.ts:78

See: #core/IAudio#setVolume setVolume

Parameters

value

number

Returns

Promise<AudioItem>

Implementation of

IAudio.setVolume

---

_emitter

static _emitter: EventEmitter

Defined in: core/items/item.ts:85

Inherited from

Item._emitter

---

_subscriptions

static _subscriptions: any[] = []

Defined in: core/items/item.ts:86

Inherited from

Item._subscriptions

Methods

duplicate()

duplicate(options?): Promise<Item>

Defined in: core/items/item.ts:416

param: (options: {linked?:, scene?: })

return: Promise<Item>

Duplicate an item into the current scene or to a specified scene as Linked or Unlinked.

Linked items would generally have a single source, and any changes in the property of an item would be applied to all linked items.

Chainable

Usage

// item pertains to an actual Item instance
// Sample 1
item.duplicate() // duplicate selected item to the current scene as unlinked

Duplicate the selected item to a specific scene and set it to be linked to a single source with the original item.

// Sample 2
var toScene = xjs.Scene.getById(2)
item.duplicate({linked:true, scene:toScene})

Parameters

options?

linked?

boolean

scene?

number | Scene

Returns

Promise<Item>

Inherited from

Item.duplicate

---

getFPS()

getFPS(): Promise<number>

Defined in: core/items/item.ts:282

return: Promise

Get the frames rendered per second of an item

Usage

item.getFPS().then(function(fps) {
  // The rest of your code here
});

Returns

Promise<number>

Inherited from

Item.getFPS

---

getParentItem()

getParentItem(): Promise<Item>

Defined in: core/items/item.ts:587

return: Promise

Get the GroupItem that contains this item. This rejects if item is not a child item or non-existent

Usage

item.getParentItem()
.then(function(parentItem) {
  console.log(parentItem);
});

Returns

Promise<Item>

Inherited from

Item.getParentItem

---

getSceneId()

getSceneId(): Promise<string | number>

Defined in: core/items/item.ts:351

return: Promise<number|string>

Get (1-indexed) Scene ID where the source is loaded

Usage

source.getSceneId().then(function(id) {
  // The rest of your code here
});

Returns

Promise<string | number>

Inherited from

Item.getSceneId

---

getSource()

getSource(): Promise<Source>

Defined in: core/items/item.ts:530

return: Promise

Gets the Source of an item, linked items would only have 1 source.

Chainable

Usage

item.getSource().then(function(source) {
  //Manipulate source here
  source.setName('New Name')
})

Returns

Promise<Source>

Inherited from

Item.getSource

---

getView()

getView(): Promise<ViewTypes>

Defined in: core/items/item.ts:320

return: Promise

Get the view type of the item

Usage

item.getView().then(function(view) {
  // view values:
  // 0 = main view
  // 1 = preview editor
  // 2 = thumbnail preview
})

Returns

Promise<ViewTypes>

Inherited from

Item.getView

---

isChildItem()

isChildItem(): Promise<boolean>

Defined in: core/items/item.ts:558

return: Promise

Checks if item is part of a group

Usage

item.isChildItem()
.then(function(isChild) {
  console.log(isChild);
});

Returns

Promise<boolean>

Inherited from

Item.isChildItem

---

off()

off(event, handler): void

Defined in: core/items/item.ts:224

param: (event: string, handler: Function)

Removes specificied event handler bound by on. Note that this can only be done for named function handlers.

Usage:

let itemChange = function(...args) {
  console.log('Item has changed');
}

let current;
let items;
xjs.Scene.getActiveScene()
.then( scene => {
  current = scene;
  return current.getItems();
}).then( list => {
  items = list;
  items[0].on('item-changed', itemChange);
  setTimeout( ()=> {
    items[0].off('item-changed', itemChange);
  }, 10000);
});

Parameters

event

string

handler

Function

Returns

void

Inherited from

Item.off

---

on()

on(event, handler): void

Defined in: core/items/item.ts:126

param: (event: string, handler: Function)

Allows listening to events per instance. Currently there are only two: item-changed and item-destroyed.

Item change is triggered thru any property change:

• via js(source plugin/extension),
• via visibility-toggling through the sources list,
• or via the source properties dialog

Usage:

let itemChange = function(...args) {
  console.log('Item has changed');
}

let current;
let items;
xjs.Scene.getActiveScene()
.then( scene => {
  current = scene;
  return current.getItems();
}).then( list => {
  items = list;
  items[0].on('item-changed', itemChange);
});

Duplicate handlers are allowed.

Parameters

event

string

handler

Function

Returns

void

Inherited from

Item.on

---

remove()

remove(): Promise<boolean>

Defined in: core/items/item.ts:504

return: Promise

Removes selected item

Usage

item.remove()

Returns

Promise<boolean>

Inherited from

Item.remove

---

toXML()

toXML(): XML

Defined in: core/items/item.ts:373

return: XML

Convert the Item object to an XML object. Use toString() to get the string version of the returned object.

Usage

var xml = item.toXML();

Returns

XML

Inherited from

Item.toXML

---

unlink()

unlink(): Promise<Item>

Defined in: core/items/item.ts:486

return: Promise

Unlinks selected item.

Unlinks an item to the source of other linked items and renders its own source.

Usage

item.unlink()

Note: Once you unlink an Item, there’s still no method to reverse the process.

Returns

Promise<Item>

Inherited from

Item.unlink

---

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

Item.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

Item.getCurrentSource

---

getItemList()

static getItemList(): Promise<Item[]>

Defined in: core/items/item.ts:248

return: Promise<Item[]>

Gets the list of linked items of the current Item. Linked items are items linked to a single source.

Usage

xjs.Item.getItemList().then(function(items) {
  for (var i = 0 ; i < items.length ; i++) {
    // Manipulate each item here
    items[i].setKeepAspectRatio(true);
  }
})

This is simply a shortcut to: xjs.Item.getCurrentSource() -> source.getItemList()

Returns

Promise<Item[]>

Inherited from

Item.getItemList