MediaSource
Defined in: core/source/media.ts:70
The MediaSource class represents the sources of the media 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 MediaItem class. See: #core/MediaItem Core/MediaItem
Inherits from: #core/Source Core/Source
Basic Usage
Section titled “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.MediaSource) { // Manipulate your media source here sources[i].setSilenceDetectionEnabled(true); } } })})All methods marked as Chainable resolve with the original MediaSource
instance.
Extends
Section titled “Extends”Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new MediaSource(
props?):MediaSource
Defined in: core/source/source.ts:75
Parameters
Section titled “Parameters”props?
Section titled “props?”Returns
Section titled “Returns”MediaSource
Inherited from
Section titled “Inherited from”Properties
Section titled “Properties”getActionAfterPlayback
Section titled “getActionAfterPlayback”getActionAfterPlayback: () =>
Promise<ActionAfterPlayback>
Defined in: core/source/media.ts:149
See: #core/ISourcePlayback#getActionAfterPlayback getActionAfterPlayback
Returns
Section titled “Returns”Promise<ActionAfterPlayback>
Implementation of
Section titled “Implementation of”ISourcePlayback.getActionAfterPlayback
getCuePoints
Section titled “getCuePoints”getCuePoints: () =>
Promise<CuePoint[]>
Defined in: core/source/media.ts:199
See: #core/ISourcePlayback#getCuePoints getCuePoints
Returns
Section titled “Returns”Promise<CuePoint[]>
Implementation of
Section titled “Implementation of”getCustomName
Section titled “getCustomName”getCustomName: () =>
Promise<string>
Defined in: core/source/source.ts:291
See: #core/ISource#getCustomName getCustomName
Returns
Section titled “Returns”Promise<string>
Inherited from
Section titled “Inherited from”getFileInfo
Section titled “getFileInfo”getFileInfo: () =>
Promise<Object>
Defined in: core/source/media.ts:79
See: #core/ISourceMedia#getFileInfo getFileInfo
Returns
Section titled “Returns”Promise<Object>
Implementation of
Section titled “Implementation of”getId: () =>
Promise<string>
Defined in: core/source/source.ts:316
See: #core/ISource#getId getId
Returns
Section titled “Returns”Promise<string>
Inherited from
Section titled “Inherited from”getItemList
Section titled “getItemList”getItemList: () =>
Promise<Item[]>
Defined in: core/source/source.ts:321
See: #core/ISource#getItemList getItemList
Returns
Section titled “Returns”Promise<Item[]>
Inherited from
Section titled “Inherited from”getKeepLoaded
Section titled “getKeepLoaded”getKeepLoaded: () =>
Promise<boolean>
Defined in: core/source/source.ts:306
See: #core/ISource#getKeepLoaded getKeepLoaded
Returns
Section titled “Returns”Promise<boolean>
Inherited from
Section titled “Inherited from”getName
Section titled “getName”getName: () =>
Promise<string>
Defined in: core/source/source.ts:281
See: #core/ISource#getName getName
Returns
Section titled “Returns”Promise<string>
Inherited from
Section titled “Inherited from”getPlaybackDuration
Section titled “getPlaybackDuration”getPlaybackDuration: () =>
Promise<number>
Defined in: core/source/media.ts:114
See: #core/ISourcePlayback#getPlaybackDuration getPlaybackDuration
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”ISourcePlayback.getPlaybackDuration
getPlaybackEndPosition
Section titled “getPlaybackEndPosition”getPlaybackEndPosition: () =>
Promise<number>
Defined in: core/source/media.ts:139
See: #core/ISourcePlayback#getPlaybackEndPosition getPlaybackEndPosition
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”ISourcePlayback.getPlaybackEndPosition
getPlaybackPosition
Section titled “getPlaybackPosition”getPlaybackPosition: () =>
Promise<number>
Defined in: core/source/media.ts:104
See: #core/ISourcePlayback#getPlaybackPosition getPlaybackPosition
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”ISourcePlayback.getPlaybackPosition
getPlaybackStartPosition
Section titled “getPlaybackStartPosition”getPlaybackStartPosition: () =>
Promise<number>
Defined in: core/source/media.ts:129
See: #core/ISourcePlayback#getPlaybackStartPosition getPlaybackStartPosition
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”ISourcePlayback.getPlaybackStartPosition
getType
Section titled “getType”getType: () =>
Promise<ItemTypes>
Defined in: core/source/source.ts:331
See: #core/ISource#getType getType
Returns
Section titled “Returns”Promise<ItemTypes>
Inherited from
Section titled “Inherited from”getValue
Section titled “getValue”getValue: () =>
Promise<string|XML>
Defined in: core/source/source.ts:296
See: #core/ISource#getValue getValue
Returns
Section titled “Returns”Promise<string | XML>
Implementation of
Section titled “Implementation of”Inherited from
Section titled “Inherited from”getVolume
Section titled “getVolume”getVolume: () =>
Promise<number>
Defined in: core/source/media.ts:209
See: #core/IAudio#getVolume getVolume
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”isAudio
Section titled “isAudio”isAudio: () =>
Promise<boolean>
Defined in: core/source/media.ts:89
See: #core/ISourcePlayback#isAudio isAudio
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”isAudioAvailable
Section titled “isAudioAvailable”isAudioAvailable: () =>
Promise<boolean>
Defined in: core/source/media.ts:233
See: #core/IAudio#isAudioAvailable isAudioAvailable
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”isAutoMute
Section titled “isAutoMute”isAutoMute: () =>
Promise<boolean>
Defined in: core/source/media.ts:215
See: #core/IAudio#isAutoMute isAutoMute
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”isAutostartOnSceneLoad
Section titled “isAutostartOnSceneLoad”isAutostartOnSceneLoad: () =>
Promise<boolean>
Defined in: core/source/media.ts:159
See: #core/ISourcePlayback#isAutostartOnSceneLoad isAutostartOnSceneLoad
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”ISourcePlayback.isAutostartOnSceneLoad
isForceDeinterlace
Section titled “isForceDeinterlace”isForceDeinterlace: () =>
Promise<boolean>
Defined in: core/source/media.ts:169
See: #core/ISourcePlayback#isForceDeinterlace isForceDeinterlace
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”ISourcePlayback.isForceDeinterlace
isMute
Section titled “isMute”isMute: () =>
Promise<boolean>
Defined in: core/source/media.ts:212
See: #core/IAudio#isMute isMute
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”isPlaying
Section titled “isPlaying”isPlaying: () =>
Promise<boolean>
Defined in: core/source/media.ts:119
See: #core/ISourcePlayback#isPlaying isPlaying
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”isRememberingPlaybackPosition
Section titled “isRememberingPlaybackPosition”isRememberingPlaybackPosition: () =>
Promise<boolean>
Defined in: core/source/media.ts:179
See: #core/ISourcePlayback#isRememberingPlaybackPosition isRememberingPlaybackPosition
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”ISourcePlayback.isRememberingPlaybackPosition
isSeekable
Section titled “isSeekable”isSeekable: () =>
Promise<boolean>
Defined in: core/source/media.ts:99
See: #core/ISourcePlayback#isSeekable isSeekable
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”isShowingPlaybackPosition
Section titled “isShowingPlaybackPosition”isShowingPlaybackPosition: () =>
Promise<boolean>
Defined in: core/source/media.ts:189
See: #core/ISourcePlayback#isShowingPlaybackPosition isShowingPlaybackPosition
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”ISourcePlayback.isShowingPlaybackPosition
isSourceAvailable
Section titled “isSourceAvailable”isSourceAvailable: () =>
Promise<boolean>
Defined in: core/source/media.ts:84
See: #core/ISourceMedia#isSourceAvailable isSourceAvailable
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”ISourceMedia.isSourceAvailable
isStreamOnlyAudio
Section titled “isStreamOnlyAudio”isStreamOnlyAudio: () =>
Promise<boolean>
Defined in: core/source/media.ts:227
See: #core/IAudio#isStreamOnlyAudio isStreamOnlyAudio
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”isVideo
Section titled “isVideo”isVideo: () =>
Promise<boolean>
Defined in: core/source/media.ts:94
See: #core/ISourcePlayback#isVideo isVideo
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”refresh
Section titled “refresh”refresh: () =>
Promise<Source>
Defined in: core/source/source.ts:326
See: #core/ISource#refresh refresh
Returns
Section titled “Returns”Promise<Source>
Inherited from
Section titled “Inherited from”setActionAfterPlayback
Section titled “setActionAfterPlayback”setActionAfterPlayback: (
value) =>Promise<MediaSource>
Defined in: core/source/media.ts:154
See: #core/ISourcePlayback#setActionAfterPlayback setActionAfterPlayback
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<MediaSource>
Implementation of
Section titled “Implementation of”ISourcePlayback.setActionAfterPlayback
setAutoMute
Section titled “setAutoMute”setAutoMute: (
value) =>Promise<MediaSource>
Defined in: core/source/media.ts:224
See: #core/IAudio#setAutoMute setAutoMute
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<MediaSource>
Implementation of
Section titled “Implementation of”setAutostartOnSceneLoad
Section titled “setAutostartOnSceneLoad”setAutostartOnSceneLoad: (
value) =>Promise<MediaSource>
Defined in: core/source/media.ts:164
See: #core/ISourcePlayback#setAutostartOnSceneLoad setAutostartOnSceneLoad
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<MediaSource>
Implementation of
Section titled “Implementation of”ISourcePlayback.setAutostartOnSceneLoad
setCuePoints
Section titled “setCuePoints”setCuePoints: (
value) =>Promise<MediaSource>
Defined in: core/source/media.ts:204
See: #core/ISourcePlayback#setCuePoints setCuePoints
Parameters
Section titled “Parameters”CuePoint[]
Returns
Section titled “Returns”Promise<MediaSource>
Implementation of
Section titled “Implementation of”setCustomName
Section titled “setCustomName”setCustomName: () =>
Promise<Source>
Defined in: core/source/source.ts:286
See: #core/ISource#setCustomName setCustomName
Returns
Section titled “Returns”Promise<Source>
Inherited from
Section titled “Inherited from”setForceDeinterlace
Section titled “setForceDeinterlace”setForceDeinterlace: (
value) =>Promise<MediaSource>
Defined in: core/source/media.ts:174
See: #core/ISourcePlayback#setForceDeinterlace setForceDeinterlace
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<MediaSource>
Implementation of
Section titled “Implementation of”ISourcePlayback.setForceDeinterlace
setKeepLoaded
Section titled “setKeepLoaded”setKeepLoaded: (
value) =>Promise<Source>
Defined in: core/source/source.ts:311
See: #core/ISource#setKeepLoaded setKeepLoaded
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<Source>
Inherited from
Section titled “Inherited from”setMute
Section titled “setMute”setMute: (
value) =>Promise<MediaSource>
Defined in: core/source/media.ts:221
See: #core/IAudio#setMute setMute
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<MediaSource>
Implementation of
Section titled “Implementation of”setName
Section titled “setName”setName: (
value) =>Promise<Source>
Defined in: core/source/source.ts:276
See: #core/ISource#setName setName
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Source>
Inherited from
Section titled “Inherited from”setPlaybackEndPosition
Section titled “setPlaybackEndPosition”setPlaybackEndPosition: (
value) =>Promise<MediaSource>
Defined in: core/source/media.ts:144
See: #core/ISourcePlayback#setPlaybackEndPosition setPlaybackEndPosition
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<MediaSource>
Implementation of
Section titled “Implementation of”ISourcePlayback.setPlaybackEndPosition
setPlaybackPosition
Section titled “setPlaybackPosition”setPlaybackPosition: (
value) =>Promise<MediaSource>
Defined in: core/source/media.ts:109
See: #core/ISourcePlayback#setPlaybackPosition setPlaybackPosition
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<MediaSource>
Implementation of
Section titled “Implementation of”ISourcePlayback.setPlaybackPosition
setPlaybackStartPosition
Section titled “setPlaybackStartPosition”setPlaybackStartPosition: (
value) =>Promise<MediaSource>
Defined in: core/source/media.ts:134
See: #core/ISourcePlayback#setPlaybackStartPosition setPlaybackStartPosition
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<MediaSource>
Implementation of
Section titled “Implementation of”ISourcePlayback.setPlaybackStartPosition
setPlaying
Section titled “setPlaying”setPlaying: (
value) =>Promise<MediaSource>
Defined in: core/source/media.ts:124
See: #core/ISourcePlayback#setPlaying setPlaying
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<MediaSource>
Implementation of
Section titled “Implementation of”setRememberingPlaybackPosition
Section titled “setRememberingPlaybackPosition”setRememberingPlaybackPosition: (
value) =>Promise<MediaSource>
Defined in: core/source/media.ts:184
See: #core/ISourcePlayback#setRememberingPlaybackPosition setRememberingPlaybackPosition
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<MediaSource>
Implementation of
Section titled “Implementation of”ISourcePlayback.setRememberingPlaybackPosition
setShowingPlaybackPosition
Section titled “setShowingPlaybackPosition”setShowingPlaybackPosition: (
value) =>Promise<MediaSource>
Defined in: core/source/media.ts:194
See: #core/ISourcePlayback#setShowingPlaybackPosition setShowingPlaybackPosition
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<MediaSource>
Implementation of
Section titled “Implementation of”ISourcePlayback.setShowingPlaybackPosition
setStreamOnlyAudio
Section titled “setStreamOnlyAudio”setStreamOnlyAudio: (
value) =>Promise<MediaSource>
Defined in: core/source/media.ts:230
See: #core/IAudio#setStreamOnlyAudio setStreamOnlyAudio
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<MediaSource>
Implementation of
Section titled “Implementation of”setValue
Section titled “setValue”setValue: (
value) =>Promise<Source>
Defined in: core/source/source.ts:301
See: #core/ISource#setValue setValue
Parameters
Section titled “Parameters”string | XML
Returns
Section titled “Returns”Promise<Source>
Implementation of
Section titled “Implementation of”Inherited from
Section titled “Inherited from”setVolume
Section titled “setVolume”setVolume: (
value) =>Promise<MediaSource>
Defined in: core/source/media.ts:218
See: #core/IAudio#setVolume setVolume
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<MediaSource>
Implementation of
Section titled “Implementation of”Methods
Section titled “Methods”getAllSources()
Section titled “getAllSources()”
staticgetAllSources():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.
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
Section titled “Returns”Promise<Source[]>
Inherited from
Section titled “Inherited from”getCurrentSource()
Section titled “getCurrentSource()”
staticgetCurrentSource():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)
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
Section titled “Returns”Promise<Source>
Inherited from
Section titled “Inherited from”getItemList()
Section titled “getItemList()”
staticgetItemList():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.
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
Section titled “Returns”Promise<Item[]>