VideoPlaylistSource

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

The VideoPlaylistSource class represents the sources of the videoplaylist 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 VideoPlaylistItem class. See: #core/VideoPlaylistItem Core/VideoPlaylistItem

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

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

Extends

• Source

Implements

• ISourceConfigurable
• ISourceVideoPlaylist
• ISourcePlayback
• IAudio

Constructors

Constructor

new VideoPlaylistSource(props?): VideoPlaylistSource

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

Parameters

props?

Returns

VideoPlaylistSource

Inherited from

Source.constructor

Properties

applyConfig

applyConfig: (configObj) => Promise<VideoPlaylistSource>

Defined in: core/source/videoplaylist.ts:116

See: #core/ISourceConfigurable#applyConfig applyConfig

Parameters

configObj

any

Returns

Promise<VideoPlaylistSource>

Implementation of

ISourceConfigurable.applyConfig

---

getActionAfterPlayback

getActionAfterPlayback: () => Promise<ActionAfterPlayback>

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

See: #core/ISourcePlayback#getActionAfterPlayback getActionAfterPlayback

Returns

Promise<ActionAfterPlayback>

Implementation of

ISourcePlayback.getActionAfterPlayback

---

getCuePoints

getCuePoints: () => Promise<CuePoint[]>

Defined in: core/source/videoplaylist.ts:223

See: #core/ISourcePlayback#getCuePoints getCuePoints

Returns

Promise<CuePoint[]>

Implementation of

ISourcePlayback.getCuePoints

---

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

---

getPlaybackDuration

getPlaybackDuration: () => Promise<number>

Defined in: core/source/videoplaylist.ts:138

See: #core/ISourcePlayback#getPlaybackDuration getPlaybackDuration

Returns

Promise<number>

Implementation of

ISourcePlayback.getPlaybackDuration

---

getPlaybackEndPosition

getPlaybackEndPosition: () => Promise<number>

Defined in: core/source/videoplaylist.ts:163

See: #core/ISourcePlayback#getPlaybackEndPosition getPlaybackEndPosition

Returns

Promise<number>

Implementation of

ISourcePlayback.getPlaybackEndPosition

---

getPlaybackPosition

getPlaybackPosition: () => Promise<number>

Defined in: core/source/videoplaylist.ts:128

See: #core/ISourcePlayback#getPlaybackPosition getPlaybackPosition

Returns

Promise<number>

Implementation of

ISourcePlayback.getPlaybackPosition

---

getPlaybackStartPosition

getPlaybackStartPosition: () => Promise<number>

Defined in: core/source/videoplaylist.ts:153

See: #core/ISourcePlayback#getPlaybackStartPosition getPlaybackStartPosition

Returns

Promise<number>

Implementation of

ISourcePlayback.getPlaybackStartPosition

---

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

ISourcePlayback.getValue

Inherited from

Source.getValue

---

getVideoNowPlaying

getVideoNowPlaying: () => Promise<string>

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

return: Promise

Gets the now playing video of this VideoPlaylist source.

Returns

Promise<string>

Implementation of

ISourceVideoPlaylist.getVideoNowPlaying

---

getVideoPlaylistSources

getVideoPlaylistSources: () => Promise<string[]>

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

return: Promise<string[]>

Gets the file paths of the playlist of this VideoPlaylist source.

Returns

Promise<string[]>

Implementation of

ISourceVideoPlaylist.getVideoPlaylistSources

---

getVolume

getVolume: () => Promise<number>

Defined in: core/source/videoplaylist.ts:247

See: #core/IAudio#getVolume getVolume

Returns

Promise<number>

Implementation of

IAudio.getVolume

---

isAudio

isAudio: () => Promise<boolean>

Defined in: core/source/videoplaylist.ts:237

See: #core/ISourcePlayback#isAudio isAudio

Returns

Promise<boolean>

Implementation of

ISourcePlayback.isAudio

---

isAudioAvailable

isAudioAvailable: () => Promise<boolean>

Defined in: core/source/videoplaylist.ts:271

See: #core/IAudio#isAudioAvailable isAudioAvailable

Returns

Promise<boolean>

Implementation of

IAudio.isAudioAvailable

---

isAutoMute

isAutoMute: () => Promise<boolean>

Defined in: core/source/videoplaylist.ts:253

See: #core/IAudio#isAutoMute isAutoMute

Returns

Promise<boolean>

Implementation of

IAudio.isAutoMute

---

isAutostartOnSceneLoad

isAutostartOnSceneLoad: () => Promise<boolean>

Defined in: core/source/videoplaylist.ts:183

See: #core/ISourcePlayback#isAutostartOnSceneLoad isAutostartOnSceneLoad

Returns

Promise<boolean>

Implementation of

ISourcePlayback.isAutostartOnSceneLoad

