VideoPlaylistItem
Defined in: core/items/videoplaylist.ts:62
The VideoPlaylistItem class represents the VideoPlaylist item that has been added to the stage.
Inherits from: #core/Item Core/Item
Implements: #core/IItemChroma Core/IItemChroma, #core/IItemColor Core/IItemColor, #core/IItemLayout Core/IItemLayout, #core/IItemTransition Core/IItemTransition, #core/ISourceConfigurable Core/ISourceConfigurable, #core/IAudio Core/IAudio
Basic Usage
Section titled “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.VideoPlaylistItem) { // Manipulate your VideoPlaylist Item here } } });});Extends
Section titled “Extends”Implements
Section titled “Implements”IItemLayoutIItemColorIItemChromaIItemTransitionISourceConfigurableISourceVideoPlaylistISourcePlaybackIAudio
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new VideoPlaylistItem(
props?):VideoPlaylistItem
Defined in: core/items/item.ts:88
Parameters
Section titled “Parameters”props?
Section titled “props?”Returns
Section titled “Returns”VideoPlaylistItem
Inherited from
Section titled “Inherited from”Properties
Section titled “Properties”applyConfig
Section titled “applyConfig”applyConfig: (
configObj) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:499
See: #core/ISourceConfigurable#applyConfig applyConfig
Parameters
Section titled “Parameters”configObj
Section titled “configObj”any
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”ISourceConfigurable.applyConfig
bringForward
Section titled “bringForward”bringForward: () =>
Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:103
See: #core/IItemLayout#bringForward bringForward
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”bringToFront
Section titled “bringToFront”bringToFront: () =>
Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:108
See: #core/IItemLayout#bringToFront bringToFront
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”getActionAfterPlayback
Section titled “getActionAfterPlayback”getActionAfterPlayback: () =>
Promise<ActionAfterPlayback>
Defined in: core/items/videoplaylist.ts:556
See: #core/ISourcePlayback#getActionAfterPlayback getActionAfterPlayback
Returns
Section titled “Returns”Promise<ActionAfterPlayback>
Implementation of
Section titled “Implementation of”ISourcePlayback.getActionAfterPlayback
getBorderColor
Section titled “getBorderColor”getBorderColor: () =>
Promise<Color>
Defined in: core/items/videoplaylist.ts:255
See: #core/IItemColor#getBorderColor getBorderColor
Returns
Section titled “Returns”Promise<Color>
Implementation of
Section titled “Implementation of”getBrightness
Section titled “getBrightness”getBrightness: () =>
Promise<number>
Defined in: core/items/videoplaylist.ts:235
See: #core/IItemColor#getBrightness getBrightness
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”getCanvasRotate
Section titled “getCanvasRotate”getCanvasRotate: () =>
Promise<number>
Defined in: core/items/videoplaylist.ts:128
See: #core/IItemLayout#getCanvasRotate getCanvasRotate
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”getChromaAntiAliasLevel
Section titled “getChromaAntiAliasLevel”getChromaAntiAliasLevel: () =>
Promise<ChromaAntiAliasLevel>
Defined in: core/items/videoplaylist.ts:324
See: #core/IItemChroma#getChromaAntiAliasLevel getChromaAntiAliasLevel
Returns
Section titled “Returns”Promise<ChromaAntiAliasLevel>
Implementation of
Section titled “Implementation of”IItemChroma.getChromaAntiAliasLevel
getChromaColorKeyColor
Section titled “getChromaColorKeyColor”getChromaColorKeyColor: () =>
Promise<Color>
Defined in: core/items/videoplaylist.ts:440
See: #core/IItemChroma#getChromaColorKeyColor getChromaColorKeyColor
Returns
Section titled “Returns”Promise<Color>
Implementation of
Section titled “Implementation of”IItemChroma.getChromaColorKeyColor
getChromaColorKeyExposure
Section titled “getChromaColorKeyExposure”getChromaColorKeyExposure: () =>
Promise<number>
Defined in: core/items/videoplaylist.ts:430
See: #core/IItemChroma#getChromaColorKeyExposure getChromaColorKeyExposure
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemChroma.getChromaColorKeyExposure
getChromaColorKeyThreshold
Section titled “getChromaColorKeyThreshold”getChromaColorKeyThreshold: () =>
Promise<number>
Defined in: core/items/videoplaylist.ts:420
See: #core/IItemChroma#getChromaColorKeyThreshold getChromaColorKeyThreshold
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemChroma.getChromaColorKeyThreshold
getChromaLegacyAlphaSmoothing
Section titled “getChromaLegacyAlphaSmoothing”getChromaLegacyAlphaSmoothing: () =>
Promise<number>
Defined in: core/items/videoplaylist.ts:376
See: #core/IItemChroma#getChromaLegacyAlphaSmoothing getChromaLegacyAlphaSmoothing
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemChroma.getChromaLegacyAlphaSmoothing
getChromaLegacyBrightness
Section titled “getChromaLegacyBrightness”getChromaLegacyBrightness: () =>
Promise<number>
Defined in: core/items/videoplaylist.ts:336
See: #core/IItemChroma#getChromaLegacyBrightness getChromaLegacyBrightness
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemChroma.getChromaLegacyBrightness
getChromaLegacyHue
Section titled “getChromaLegacyHue”getChromaLegacyHue: () =>
Promise<number>
Defined in: core/items/videoplaylist.ts:356
See: #core/IItemChroma#getChromaLegacyHue getChromaLegacyHue
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemChroma.getChromaLegacyHue
getChromaLegacySaturation
Section titled “getChromaLegacySaturation”getChromaLegacySaturation: () =>
Promise<number>
Defined in: core/items/videoplaylist.ts:346
See: #core/IItemChroma#getChromaLegacySaturation getChromaLegacySaturation
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemChroma.getChromaLegacySaturation
getChromaLegacyThreshold
Section titled “getChromaLegacyThreshold”getChromaLegacyThreshold: () =>
Promise<number>
Defined in: core/items/videoplaylist.ts:366
See: #core/IItemChroma#getChromaLegacyThreshold getChromaLegacyThreshold
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemChroma.getChromaLegacyThreshold
getChromaRGBKeyExposure
Section titled “getChromaRGBKeyExposure”getChromaRGBKeyExposure: () =>
Promise<number>
Defined in: core/items/videoplaylist.ts:408
See: #core/IItemChroma#getChromaRGBKeyExposure getChromaRGBKeyExposure
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemChroma.getChromaRGBKeyExposure
getChromaRGBKeyPrimaryColor
Section titled “getChromaRGBKeyPrimaryColor”getChromaRGBKeyPrimaryColor: () =>
Promise<ChromaPrimaryColors>
Defined in: core/items/videoplaylist.ts:388
See: #core/IItemChroma#getChromaRGBKeyPrimaryColor getChromaRGBKeyPrimaryColor
Returns
Section titled “Returns”Promise<ChromaPrimaryColors>
Implementation of
Section titled “Implementation of”IItemChroma.getChromaRGBKeyPrimaryColor
getChromaRGBKeyThreshold
Section titled “getChromaRGBKeyThreshold”getChromaRGBKeyThreshold: () =>
Promise<number>
Defined in: core/items/videoplaylist.ts:398
See: #core/IItemChroma#getChromaRGBKeyThreshold getChromaRGBKeyThreshold
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemChroma.getChromaRGBKeyThreshold
getContrast
Section titled “getContrast”getContrast: () =>
Promise<number>
Defined in: core/items/videoplaylist.ts:240
See: #core/IItemColor#getContrast getContrast
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”getCropping
Section titled “getCropping”getCropping: () =>
Promise<Object>
Defined in: core/items/videoplaylist.ts:133
See: #core/IItemLayout#getCropping getCropping
Returns
Section titled “Returns”Promise<Object>
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”getCuePoints
Section titled “getCuePoints”getCuePoints: () =>
Promise<CuePoint[]>
Defined in: core/items/videoplaylist.ts:606
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/items/item.ts:758
See: #core/Source#getCustomName getCustomName
Returns
Section titled “Returns”Promise<string>
Inherited from
Section titled “Inherited from”getEnhancedRotate
Section titled “getEnhancedRotate”getEnhancedRotate: () =>
Promise<number>
Defined in: core/items/videoplaylist.ts:138
See: #core/IItemLayout#getEnhancedRotate getEnhancedRotate
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”getHue
Section titled “getHue”getHue: () =>
Promise<number>
Defined in: core/items/videoplaylist.ts:245
See: #core/IItemColor#getHue getHue
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”getId: () =>
Promise<string>
Defined in: core/items/item.ts:267
return: Promise
Get the ID of the Item
item.getId().then(function(id) { // The rest of your code here});Returns
Section titled “Returns”Promise<string>
Inherited from
Section titled “Inherited from”getItemList
Section titled “getItemList”getItemList: () =>
Promise<Item[]>
Defined in: core/items/item.ts:513
See: #core/Source#getItemList getItemList
Returns
Section titled “Returns”Promise<Item[]>
Inherited from
Section titled “Inherited from”getKeepLoaded
Section titled “getKeepLoaded”getKeepLoaded: () =>
Promise<boolean>
Defined in: core/items/item.ts:773
See: #core/Source#getKeepLoaded getKeepLoaded
Returns
Section titled “Returns”Promise<boolean>
Inherited from
Section titled “Inherited from”getKeyingType
Section titled “getKeyingType”getKeyingType: () =>
Promise<KeyingType>
Defined in: core/items/videoplaylist.ts:312
See: #core/IItemChroma#getKeyingType getKeyingType
Returns
Section titled “Returns”Promise<KeyingType>
Implementation of
Section titled “Implementation of”getName
Section titled “getName”getName: () =>
Promise<string>
Defined in: core/items/item.ts:748
See: #core/Source#getName getName
Returns
Section titled “Returns”Promise<string>
Inherited from
Section titled “Inherited from”getPlaybackDuration
Section titled “getPlaybackDuration”getPlaybackDuration: () =>
Promise<number>
Defined in: core/items/videoplaylist.ts:521
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/items/videoplaylist.ts:546
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/items/videoplaylist.ts:511
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/items/videoplaylist.ts:536
See: #core/ISourcePlayback#getPlaybackStartPosition getPlaybackStartPosition
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”ISourcePlayback.getPlaybackStartPosition
getPosition
Section titled “getPosition”getPosition: () =>
Promise<Rectangle>
Defined in: core/items/videoplaylist.ts:143
See: #core/IItemLayout#getPosition getPosition
Returns
Section titled “Returns”Promise<Rectangle>
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”getRotateX
Section titled “getRotateX”getRotateX: () =>
Promise<number>
Defined in: core/items/videoplaylist.ts:153
See: #core/IItemLayout#getRotateX getRotateX
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”getRotateY
Section titled “getRotateY”getRotateY: () =>
Promise<number>
Defined in: core/items/videoplaylist.ts:148
See: #core/IItemLayout#getRotateY getRotateY
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”getRotateZ
Section titled “getRotateZ”getRotateZ: () =>
Promise<number>
Defined in: core/items/videoplaylist.ts:158
See: #core/IItemLayout#getRotateZ getRotateZ
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”getSaturation
Section titled “getSaturation”getSaturation: () =>
Promise<number>
Defined in: core/items/videoplaylist.ts:250
See: #core/IItemColor#getSaturation getSaturation
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”getTransition
Section titled “getTransition”getTransition: () =>
Promise<Transition>
Defined in: core/items/videoplaylist.ts:462
See: #core/IItemTransition#getTransition getTransition
Returns
Section titled “Returns”Promise<Transition>
Implementation of
Section titled “Implementation of”getTransitionTime
Section titled “getTransitionTime”getTransitionTime: () =>
Promise<number>
Defined in: core/items/videoplaylist.ts:472
See: #core/IItemTransition#getTransitionTime getTransitionTime
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemTransition.getTransitionTime
getTransparency
Section titled “getTransparency”getTransparency: () =>
Promise<number>
Defined in: core/items/videoplaylist.ts:230
See: #core/IItemColor#getTransparency getTransparency
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”getType
Section titled “getType”getType: () =>
Promise<ItemTypes>
Defined in: core/items/item.ts:786
See: #core/Source#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/items/item.ts:763
See: #core/Source#getValue getValue
Returns
Section titled “Returns”Promise<string | XML>
Implementation of
Section titled “Implementation of”Inherited from
Section titled “Inherited from”getVideoNowPlaying
Section titled “getVideoNowPlaying”getVideoNowPlaying: () =>
Promise<string>
Defined in: core/items/videoplaylist.ts:78
See: #core/VideoPlaylistSource#getVideoNowPlaying getVideoNowPlaying
Returns
Section titled “Returns”Promise<string>
Implementation of
Section titled “Implementation of”ISourceVideoPlaylist.getVideoNowPlaying
getVideoPlaylistSources
Section titled “getVideoPlaylistSources”getVideoPlaylistSources: () =>
Promise<string[]>
Defined in: core/items/videoplaylist.ts:88
See: #core/VideoPlaylistSource#getVideoPlaylistSources getVideoPlaylistSources
Returns
Section titled “Returns”Promise<string[]>
Implementation of
Section titled “Implementation of”ISourceVideoPlaylist.getVideoPlaylistSources
getVolume
Section titled “getVolume”getVolume: () =>
Promise<number>
Defined in: core/items/videoplaylist.ts:630
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/items/videoplaylist.ts:620
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/items/videoplaylist.ts:654
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/items/videoplaylist.ts:636
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/items/videoplaylist.ts:566
See: #core/ISourcePlayback#isAutostartOnSceneLoad isAutostartOnSceneLoad
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”ISourcePlayback.isAutostartOnSceneLoad
isChromaEnabled
Section titled “isChromaEnabled”isChromaEnabled: () =>
Promise<boolean>
Defined in: core/items/videoplaylist.ts:302
See: #core/IItemChroma#isChromaEnabled isChromaEnabled
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”isEnhancedResizeEnabled
Section titled “isEnhancedResizeEnabled”isEnhancedResizeEnabled: () =>
Promise<boolean>
Defined in: core/items/videoplaylist.ts:123
See: #core/IItemLayout#isEnhancedResizeEnabled isEnhancedResizeEnabled
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”IItemLayout.isEnhancedResizeEnabled
Overrides
Section titled “Overrides”isForceDeinterlace
Section titled “isForceDeinterlace”isForceDeinterlace: () =>
Promise<boolean>
Defined in: core/items/videoplaylist.ts:576
See: #core/ISourcePlayback#isForceDeinterlace isForceDeinterlace
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”ISourcePlayback.isForceDeinterlace
isFullDynamicColorRange
Section titled “isFullDynamicColorRange”isFullDynamicColorRange: () =>
Promise<boolean>
Defined in: core/items/videoplaylist.ts:260
See: #core/IItemColor#isFullDynamicColorRange isFullDynamicColorRange
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”IItemColor.isFullDynamicColorRange
isKeepAspectRatio
Section titled “isKeepAspectRatio”isKeepAspectRatio: () =>
Promise<boolean>
Defined in: core/items/videoplaylist.ts:113
See: #core/IItemLayout#isKeepAspectRatio isKeepAspectRatio
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”isMute
Section titled “isMute”isMute: () =>
Promise<boolean>
Defined in: core/items/videoplaylist.ts:633
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/items/videoplaylist.ts:526
See: #core/ISourcePlayback#isPlaying isPlaying
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”isPositionLocked
Section titled “isPositionLocked”isPositionLocked: () =>
Promise<boolean>
Defined in: core/items/videoplaylist.ts:118
See: #core/IItemLayout#isPositionLocked isPositionLocked
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”isRememberingPlaybackPosition
Section titled “isRememberingPlaybackPosition”isRememberingPlaybackPosition: () =>
Promise<boolean>
Defined in: core/items/videoplaylist.ts:586
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/items/videoplaylist.ts:506
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/items/videoplaylist.ts:596
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/items/videoplaylist.ts:96
See: #core/VideoPlaylistSource#isSourceAvailable isSourceAvailable
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”ISourceVideoPlaylist.isSourceAvailable
isStreamOnlyAudio
Section titled “isStreamOnlyAudio”isStreamOnlyAudio: () =>
Promise<boolean>
Defined in: core/items/videoplaylist.ts:648
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/items/videoplaylist.ts:625
See: #core/ISourcePlayback#isVideo isVideo
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”isVisible
Section titled “isVisible”isVisible: () =>
Promise<boolean>
Defined in: core/items/videoplaylist.ts:452
See: #core/IItemTransition#isVisible isVisible
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”loadConfig
Section titled “loadConfig”loadConfig: () =>
Promise<any>
Defined in: core/items/videoplaylist.ts:484
See: #core/ISourceConfigurable#loadConfig loadConfig
Returns
Section titled “Returns”Promise<any>
Implementation of
Section titled “Implementation of”ISourceConfigurable.loadConfig
refresh
Section titled “refresh”refresh: () =>
Promise<Source>
Defined in: core/items/item.ts:783
See: #core/Source#refresh refresh
Returns
Section titled “Returns”Promise<Source>
Inherited from
Section titled “Inherited from”requestSaveConfig
Section titled “requestSaveConfig”requestSaveConfig: (
configObj) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:494
See: #core/ISourceConfigurable#requestSaveConfig requestSaveConfig
Parameters
Section titled “Parameters”configObj
Section titled “configObj”any
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”ISourceConfigurable.requestSaveConfig
saveConfig
Section titled “saveConfig”saveConfig: (
configObj) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:489
See: #core/ISourceConfigurable#saveConfig saveConfig
Parameters
Section titled “Parameters”configObj
Section titled “configObj”any
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”ISourceConfigurable.saveConfig
sendBackward
Section titled “sendBackward”sendBackward: () =>
Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:163
See: #core/IItemLayout#sendBackward sendBackward
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”sendToBack
Section titled “sendToBack”sendToBack: () =>
Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:168
See: #core/IItemLayout#sendToBack sendToBack
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”setActionAfterPlayback
Section titled “setActionAfterPlayback”setActionAfterPlayback: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:561
See: #core/ISourcePlayback#setActionAfterPlayback setActionAfterPlayback
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”ISourcePlayback.setActionAfterPlayback
setAutoMute
Section titled “setAutoMute”setAutoMute: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:645
See: #core/IAudio#setAutoMute setAutoMute
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”setAutostartOnSceneLoad
Section titled “setAutostartOnSceneLoad”setAutostartOnSceneLoad: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:571
See: #core/ISourcePlayback#setAutostartOnSceneLoad setAutostartOnSceneLoad
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”ISourcePlayback.setAutostartOnSceneLoad
setBorderColor
Section titled “setBorderColor”setBorderColor: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:290
See: #core/IItemColor#setBorderColor setBorderColor
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”setBrightness
Section titled “setBrightness”setBrightness: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:270
See: #core/IItemColor#setBrightness setBrightness
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”setCanvasRotate
Section titled “setCanvasRotate”setCanvasRotate: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:173
See: #core/IItemLayout#setCanvasRotate setCanvasRotate
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”setChromaAntiAliasLevel
Section titled “setChromaAntiAliasLevel”setChromaAntiAliasLevel: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:329
See: #core/IItemChroma#setChromaAntiAliasLevel setChromaAntiAliasLevel
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaAntiAliasLevel
setChromaColorKeyColor
Section titled “setChromaColorKeyColor”setChromaColorKeyColor: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:445
See: #core/IItemChroma#setChromaColorKeyColor setChromaColorKeyColor
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaColorKeyColor
setChromaColorKeyExposure
Section titled “setChromaColorKeyExposure”setChromaColorKeyExposure: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:435
See: #core/IItemChroma#setChromaColorKeyExposure setChromaColorKeyExposure
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaColorKeyExposure
setChromaColorKeyThreshold
Section titled “setChromaColorKeyThreshold”setChromaColorKeyThreshold: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:425
See: #core/IItemChroma#setChromaColorKeyThreshold setChromaColorKeyThreshold
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaColorKeyThreshold
setChromaEnabled
Section titled “setChromaEnabled”setChromaEnabled: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:307
See: #core/IItemChroma#setChromaEnabled setChromaEnabled
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”setChromaLegacyAlphaSmoothing
Section titled “setChromaLegacyAlphaSmoothing”setChromaLegacyAlphaSmoothing: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:381
See: #core/IItemChroma#setChromaLegacyAlphaSmoothing setChromaLegacyAlphaSmoothing
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaLegacyAlphaSmoothing
setChromaLegacyBrightness
Section titled “setChromaLegacyBrightness”setChromaLegacyBrightness: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:341
See: #core/IItemChroma#setChromaLegacyBrightness setChromaLegacyBrightness
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaLegacyBrightness
setChromaLegacyHue
Section titled “setChromaLegacyHue”setChromaLegacyHue: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:361
See: #core/IItemChroma#setChromaLegacyHue setChromaLegacyHue
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaLegacyHue
setChromaLegacySaturation
Section titled “setChromaLegacySaturation”setChromaLegacySaturation: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:351
See: #core/IItemChroma#setChromaLegacySaturation setChromaLegacySaturation
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaLegacySaturation
setChromaLegacyThreshold
Section titled “setChromaLegacyThreshold”setChromaLegacyThreshold: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:371
See: #core/IItemChroma#setChromaLegacyThreshold setChromaLegacyThreshold
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaLegacyThreshold
setChromaRGBKeyExposure
Section titled “setChromaRGBKeyExposure”setChromaRGBKeyExposure: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:413
See: #core/IItemChroma#setChromaRGBKeyExposure setChromaRGBKeyExposure
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaRGBKeyExposure
setChromaRGBKeyPrimaryColor
Section titled “setChromaRGBKeyPrimaryColor”setChromaRGBKeyPrimaryColor: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:393
See: #core/IItemChroma#setChromaRGBKeyPrimaryColor setChromaRGBKeyPrimaryColor
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaRGBKeyPrimaryColor
setChromaRGBKeyThreshold
Section titled “setChromaRGBKeyThreshold”setChromaRGBKeyThreshold: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:403
See: #core/IItemChroma#setChromaRGBKeyThreshold setChromaRGBKeyThreshold
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaRGBKeyThreshold
setContrast
Section titled “setContrast”setContrast: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:275
See: #core/IItemColor#setContrast setContrast
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”setCropping
Section titled “setCropping”setCropping: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:178
See: #core/IItemLayout#setCropping setCropping
Parameters
Section titled “Parameters”Object
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”setCroppingEnhanced
Section titled “setCroppingEnhanced”setCroppingEnhanced: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:183
See: #core/IItemLayout#setCroppingEnhanced setCroppingEnhanced
Parameters
Section titled “Parameters”Object
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”IItemLayout.setCroppingEnhanced
Overrides
Section titled “Overrides”setCuePoints
Section titled “setCuePoints”setCuePoints: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:611
See: #core/ISourcePlayback#setCuePoints setCuePoints
Parameters
Section titled “Parameters”CuePoint[]
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”setCustomName
Section titled “setCustomName”setCustomName: () =>
Promise<Item>
Defined in: core/items/item.ts:753
See: #core/Source#setCustomName setCustomName
Returns
Section titled “Returns”Promise<Item>
Inherited from
Section titled “Inherited from”setEnhancedResizeEnabled
Section titled “setEnhancedResizeEnabled”setEnhancedResizeEnabled: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:203
See: #core/IItemLayout#setEnhancedResizeEnabled setEnhancedResizeEnabled
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”IItemLayout.setEnhancedResizeEnabled
Overrides
Section titled “Overrides”setEnhancedRotate
Section titled “setEnhancedRotate”setEnhancedRotate: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:188
See: #core/IItemLayout#setEnhancedRotate setEnhancedRotate
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”setForceDeinterlace
Section titled “setForceDeinterlace”setForceDeinterlace: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:581
See: #core/ISourcePlayback#setForceDeinterlace setForceDeinterlace
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”ISourcePlayback.setForceDeinterlace
setFullDynamicColorRange
Section titled “setFullDynamicColorRange”setFullDynamicColorRange: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:295
See: #core/IItemColor#setFullDynamicColorRange setFullDynamicColorRange
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”IItemColor.setFullDynamicColorRange
setHue
Section titled “setHue”setHue: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:280
See: #core/IItemColor#setHue setHue
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”setKeepAspectRatio
Section titled “setKeepAspectRatio”setKeepAspectRatio: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:193
See: #core/IItemLayout#setKeepAspectRatio setKeepAspectRatio
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”IItemLayout.setKeepAspectRatio
Overrides
Section titled “Overrides”setKeepLoaded
Section titled “setKeepLoaded”setKeepLoaded: (
value) =>Promise<Item>
Defined in: core/items/item.ts:778
See: #core/Source#setKeepLoaded setKeepLoaded
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<Item>
Inherited from
Section titled “Inherited from”setKeyingType
Section titled “setKeyingType”setKeyingType: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:317
See: #core/IItemChroma#setKeyingType setKeyingType
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”setMute
Section titled “setMute”setMute: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:642
See: #core/IAudio#setMute setMute
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”setName
Section titled “setName”setName: (
value) =>Promise<Item>
Defined in: core/items/item.ts:743
See: #core/Source#setName setName
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Item>
Inherited from
Section titled “Inherited from”setPlaybackEndPosition
Section titled “setPlaybackEndPosition”setPlaybackEndPosition: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:551
See: #core/ISourcePlayback#setPlaybackEndPosition setPlaybackEndPosition
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”ISourcePlayback.setPlaybackEndPosition
setPlaybackPosition
Section titled “setPlaybackPosition”setPlaybackPosition: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:516
See: #core/ISourcePlayback#setPlaybackPosition setPlaybackPosition
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”ISourcePlayback.setPlaybackPosition
setPlaybackStartPosition
Section titled “setPlaybackStartPosition”setPlaybackStartPosition: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:541
See: #core/ISourcePlayback#setPlaybackStartPosition setPlaybackStartPosition
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”ISourcePlayback.setPlaybackStartPosition
setPlaying
Section titled “setPlaying”setPlaying: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:531
See: #core/ISourcePlayback#setPlaying setPlaying
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”setPosition
Section titled “setPosition”setPosition: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:208
See: #core/IItemLayout#setPosition setPosition
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”setPositionLocked
Section titled “setPositionLocked”setPositionLocked: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:198
See: #core/IItemLayout#setPositionLocked setPositionLocked
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”setRememberingPlaybackPosition
Section titled “setRememberingPlaybackPosition”setRememberingPlaybackPosition: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:591
See: #core/ISourcePlayback#setRememberingPlaybackPosition setRememberingPlaybackPosition
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”ISourcePlayback.setRememberingPlaybackPosition
setRotateX
Section titled “setRotateX”setRotateX: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:218
See: #core/IItemLayout#setRotateX setRotateX
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”setRotateY
Section titled “setRotateY”setRotateY: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:213
See: #core/IItemLayout#setRotateY setRotateY
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”setRotateZ
Section titled “setRotateZ”setRotateZ: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:223
See: #core/IItemLayout#setRotateZ setRotateZ
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”setSaturation
Section titled “setSaturation”setSaturation: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:285
See: #core/IItemColor#setSaturation setSaturation
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”setShowingPlaybackPosition
Section titled “setShowingPlaybackPosition”setShowingPlaybackPosition: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:601
See: #core/ISourcePlayback#setShowingPlaybackPosition setShowingPlaybackPosition
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”ISourcePlayback.setShowingPlaybackPosition
setStreamOnlyAudio
Section titled “setStreamOnlyAudio”setStreamOnlyAudio: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:651
See: #core/IAudio#setStreamOnlyAudio setStreamOnlyAudio
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”setTransition
Section titled “setTransition”setTransition: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:467
See: #core/IItemTransition#setTransition setTransition
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”setTransitionTime
Section titled “setTransitionTime”setTransitionTime: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:477
See: #core/IItemTransition#setTransitionTime setTransitionTime
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”IItemTransition.setTransitionTime
setTransparency
Section titled “setTransparency”setTransparency: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:265
See: #core/IItemColor#setTransparency setTransparency
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”setValue
Section titled “setValue”setValue: (
value) =>Promise<Item>
Defined in: core/items/item.ts:768
See: #core/Source#setValue setValue
Parameters
Section titled “Parameters”string | XML
Returns
Section titled “Returns”Promise<Item>
Implementation of
Section titled “Implementation of”Inherited from
Section titled “Inherited from”setVideoNowPlaying
Section titled “setVideoNowPlaying”setVideoNowPlaying: (
value) =>Promise<SourceVideoPlaylist>
Defined in: core/items/videoplaylist.ts:83
See: #core/VideoPlaylistSource#setVideoNowPlaying setVideoNowPlaying
Parameters
Section titled “Parameters”string | number
Returns
Section titled “Returns”Promise<SourceVideoPlaylist>
Implementation of
Section titled “Implementation of”ISourceVideoPlaylist.setVideoNowPlaying
setVideoPlaylistSources
Section titled “setVideoPlaylistSources”setVideoPlaylistSources: (
fileItems) =>Promise<SourceVideoPlaylist>
Defined in: core/items/videoplaylist.ts:93
See: #core/VideoPlaylistSource#setVideoPlaylistSources setVideoPlaylistSources
Parameters
Section titled “Parameters”fileItems
Section titled “fileItems”string[]
Returns
Section titled “Returns”Promise<SourceVideoPlaylist>
Implementation of
Section titled “Implementation of”ISourceVideoPlaylist.setVideoPlaylistSources
setVisible
Section titled “setVisible”setVisible: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:457
See: #core/IItemTransition#setVisible setVisible
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”setVolume
Section titled “setVolume”setVolume: (
value) =>Promise<VideoPlaylistItem>
Defined in: core/items/videoplaylist.ts:639
See: #core/IAudio#setVolume setVolume
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<VideoPlaylistItem>
Implementation of
Section titled “Implementation of”_emitter
Section titled “_emitter”
static_emitter:EventEmitter
Defined in: core/items/item.ts:85
Inherited from
Section titled “Inherited from”_subscriptions
Section titled “_subscriptions”
static_subscriptions:any[] =[]
Defined in: core/items/item.ts:86
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”duplicate()
Section titled “duplicate()”duplicate(
options?):Promise<Item>
Defined in: core/items/item.ts:416
param: (options: {linked?:
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
// item pertains to an actual Item instance// Sample 1item.duplicate() // duplicate selected item to the current scene as unlinkedDuplicate the selected item to a specific scene and set it to be linked to a single source with the original item.
// Sample 2var toScene = xjs.Scene.getById(2)item.duplicate({linked:true, scene:toScene})Parameters
Section titled “Parameters”options?
Section titled “options?”linked?
Section titled “linked?”boolean
scene?
Section titled “scene?”number | Scene
Returns
Section titled “Returns”Promise<Item>
Inherited from
Section titled “Inherited from”getFPS()
Section titled “getFPS()”getFPS():
Promise<number>
Defined in: core/items/item.ts:282
return: Promise
Get the frames rendered per second of an item
item.getFPS().then(function(fps) { // The rest of your code here});Returns
Section titled “Returns”Promise<number>
Inherited from
Section titled “Inherited from”getParentItem()
Section titled “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
item.getParentItem().then(function(parentItem) { console.log(parentItem);});Returns
Section titled “Returns”Promise<Item>
Inherited from
Section titled “Inherited from”getSceneId()
Section titled “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
source.getSceneId().then(function(id) { // The rest of your code here});Returns
Section titled “Returns”Promise<string | number>
Inherited from
Section titled “Inherited from”getSource()
Section titled “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
item.getSource().then(function(source) { //Manipulate source here source.setName('New Name')})Returns
Section titled “Returns”Promise<Source>
Inherited from
Section titled “Inherited from”getView()
Section titled “getView()”getView():
Promise<ViewTypes>
Defined in: core/items/item.ts:320
return: Promise
Get the view type of the item
item.getView().then(function(view) { // view values: // 0 = main view // 1 = preview editor // 2 = thumbnail preview})Returns
Section titled “Returns”Promise<ViewTypes>
Inherited from
Section titled “Inherited from”isChildItem()
Section titled “isChildItem()”isChildItem():
Promise<boolean>
Defined in: core/items/item.ts:558
return: Promise
Checks if item is part of a group
item.isChildItem().then(function(isChild) { console.log(isChild);});Returns
Section titled “Returns”Promise<boolean>
Inherited from
Section titled “Inherited from”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:
Section titled “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
Section titled “Parameters”string
handler
Section titled “handler”Function
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”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:
Section titled “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
Section titled “Parameters”string
handler
Section titled “handler”Function
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”remove()
Section titled “remove()”remove():
Promise<boolean>
Defined in: core/items/item.ts:504
return: Promise
Removes selected item
item.remove()Returns
Section titled “Returns”Promise<boolean>
Inherited from
Section titled “Inherited from”toXML()
Section titled “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.
var xml = item.toXML();Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”unlink()
Section titled “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.
item.unlink()Note: Once you unlink an Item, there’s still no method to reverse the process.
Returns
Section titled “Returns”Promise<Item>
Inherited from
Section titled “Inherited from”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/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.
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
Section titled “Returns”Promise<Item[]>