HtmlSource

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

The HtmlSource class represents the sources of the html 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 HtmlItem class. See: #core/HtmlItem Core/HtmlItem

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

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

Extends

Source

Implements

ISourceConfigurable
IAudio
ISourceHtml

Constructors

Constructor

new HtmlSource(props?): HtmlSource

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

Parameters

props?

Returns

HtmlSource

Inherited from

Source.constructor

Properties

applyConfig

applyConfig: (configObj) => Promise<HtmlSource>

Defined in: core/source/html.ts:195

See: #core/ISourceConfigurable#applyConfig applyConfig

Parameters

configObj

any

Returns

Promise<HtmlSource>

Implementation of

ISourceConfigurable.applyConfig

call

call: () => Promise<HtmlSource>

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

See: #core/ISourceHtml#call call

Returns

Promise<HtmlSource>

Implementation of

ISourceHtml.call

enableBrowser60FPS

enableBrowser60FPS: (value) => Promise<HtmlSource>

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

See: #core/ISourceHtml#enableBrowser60FPS enableBrowser60FPS

Parameters

value

boolean

Returns

Promise<HtmlSource>

Implementation of

ISourceHtml.enableBrowser60FPS

enableBrowserJS

enableBrowserJS: (value) => Promise<HtmlSource>

Defined in: core/source/html.ts:120

See: #core/ISourceHtml#enableBrowserJS enableBrowserJS

Parameters

value

boolean

Returns

Promise<HtmlSource>

Implementation of

ISourceHtml.enableBrowserJS

enableBrowserTransparency

enableBrowserTransparency: (value) => Promise<HtmlSource>

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

See: #core/ISourceHtml#enableBrowserTransparency enableBrowserTransparency

Parameters

value

boolean

Returns

Promise<HtmlSource>

Implementation of

ISourceHtml.enableBrowserTransparency

enableCustomCSS

enableCustomCSS: (value) => Promise<HtmlSource>

Defined in: core/source/html.ts:140

See: #core/ISourceHtml#enableCustomCSS enableCustomCSS

Parameters

value

boolean

Returns

Promise<HtmlSource>

Implementation of

ISourceHtml.enableCustomCSS

enableReloadOnSceneEnter

enableReloadOnSceneEnter: (value) => Promise<HtmlSource>

Defined in: core/source/html.ts:170

See: #core/ISourceHtml#enableReloadOnSceneEnter enableReloadOnSceneEnter

Parameters

value

boolean

Returns

Promise<HtmlSource>

Implementation of

ISourceHtml.enableReloadOnSceneEnter

enableReloadOnShow

enableReloadOnShow: (value) => Promise<HtmlSource>

Defined in: core/source/html.ts:160

See: #core/ISourceHtml#enableReloadOnShow enableReloadOnShow

Parameters

value

boolean

Returns

Promise<HtmlSource>

Implementation of

ISourceHtml.enableReloadOnShow

getAllowRightClick

getAllowRightClick: () => Promise<boolean>

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

See: #core/ISourceHtml#getAllowRightClick getAllowRightClick

Returns

Promise<boolean>

Implementation of

ISourceHtml.getAllowRightClick

getBrowserCustomSize

getBrowserCustomSize: () => Promise<Rectangle>

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

See: #core/ISourceHtml#getBrowserCustomSize getBrowserCustomSize

Returns

Promise<Rectangle>

Implementation of

ISourceHtml.getBrowserCustomSize

getBrowserJS

getBrowserJS: () => Promise<string>

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

See: #core/ISourceHtml#getBrowserJS getBrowserJS

Returns

Promise<string>

Implementation of

ISourceHtml.getBrowserJS

getBrowserLoadStatus

getBrowserLoadStatus: () => Promise<string>

Defined in: core/source/html.ts:150

See: #core/ISourceHtml#getBrowserLoadStatus getBrowserLoadStatus

Returns

Promise<string>

Implementation of

ISourceHtml.getBrowserLoadStatus

getCustomCSS

getCustomCSS: () => Promise<string>

Defined in: core/source/html.ts:125

See: #core/ISourceHtml#getCustomCSS getCustomCSS

Returns

Promise<string>

Implementation of

ISourceHtml.getCustomCSS

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

getType

getType: () => Promise<ItemTypes>

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

See: #core/ISource#getType getType

Returns

Promise<ItemTypes>

Inherited from

Source.getType

getURL

getURL: () => Promise<string>

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

See: #core/ISourceHtml#getURL getURL

Returns

Promise<string>

Implementation of

ISourceHtml.getURL

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/html.ts:200

See: #core/IAudio#getVolume getVolume

Returns

Promise<number>

Implementation of

IAudio.getVolume

isAudioAvailable

isAudioAvailable: () => Promise<boolean>

Defined in: core/source/html.ts:224

See: #core/IAudio#isAudioAvailable isAudioAvailable

Returns

Promise<boolean>

Implementation of

IAudio.isAudioAvailable

isAutoMute

isAutoMute: () => Promise<boolean>

Defined in: core/source/html.ts:206

See: #core/IAudio#isAutoMute isAutoMute

Returns

Promise<boolean>

Implementation of

IAudio.isAutoMute

isBrowser60FPS

isBrowser60FPS: () => Promise<boolean>

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

See: #core/ISourceHtml#isBrowser60FPS isBrowser60FPS

Returns

Promise<boolean>

Implementation of

ISourceHtml.isBrowser60FPS

isBrowserJSEnabled

isBrowserJSEnabled: () => Promise<boolean>

Defined in: core/source/html.ts:115

See: #core/ISourceHtml#isBrowserJSEnabled isBrowserJSEnabled

Returns

Promise<boolean>

Implementation of

ISourceHtml.isBrowserJSEnabled

