FlashItem
Defined in: core/items/flash.ts:46
The FlashItem class represents a flash item, which is any SWF file loaded to XSplit Broadcaster.
Inherits from: #core/Item Core/Item
Implements: #core/IItemChroma Core/IItemChroma, #core/IItemColor Core/IItemColor, #core/IItemLayout Core/IItemLayout, #core/IItemTransition Core/IItemTransition, #core/IAudio Core/IAudio, #core/IItemEffect Core/IItemEffect
All methods marked as Chainable resolve with the original FlashItem
instance. Also, any audio setting, i.e. volume, mute, stream only
may not be properly reflected in the item unless native flash audio support
is enabled. (Tools menu > General Settings > Advanced tab)
Extends
Section titled “Extends”Implements
Section titled “Implements”IItemLayoutIItemColorIItemChromaIItemTransitionIAudioIItemEffectISourceFlash
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new FlashItem(
props?):FlashItem
Defined in: core/items/item.ts:88
Parameters
Section titled “Parameters”props?
Section titled “props?”Returns
Section titled “Returns”FlashItem
Inherited from
Section titled “Inherited from”Properties
Section titled “Properties”bringForward
Section titled “bringForward”bringForward: () =>
Promise<FlashItem>
Defined in: core/items/flash.ts:78
See: #core/IItemLayout#bringForward bringForward
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemLayout.bringForward
Overrides
Section titled “Overrides”bringToFront
Section titled “bringToFront”bringToFront: () =>
Promise<FlashItem>
Defined in: core/items/flash.ts:83
See: #core/IItemLayout#bringToFront bringToFront
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemLayout.bringToFront
Overrides
Section titled “Overrides”getAllowRightClick
Section titled “getAllowRightClick”getAllowRightClick: () =>
Promise<boolean>
Defined in: core/items/flash.ts:66
See: #core/FlashSource#getAllowRightClick getAllowRightClick
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”ISourceFlash.getAllowRightClick
getBorderColor
Section titled “getBorderColor”getBorderColor: () =>
Promise<Color>
Defined in: core/items/flash.ts:231
See: #core/IItemColor#getBorderColor getBorderColor
Returns
Section titled “Returns”Promise<Color>
Implementation of
Section titled “Implementation of”IItemColor.getBorderColor
getBorderEffectColor
Section titled “getBorderEffectColor”getBorderEffectColor: () =>
Promise<Color>
Defined in: core/items/flash.ts:510
See: #core/IItemEffect#getBorderEffectColor getBorderEffectColor
Returns
Section titled “Returns”Promise<Color>
Implementation of
Section titled “Implementation of”IItemEffect.getBorderEffectColor
getBorderEffectOpacity
Section titled “getBorderEffectOpacity”getBorderEffectOpacity: () =>
Promise<number>
Defined in: core/items/flash.ts:504
See: #core/IItemEffect#getBorderEffectOpacity getBorderEffectOpacity
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemEffect.getBorderEffectOpacity
getBorderEffectRadius
Section titled “getBorderEffectRadius”getBorderEffectRadius: () =>
Promise<number>
Defined in: core/items/flash.ts:492
See: #core/IItemEffect#getBorderEffectRadius getBorderEffectRadius
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemEffect.getBorderEffectRadius
getBorderEffectThickness
Section titled “getBorderEffectThickness”getBorderEffectThickness: () =>
Promise<number>
Defined in: core/items/flash.ts:498
See: #core/IItemEffect#getBorderEffectThickness getBorderEffectThickness
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemEffect.getBorderEffectThickness
getBrightness
Section titled “getBrightness”getBrightness: () =>
Promise<number>
Defined in: core/items/flash.ts:211
See: #core/IItemColor#getBrightness getBrightness
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemColor.getBrightness
getCanvasRotate
Section titled “getCanvasRotate”getCanvasRotate: () =>
Promise<number>
Defined in: core/items/flash.ts:103
See: #core/IItemLayout#getCanvasRotate getCanvasRotate
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemLayout.getCanvasRotate
Overrides
Section titled “Overrides”getChromaAntiAliasLevel
Section titled “getChromaAntiAliasLevel”getChromaAntiAliasLevel: () =>
Promise<ChromaAntiAliasLevel>
Defined in: core/items/flash.ts:300
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/flash.ts:416
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/flash.ts:406
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/flash.ts:396
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/flash.ts:352
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/flash.ts:312
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/flash.ts:332
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/flash.ts:322
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/flash.ts:342
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/flash.ts:384
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/flash.ts:364
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/flash.ts:374
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/flash.ts:216
See: #core/IItemColor#getContrast getContrast
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemColor.getContrast
getCropping
Section titled “getCropping”getCropping: () =>
Promise<Object>
Defined in: core/items/flash.ts:108
See: #core/IItemLayout#getCropping getCropping
Returns
Section titled “Returns”Promise<Object>
Implementation of
Section titled “Implementation of”IItemLayout.getCropping
Overrides
Section titled “Overrides”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”getCustomResolution
Section titled “getCustomResolution”getCustomResolution: () =>
Promise<Rectangle>
Defined in: core/items/flash.ts:60
See: #core/FlashSource#getCustomResolution getCustomResolution
Returns
Section titled “Returns”Promise<Rectangle>
Implementation of
Section titled “Implementation of”ISourceFlash.getCustomResolution
getEnhancedRotate
Section titled “getEnhancedRotate”getEnhancedRotate: () =>
Promise<number>
Defined in: core/items/flash.ts:113
See: #core/IItemLayout#getEnhancedRotate getEnhancedRotate
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemLayout.getEnhancedRotate
Overrides
Section titled “Overrides”getFileMask
Section titled “getFileMask”getFileMask: () =>
Promise<string>
Defined in: core/items/flash.ts:552
See: #core/IItemEffect#getFileMask getFileMask
Returns
Section titled “Returns”Promise<string>
Implementation of
Section titled “Implementation of”IItemEffect.getFileMask
getFilter
Section titled “getFilter”getFilter: () =>
Promise<Filter>
Defined in: core/items/flash.ts:564
See: #core/IItemEffect#getFilter getFilter
Returns
Section titled “Returns”Promise<Filter>
Implementation of
Section titled “Implementation of”IItemEffect.getFilter
getFilterConfig
Section titled “getFilterConfig”getFilterConfig: () =>
Promise<Object>
Defined in: core/items/flash.ts:579
See: #core/IItemEffect#getFilterConfig getFilterConfig
Returns
Section titled “Returns”Promise<Object>
Implementation of
Section titled “Implementation of”IItemEffect.getFilterConfig
getHue
Section titled “getHue”getHue: () =>
Promise<number>
Defined in: core/items/flash.ts:221
See: #core/IItemColor#getHue getHue
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemColor.getHue
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/flash.ts:288
See: #core/IItemChroma#getKeyingType getKeyingType
Returns
Section titled “Returns”Promise<KeyingType>
Implementation of
Section titled “Implementation of”IItemChroma.getKeyingType
getMaskEffect
Section titled “getMaskEffect”getMaskEffect: () =>
Promise<MaskEffect>
Defined in: core/items/flash.ts:486
See: #core/IItemEffect#getMaskEffect getMaskEffect
Returns
Section titled “Returns”Promise<MaskEffect>
Implementation of
Section titled “Implementation of”IItemEffect.getMaskEffect
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”getPosition
Section titled “getPosition”getPosition: () =>
Promise<Rectangle>
Defined in: core/items/flash.ts:118
See: #core/IItemLayout#getPosition getPosition
Returns
Section titled “Returns”Promise<Rectangle>
Implementation of
Section titled “Implementation of”IItemLayout.getPosition
Overrides
Section titled “Overrides”getRotateX
Section titled “getRotateX”getRotateX: () =>
Promise<number>
Defined in: core/items/flash.ts:128
See: #core/IItemLayout#getRotateX getRotateX
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemLayout.getRotateX
Overrides
Section titled “Overrides”getRotateY
Section titled “getRotateY”getRotateY: () =>
Promise<number>
Defined in: core/items/flash.ts:123
See: #core/IItemLayout#getRotateY getRotateY
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemLayout.getRotateY
Overrides
Section titled “Overrides”getRotateZ
Section titled “getRotateZ”getRotateZ: () =>
Promise<number>
Defined in: core/items/flash.ts:133
See: #core/IItemLayout#getRotateZ getRotateZ
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemLayout.getRotateZ
Overrides
Section titled “Overrides”getSaturation
Section titled “getSaturation”getSaturation: () =>
Promise<number>
Defined in: core/items/flash.ts:226
See: #core/IItemColor#getSaturation getSaturation
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemColor.getSaturation
getShadowEffectBlur
Section titled “getShadowEffectBlur”getShadowEffectBlur: () =>
Promise<number>
Defined in: core/items/flash.ts:528
See: #core/IItemEffect#getShadowEffectBlur getShadowEffectBlur
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemEffect.getShadowEffectBlur
getShadowEffectColor
Section titled “getShadowEffectColor”getShadowEffectColor: () =>
Promise<Color>
Defined in: core/items/flash.ts:516
See: #core/IItemEffect#getShadowEffectColor getShadowEffectColor
Returns
Section titled “Returns”Promise<Color>
getShadowEffectOffsetX
Section titled “getShadowEffectOffsetX”getShadowEffectOffsetX: () =>
Promise<number>
Defined in: core/items/flash.ts:540
See: #core/IItemEffect#getShadowEffectOffsetX getShadowEffectOffsetX
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemEffect.getShadowEffectOffsetX
getShadowEffectOffsetY
Section titled “getShadowEffectOffsetY”getShadowEffectOffsetY: () =>
Promise<number>
Defined in: core/items/flash.ts:546
See: #core/IItemEffect#getShadowEffectOffsetY getShadowEffectOffsetY
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemEffect.getShadowEffectOffsetY
getShadowEffectOpacity
Section titled “getShadowEffectOpacity”getShadowEffectOpacity: () =>
Promise<number>
Defined in: core/items/flash.ts:534
See: #core/IItemEffect#getShadowEffectOpacity getShadowEffectOpacity
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemEffect.getShadowEffectOpacity
getShadowEffectThickness
Section titled “getShadowEffectThickness”getShadowEffectThickness: () =>
Promise<number>
Defined in: core/items/flash.ts:522
See: #core/IItemEffect#getShadowEffectThickness getShadowEffectThickness
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemEffect.getShadowEffectThickness
getTransition
Section titled “getTransition”getTransition: () =>
Promise<Transition>
Defined in: core/items/flash.ts:438
See: #core/IItemTransition#getTransition getTransition
Returns
Section titled “Returns”Promise<Transition>
Implementation of
Section titled “Implementation of”IItemTransition.getTransition
getTransitionTime
Section titled “getTransitionTime”getTransitionTime: () =>
Promise<number>
Defined in: core/items/flash.ts:448
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/flash.ts:206
See: #core/IItemColor#getTransparency getTransparency
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemColor.getTransparency
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”ISourceFlash.getValue
Inherited from
Section titled “Inherited from”getVolume
Section titled “getVolume”getVolume: () =>
Promise<number>
Defined in: core/items/flash.ts:458
See: #core/IAudio#getVolume getVolume
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IAudio.getVolume
isAudioAvailable
Section titled “isAudioAvailable”isAudioAvailable: () =>
Promise<boolean>
Defined in: core/items/flash.ts:481
See: #core/IAudio#isAudioAvailable isAudioAvailable
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”IAudio.isAudioAvailable
isAutoMute
Section titled “isAutoMute”isAutoMute: () =>
Promise<boolean>
Defined in: core/items/flash.ts:464
See: #core/IAudio#isAutoMute isAutoMute
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”IAudio.isAutoMute
isChromaEnabled
Section titled “isChromaEnabled”isChromaEnabled: () =>
Promise<boolean>
Defined in: core/items/flash.ts:278
See: #core/IItemChroma#isChromaEnabled isChromaEnabled
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”IItemChroma.isChromaEnabled
isEnhancedResizeEnabled
Section titled “isEnhancedResizeEnabled”isEnhancedResizeEnabled: () =>
Promise<boolean>
Defined in: core/items/flash.ts:98
See: #core/IItemLayout#isEnhancedResizeEnabled isEnhancedResizeEnabled
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”IItemLayout.isEnhancedResizeEnabled
Overrides
Section titled “Overrides”isFileMaskingGuideVisible
Section titled “isFileMaskingGuideVisible”isFileMaskingGuideVisible: () =>
Promise<boolean>
Defined in: core/items/flash.ts:558
See: #core/IItemEffect#isFileMaskingGuideVisible isFileMaskingGuideVisible
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”IItemEffect.isFileMaskingGuideVisible
isFullDynamicColorRange
Section titled “isFullDynamicColorRange”isFullDynamicColorRange: () =>
Promise<boolean>
Defined in: core/items/flash.ts:236
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/flash.ts:88
See: #core/IItemLayout#isKeepAspectRatio isKeepAspectRatio
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”IItemLayout.isKeepAspectRatio
Overrides
Section titled “Overrides”isMute
Section titled “isMute”isMute: () =>
Promise<boolean>
Defined in: core/items/flash.ts:461
See: #core/IAudio#isMute isMute
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”IAudio.isMute
isPositionLocked
Section titled “isPositionLocked”isPositionLocked: () =>
Promise<boolean>
Defined in: core/items/flash.ts:93
See: #core/IItemLayout#isPositionLocked isPositionLocked
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”IItemLayout.isPositionLocked
Overrides
Section titled “Overrides”isSourceAvailable
Section titled “isSourceAvailable”isSourceAvailable: () =>
Promise<boolean>
Defined in: core/items/flash.ts:72
See: #core/FlashSource#isSourceAvailable isSourceAvailable
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”ISourceFlash.isSourceAvailable
isStreamOnlyAudio
Section titled “isStreamOnlyAudio”isStreamOnlyAudio: () =>
Promise<boolean>
Defined in: core/items/flash.ts:475
See: #core/IAudio#isStreamOnlyAudio isStreamOnlyAudio
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”IAudio.isStreamOnlyAudio
isVisible
Section titled “isVisible”isVisible: () =>
Promise<boolean>
Defined in: core/items/flash.ts:428
See: #core/IItemTransition#isVisible isVisible
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”IItemTransition.isVisible
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”removeFilter
Section titled “removeFilter”removeFilter: () =>
Promise<FlashItem>
Defined in: core/items/flash.ts:576
See: #core/IItemEffect#removeFilter removeFilter
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemEffect.removeFilter
sendBackward
Section titled “sendBackward”sendBackward: () =>
Promise<FlashItem>
Defined in: core/items/flash.ts:138
See: #core/IItemLayout#sendBackward sendBackward
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemLayout.sendBackward
Overrides
Section titled “Overrides”sendToBack
Section titled “sendToBack”sendToBack: () =>
Promise<FlashItem>
Defined in: core/items/flash.ts:143
See: #core/IItemLayout#sendToBack sendToBack
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemLayout.sendToBack
Overrides
Section titled “Overrides”setAllowRightClick
Section titled “setAllowRightClick”setAllowRightClick: (
value) =>Promise<ISourceFlash>
Defined in: core/items/flash.ts:69
See: #core/FlashSource#setAllowRightClick setAllowRightClick
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<ISourceFlash>
Implementation of
Section titled “Implementation of”ISourceFlash.setAllowRightClick
setAutoMute
Section titled “setAutoMute”setAutoMute: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:473
See: #core/IAudio#setAutoMute setAutoMute
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IAudio.setAutoMute
setBorderColor
Section titled “setBorderColor”setBorderColor: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:266
See: #core/IItemColor#setBorderColor setBorderColor
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemColor.setBorderColor
setBorderEffectColor
Section titled “setBorderEffectColor”setBorderEffectColor: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:513
See: #core/IItemEffect#setBorderEffectColor setBorderEffectColor
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemEffect.setBorderEffectColor
setBorderEffectOpacity
Section titled “setBorderEffectOpacity”setBorderEffectOpacity: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:507
See: #core/IItemEffect#setBorderEffectOpacity setBorderEffectOpacity
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemEffect.setBorderEffectOpacity
setBorderEffectRadius
Section titled “setBorderEffectRadius”setBorderEffectRadius: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:495
See: #core/IItemEffect#setBorderEffectRadius setBorderEffectRadius
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemEffect.setBorderEffectRadius
setBorderEffectThickness
Section titled “setBorderEffectThickness”setBorderEffectThickness: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:501
See: #core/IItemEffect#setBorderEffectThickness setBorderEffectThickness
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemEffect.setBorderEffectThickness
setBrightness
Section titled “setBrightness”setBrightness: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:246
See: #core/IItemColor#setBrightness setBrightness
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemColor.setBrightness
setCanvasRotate
Section titled “setCanvasRotate”setCanvasRotate: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:148
See: #core/IItemLayout#setCanvasRotate setCanvasRotate
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemLayout.setCanvasRotate
Overrides
Section titled “Overrides”setChromaAntiAliasLevel
Section titled “setChromaAntiAliasLevel”setChromaAntiAliasLevel: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:305
See: #core/IItemChroma#setChromaAntiAliasLevel setChromaAntiAliasLevel
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaAntiAliasLevel
setChromaColorKeyColor
Section titled “setChromaColorKeyColor”setChromaColorKeyColor: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:421
See: #core/IItemChroma#setChromaColorKeyColor setChromaColorKeyColor
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaColorKeyColor
setChromaColorKeyExposure
Section titled “setChromaColorKeyExposure”setChromaColorKeyExposure: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:411
See: #core/IItemChroma#setChromaColorKeyExposure setChromaColorKeyExposure
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaColorKeyExposure
setChromaColorKeyThreshold
Section titled “setChromaColorKeyThreshold”setChromaColorKeyThreshold: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:401
See: #core/IItemChroma#setChromaColorKeyThreshold setChromaColorKeyThreshold
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaColorKeyThreshold
setChromaEnabled
Section titled “setChromaEnabled”setChromaEnabled: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:283
See: #core/IItemChroma#setChromaEnabled setChromaEnabled
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaEnabled
setChromaLegacyAlphaSmoothing
Section titled “setChromaLegacyAlphaSmoothing”setChromaLegacyAlphaSmoothing: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:357
See: #core/IItemChroma#setChromaLegacyAlphaSmoothing setChromaLegacyAlphaSmoothing
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaLegacyAlphaSmoothing
setChromaLegacyBrightness
Section titled “setChromaLegacyBrightness”setChromaLegacyBrightness: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:317
See: #core/IItemChroma#setChromaLegacyBrightness setChromaLegacyBrightness
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaLegacyBrightness
setChromaLegacyHue
Section titled “setChromaLegacyHue”setChromaLegacyHue: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:337
See: #core/IItemChroma#setChromaLegacyHue setChromaLegacyHue
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaLegacyHue
setChromaLegacySaturation
Section titled “setChromaLegacySaturation”setChromaLegacySaturation: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:327
See: #core/IItemChroma#setChromaLegacySaturation setChromaLegacySaturation
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaLegacySaturation
setChromaLegacyThreshold
Section titled “setChromaLegacyThreshold”setChromaLegacyThreshold: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:347
See: #core/IItemChroma#setChromaLegacyThreshold setChromaLegacyThreshold
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaLegacyThreshold
setChromaRGBKeyExposure
Section titled “setChromaRGBKeyExposure”setChromaRGBKeyExposure: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:389
See: #core/IItemChroma#setChromaRGBKeyExposure setChromaRGBKeyExposure
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaRGBKeyExposure
setChromaRGBKeyPrimaryColor
Section titled “setChromaRGBKeyPrimaryColor”setChromaRGBKeyPrimaryColor: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:369
See: #core/IItemChroma#setChromaRGBKeyPrimaryColor setChromaRGBKeyPrimaryColor
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaRGBKeyPrimaryColor
setChromaRGBKeyThreshold
Section titled “setChromaRGBKeyThreshold”setChromaRGBKeyThreshold: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:379
See: #core/IItemChroma#setChromaRGBKeyThreshold setChromaRGBKeyThreshold
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaRGBKeyThreshold
setContrast
Section titled “setContrast”setContrast: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:251
See: #core/IItemColor#setContrast setContrast
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemColor.setContrast
setCropping
Section titled “setCropping”setCropping: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:153
See: #core/IItemLayout#setCropping setCropping
Parameters
Section titled “Parameters”Object
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemLayout.setCropping
Overrides
Section titled “Overrides”setCroppingEnhanced
Section titled “setCroppingEnhanced”setCroppingEnhanced: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:158
See: #core/IItemLayout#setCroppingEnhanced setCroppingEnhanced
Parameters
Section titled “Parameters”Object
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemLayout.setCroppingEnhanced
Overrides
Section titled “Overrides”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”setCustomResolution
Section titled “setCustomResolution”setCustomResolution: (
value) =>Promise<ISourceFlash>
Defined in: core/items/flash.ts:63
See: #core/FlashSource#setCustomResolution setCustomResolution
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<ISourceFlash>
Implementation of
Section titled “Implementation of”ISourceFlash.setCustomResolution
setEnhancedResizeEnabled
Section titled “setEnhancedResizeEnabled”setEnhancedResizeEnabled: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:179
See: #core/IItemLayout#setEnhancedResizeEnabled setEnhancedResizeEnabled
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemLayout.setEnhancedResizeEnabled
Overrides
Section titled “Overrides”setEnhancedRotate
Section titled “setEnhancedRotate”setEnhancedRotate: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:164
See: #core/IItemLayout#setEnhancedRotate setEnhancedRotate
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemLayout.setEnhancedRotate
Overrides
Section titled “Overrides”setFileMask
Section titled “setFileMask”setFileMask: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:555
See: #core/IItemEffect#setFileMask setFileMask
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemEffect.setFileMask
setFilter
Section titled “setFilter”setFilter: (
value,config?) =>Promise<FlashItem>
Defined in: core/items/flash.ts:567
See: #core/IItemEffect#setFilter setFilter
Parameters
Section titled “Parameters”any
config?
Section titled “config?”intensity?
Section titled “intensity?”number
resourceFile?
Section titled “resourceFile?”string
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemEffect.setFilter
setFullDynamicColorRange
Section titled “setFullDynamicColorRange”setFullDynamicColorRange: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:271
See: #core/IItemColor#setFullDynamicColorRange setFullDynamicColorRange
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemColor.setFullDynamicColorRange
setHue
Section titled “setHue”setHue: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:256
See: #core/IItemColor#setHue setHue
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemColor.setHue
setKeepAspectRatio
Section titled “setKeepAspectRatio”setKeepAspectRatio: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:169
See: #core/IItemLayout#setKeepAspectRatio setKeepAspectRatio
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<FlashItem>
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<FlashItem>
Defined in: core/items/flash.ts:293
See: #core/IItemChroma#setKeyingType setKeyingType
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemChroma.setKeyingType
setMaskEffect
Section titled “setMaskEffect”setMaskEffect: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:489
See: #core/IItemEffect#setMaskEffect setMaskEffect
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemEffect.setMaskEffect
setMute
Section titled “setMute”setMute: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:470
See: #core/IAudio#setMute setMute
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IAudio.setMute
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”setPosition
Section titled “setPosition”setPosition: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:184
See: #core/IItemLayout#setPosition setPosition
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemLayout.setPosition
Overrides
Section titled “Overrides”setPositionLocked
Section titled “setPositionLocked”setPositionLocked: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:174
See: #core/IItemLayout#setPositionLocked setPositionLocked
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemLayout.setPositionLocked
Overrides
Section titled “Overrides”setRotateX
Section titled “setRotateX”setRotateX: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:194
See: #core/IItemLayout#setRotateX setRotateX
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemLayout.setRotateX
Overrides
Section titled “Overrides”setRotateY
Section titled “setRotateY”setRotateY: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:189
See: #core/IItemLayout#setRotateY setRotateY
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemLayout.setRotateY
Overrides
Section titled “Overrides”setRotateZ
Section titled “setRotateZ”setRotateZ: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:199
See: #core/IItemLayout#setRotateZ setRotateZ
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemLayout.setRotateZ
Overrides
Section titled “Overrides”setSaturation
Section titled “setSaturation”setSaturation: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:261
See: #core/IItemColor#setSaturation setSaturation
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemColor.setSaturation
setShadowEffectBlur
Section titled “setShadowEffectBlur”setShadowEffectBlur: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:531
See: #core/IItemEffect#setShadowEffectBlur setShadowEffectBlur
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemEffect.setShadowEffectBlur
setShadowEffectColor
Section titled “setShadowEffectColor”setShadowEffectColor: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:519
See: #core/IItemEffect#setShadowEffectColor setShadowEffectColor
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<FlashItem>
setShadowEffectOffsetX
Section titled “setShadowEffectOffsetX”setShadowEffectOffsetX: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:543
See: #core/IItemEffect#setShadowEffectOffsetX setShadowEffectOffsetX
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemEffect.setShadowEffectOffsetX
setShadowEffectOffsetY
Section titled “setShadowEffectOffsetY”setShadowEffectOffsetY: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:549
See: #core/IItemEffect#setShadowEffectOffsetY setShadowEffectOffsetY
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemEffect.setShadowEffectOffsetY
setShadowEffectOpacity
Section titled “setShadowEffectOpacity”setShadowEffectOpacity: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:537
See: #core/IItemEffect#setShadowEffectOpacity setShadowEffectOpacity
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemEffect.setShadowEffectOpacity
setShadowEffectThickness
Section titled “setShadowEffectThickness”setShadowEffectThickness: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:525
See: #core/IItemEffect#setShadowEffectThickness setShadowEffectThickness
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemEffect.setShadowEffectThickness
setStreamOnlyAudio
Section titled “setStreamOnlyAudio”setStreamOnlyAudio: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:478
See: #core/IAudio#setStreamOnlyAudio setStreamOnlyAudio
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IAudio.setStreamOnlyAudio
setTransition
Section titled “setTransition”setTransition: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:443
See: #core/IItemTransition#setTransition setTransition
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemTransition.setTransition
setTransitionTime
Section titled “setTransitionTime”setTransitionTime: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:453
See: #core/IItemTransition#setTransitionTime setTransitionTime
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemTransition.setTransitionTime
setTransparency
Section titled “setTransparency”setTransparency: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:241
See: #core/IItemColor#setTransparency setTransparency
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemColor.setTransparency
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”ISourceFlash.setValue
Inherited from
Section titled “Inherited from”setVisible
Section titled “setVisible”setVisible: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:433
See: #core/IItemTransition#setVisible setVisible
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemTransition.setVisible
setVolume
Section titled “setVolume”setVolume: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:467
See: #core/IAudio#setVolume setVolume
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IAudio.setVolume
showFileMaskingGuide
Section titled “showFileMaskingGuide”showFileMaskingGuide: (
value) =>Promise<FlashItem>
Defined in: core/items/flash.ts:561
See: #core/IItemEffect#showFileMaskingGuide showFileMaskingGuide
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<FlashItem>
Implementation of
Section titled “Implementation of”IItemEffect.showFileMaskingGuide
_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”XML
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[]>