---

isForceDeinterlace

isForceDeinterlace: () => Promise<boolean>

Defined in: core/source/videoplaylist.ts:193

See: #core/ISourcePlayback#isForceDeinterlace isForceDeinterlace

Returns

Promise<boolean>

Implementation of

ISourcePlayback.isForceDeinterlace

---

isMute

isMute: () => Promise<boolean>

Defined in: core/source/videoplaylist.ts:250

See: #core/IAudio#isMute isMute

Returns

Promise<boolean>

Implementation of

IAudio.isMute

---

isPlaying

isPlaying: () => Promise<boolean>

Defined in: core/source/videoplaylist.ts:143

See: #core/ISourcePlayback#isPlaying isPlaying

Returns

Promise<boolean>

Implementation of

ISourcePlayback.isPlaying

---

isRememberingPlaybackPosition

isRememberingPlaybackPosition: () => Promise<boolean>

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

See: #core/ISourcePlayback#isRememberingPlaybackPosition isRememberingPlaybackPosition

Returns

Promise<boolean>

Implementation of

ISourcePlayback.isRememberingPlaybackPosition

---

isSeekable

isSeekable: () => Promise<boolean>

Defined in: core/source/videoplaylist.ts:123

See: #core/ISourcePlayback#isSeekable isSeekable

Returns

Promise<boolean>

Implementation of

ISourcePlayback.isSeekable

---

isShowingPlaybackPosition

isShowingPlaybackPosition: () => Promise<boolean>

Defined in: core/source/videoplaylist.ts:213

See: #core/ISourcePlayback#isShowingPlaybackPosition isShowingPlaybackPosition

Returns

Promise<boolean>

Implementation of

ISourcePlayback.isShowingPlaybackPosition

---

isSourceAvailable

isSourceAvailable: () => Promise<boolean>

Defined in: core/source/videoplaylist.ts:94

See: #core/ISourceVideoPlaylist#isSourceAvailable isSourceAvailable

Returns

Promise<boolean>

Implementation of

ISourceVideoPlaylist.isSourceAvailable

---

isStreamOnlyAudio

isStreamOnlyAudio: () => Promise<boolean>

Defined in: core/source/videoplaylist.ts:265

See: #core/IAudio#isStreamOnlyAudio isStreamOnlyAudio

Returns

Promise<boolean>

Implementation of

IAudio.isStreamOnlyAudio

---

isVideo

isVideo: () => Promise<boolean>

Defined in: core/source/videoplaylist.ts:242

See: #core/ISourcePlayback#isVideo isVideo

Returns

Promise<boolean>

Implementation of

ISourcePlayback.isVideo

---

loadConfig

loadConfig: () => Promise<any>

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

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

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

See: #core/ISourceConfigurable#requestSaveConfig requestSaveConfig

Parameters

configObj

any

Returns

Promise<VideoPlaylistSource>

Implementation of

ISourceConfigurable.requestSaveConfig

---

saveConfig

saveConfig: (configObj) => Promise<VideoPlaylistSource>

Defined in: core/source/videoplaylist.ts:106

See: #core/ISourceConfigurable#saveConfig saveConfig

Parameters

configObj

any

Returns

Promise<VideoPlaylistSource>

Implementation of

ISourceConfigurable.saveConfig

---

setActionAfterPlayback

setActionAfterPlayback: (value) => Promise<VideoPlaylistSource>

Defined in: core/source/videoplaylist.ts:178

See: #core/ISourcePlayback#setActionAfterPlayback setActionAfterPlayback

Parameters

value

ActionAfterPlayback

Returns

Promise<VideoPlaylistSource>

Implementation of

ISourcePlayback.setActionAfterPlayback

---

setAutoMute

setAutoMute: (value) => Promise<VideoPlaylistSource>

Defined in: core/source/videoplaylist.ts:262

See: #core/IAudio#setAutoMute setAutoMute

Parameters

value

boolean

Returns

Promise<VideoPlaylistSource>

Implementation of

IAudio.setAutoMute

---

setAutostartOnSceneLoad

setAutostartOnSceneLoad: (value) => Promise<VideoPlaylistSource>

Defined in: core/source/videoplaylist.ts:188

See: #core/ISourcePlayback#setAutostartOnSceneLoad setAutostartOnSceneLoad

Parameters

value

boolean

Returns

Promise<VideoPlaylistSource>

Implementation of

ISourcePlayback.setAutostartOnSceneLoad

---

setCuePoints

setCuePoints: (value) => Promise<VideoPlaylistSource>

Defined in: core/source/videoplaylist.ts:228

See: #core/ISourcePlayback#setCuePoints setCuePoints

Parameters

value

CuePoint[]

Returns

Promise<VideoPlaylistSource>

Implementation of