isBrowserOptimized

isBrowserOptimized: () => Promise<boolean>

Defined in: core/source/html.ts:145

See: #core/ISourceHtml#isBrowserOptimized isBrowserOptimized

Returns

Promise<boolean>

Implementation of

ISourceHtml.isBrowserOptimized

isBrowserTransparent

isBrowserTransparent: () => Promise<boolean>

Defined in: core/source/html.ts:65

See: #core/ISourceHtml#isBrowserTransparent isBrowserTransparent

Returns

Promise<boolean>

Implementation of

ISourceHtml.isBrowserTransparent

isCustomCSSEnabled

isCustomCSSEnabled: () => Promise<boolean>

Defined in: core/source/html.ts:135

See: #core/ISourceHtml#isCustomCSSEnabled isCustomCSSEnabled

Returns

Promise<boolean>

Implementation of

ISourceHtml.isCustomCSSEnabled

isMute

isMute: () => Promise<boolean>

Defined in: core/source/html.ts:203

See: #core/IAudio#isMute isMute

Returns

Promise<boolean>

Implementation of

IAudio.isMute

isReloadOnSceneEnterEnabled

isReloadOnSceneEnterEnabled: () => Promise<boolean>

Defined in: core/source/html.ts:165

See: #core/ISourceHtml#isReloadOnSceneEnterEnabled isReloadOnSceneEnterEnabled

Returns

Promise<boolean>

Implementation of

ISourceHtml.isReloadOnSceneEnterEnabled

isReloadOnShowEnabled

isReloadOnShowEnabled: () => Promise<boolean>

Defined in: core/source/html.ts:155

See: #core/ISourceHtml#isReloadOnShowEnabled isReloadOnShowEnabled

Returns

Promise<boolean>

Implementation of

ISourceHtml.isReloadOnShowEnabled

isSourceAvailable

isSourceAvailable: () => Promise<boolean>

Defined in: core/source/html.ts:173

See: #core/ISourceHtml#isSourceAvailable isSourceAvailable

Returns

Promise<boolean>

Implementation of

ISourceHtml.isSourceAvailable

isStreamOnlyAudio

isStreamOnlyAudio: () => Promise<boolean>

Defined in: core/source/html.ts:218

See: #core/IAudio#isStreamOnlyAudio isStreamOnlyAudio

Returns

Promise<boolean>

Implementation of

IAudio.isStreamOnlyAudio

loadConfig

loadConfig: () => Promise<any>

Defined in: core/source/html.ts:179

See: #core/ISourceConfigurable#loadConfig loadConfig

Returns

Promise<any>

Implementation of

ISourceConfigurable.loadConfig

refresh

refresh: () => Promise<Source>

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

See: #core/ISource#refresh refresh

Returns

Promise<Source>

Inherited from

Source.refresh

requestSaveConfig

requestSaveConfig: (configObj) => Promise<HtmlSource>

Defined in: core/source/html.ts:189

See: #core/ISourceConfigurable#requestSaveConfig requestSaveConfig

Parameters

configObj

any

Returns

Promise<HtmlSource>

Implementation of

ISourceConfigurable.requestSaveConfig

saveConfig

saveConfig: (configObj) => Promise<HtmlSource>

Defined in: core/source/html.ts:184

See: #core/ISourceConfigurable#saveConfig saveConfig

Parameters

configObj

any

Returns

Promise<HtmlSource>

Implementation of

ISourceConfigurable.saveConfig

setAllowRightClick

setAllowRightClick: (value) => Promise<HtmlSource>

Defined in: core/source/html.ts:100

See: #core/ISourceHtml#setAllowRightClick setAllowRightClick

Parameters

value

boolean

Returns

Promise<HtmlSource>

Implementation of

ISourceHtml.setAllowRightClick

setAutoMute

setAutoMute: (value) => Promise<HtmlSource>

Defined in: core/source/html.ts:215

See: #core/IAudio#setAutoMute setAutoMute

Parameters

value

boolean

Returns

Promise<HtmlSource>

Implementation of

IAudio.setAutoMute

setBrowserCustomSize

setBrowserCustomSize: (value) => Promise<HtmlSource>

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

See: #core/ISourceHtml#setBrowserCustomSize setBrowserCustomSize

Parameters

value

Rectangle

Returns

Promise<HtmlSource>

Implementation of

ISourceHtml.setBrowserCustomSize

setBrowserJS

setBrowserJS: () => Promise<HtmlSource>

Defined in: core/source/html.ts:110

See: #core/ISourceHtml#setBrowserJS setBrowserJS

Returns

Promise<HtmlSource>

Implementation of

ISourceHtml.setBrowserJS

setCustomCSS

setCustomCSS: (value) => Promise<HtmlSource>

Defined in: core/source/html.ts:130

See: #core/ISourceHtml#setCustomCSS setCustomCSS

Parameters

value

string

Returns

Promise<HtmlSource>

Implementation of

ISourceHtml.setCustomCSS

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

Defined in: core/source/html.ts:212

See: #core/IAudio#setMute setMute

Parameters

value

boolean

Returns

Promise<HtmlSource>

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

Defined in: core/source/html.ts:221

See: #core/IAudio#setStreamOnlyAudio setStreamOnlyAudio

Parameters

value

boolean

Returns

Promise<HtmlSource>

Implementation of

IAudio.setStreamOnlyAudio

setURL

setURL: () => Promise<HtmlSource>

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

See: #core/ISourceHtml#setURL setURL

Returns

Promise<HtmlSource>

Implementation of

ISourceHtml.setURL

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

Defined in: core/source/html.ts:209

See: #core/IAudio#setVolume setVolume

Parameters

value

number

Returns

Promise<HtmlSource>

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