ISourcePlayback.setCuePoints

---

setCustomName

setCustomName: () => Promise<Source>

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

See: #core/ISource#setCustomName setCustomName

Returns

Promise<Source>

Inherited from

Source.setCustomName

---

setForceDeinterlace

setForceDeinterlace: (value) => Promise<VideoPlaylistSource>

Defined in: core/source/videoplaylist.ts:198

See: #core/ISourcePlayback#setForceDeinterlace setForceDeinterlace

Parameters

value

boolean

Returns

Promise<VideoPlaylistSource>

Implementation of

ISourcePlayback.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<VideoPlaylistSource>

Defined in: core/source/videoplaylist.ts:259

See: #core/IAudio#setMute setMute

Parameters

value

boolean

Returns

Promise<VideoPlaylistSource>

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

---

setPlaybackEndPosition

setPlaybackEndPosition: (value) => Promise<VideoPlaylistSource>

Defined in: core/source/videoplaylist.ts:168

See: #core/ISourcePlayback#setPlaybackEndPosition setPlaybackEndPosition

Parameters

value

number

Returns

Promise<VideoPlaylistSource>

Implementation of

ISourcePlayback.setPlaybackEndPosition

---

setPlaybackPosition

setPlaybackPosition: (value) => Promise<VideoPlaylistSource>

Defined in: core/source/videoplaylist.ts:133

See: #core/ISourcePlayback#setPlaybackPosition setPlaybackPosition

Parameters

value

number

Returns

Promise<VideoPlaylistSource>

Implementation of

ISourcePlayback.setPlaybackPosition

---

setPlaybackStartPosition

setPlaybackStartPosition: (value) => Promise<VideoPlaylistSource>

Defined in: core/source/videoplaylist.ts:158

See: #core/ISourcePlayback#setPlaybackStartPosition setPlaybackStartPosition

Parameters

value

number

Returns

Promise<VideoPlaylistSource>

Implementation of

ISourcePlayback.setPlaybackStartPosition

---

setPlaying

setPlaying: (value) => Promise<VideoPlaylistSource>

Defined in: core/source/videoplaylist.ts:148

See: #core/ISourcePlayback#setPlaying setPlaying

Parameters

value

boolean

Returns

Promise<VideoPlaylistSource>

Implementation of

ISourcePlayback.setPlaying

---

setRememberingPlaybackPosition

setRememberingPlaybackPosition: (value) => Promise<VideoPlaylistSource>

Defined in: core/source/videoplaylist.ts:208

See: #core/ISourcePlayback#setRememberingPlaybackPosition setRememberingPlaybackPosition

Parameters

value

boolean

Returns

Promise<VideoPlaylistSource>

Implementation of

ISourcePlayback.setRememberingPlaybackPosition

---

setShowingPlaybackPosition

setShowingPlaybackPosition: (value) => Promise<VideoPlaylistSource>

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

See: #core/ISourcePlayback#setShowingPlaybackPosition setShowingPlaybackPosition

Parameters

value

boolean

Returns

Promise<VideoPlaylistSource>

Implementation of

ISourcePlayback.setShowingPlaybackPosition

---

setStreamOnlyAudio

setStreamOnlyAudio: (value) => Promise<VideoPlaylistSource>

Defined in: core/source/videoplaylist.ts:268

See: #core/IAudio#setStreamOnlyAudio setStreamOnlyAudio

Parameters

value

boolean

Returns

Promise<VideoPlaylistSource>

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

ISourcePlayback.setValue

Inherited from

Source.setValue

---

setVideoNowPlaying

setVideoNowPlaying: (value) => Promise<SourceVideoPlaylist>

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

param: (value: string|number)

return: Promise<VideoPlaylistSource>

Sets the now playing video of this VideoPlaylist source.

Possible Values

• STRING - file path
• NUMBER - number|within the range of fileplaylist array length

Parameters

value

string | number

Returns

Promise<SourceVideoPlaylist>

Implementation of

ISourceVideoPlaylist.setVideoNowPlaying

---

setVideoPlaylistSources

setVideoPlaylistSources: (fileItems) => Promise<SourceVideoPlaylist>

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

param: (file: string[])

return: Promise<string>

Sets the playlist of this VideoPlaylist source according to the specified file paths.

This call would replace all the items on the playlist. The now playing item is also set to the first item of the new FilePlaylist.

Parameters

fileItems

string[]

Returns

Promise<SourceVideoPlaylist>

Implementation of

ISourceVideoPlaylist.setVideoPlaylistSources

---

setVolume

setVolume: (value) => Promise<VideoPlaylistSource>

Defined in: core/source/videoplaylist.ts:256

See: #core/IAudio#setVolume setVolume

Parameters

value

number

Returns

Promise<VideoPlaylistSource>

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