SourceFlash
Defined in: core/source/iflash.ts:122
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SourceFlash():
SourceFlash
Returns
Section titled “Returns”SourceFlash
Methods
Section titled “Methods”getAllowRightClick()
Section titled “getAllowRightClick()”getAllowRightClick():
Promise<boolean>
Defined in: core/source/iflash.ts:183
return: Promise
Check if right click events are sent to the item or not.
item.getAllowRightClick().then(function(isRightClickAllowed) { // The rest of your code here});Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”ISourceFlash.getAllowRightClick
getCustomResolution()
Section titled “getCustomResolution()”getCustomResolution():
Promise<Rectangle>
Defined in: core/source/iflash.ts:134
return: Promise
Gets the custom resolution (in pixels) for the item, if set, regardless of its layout on the mixer. Returns a (0, 0) Rectangle if no custom resolution has been set.
See also: #util/Rectangle Util/Rectangle
Returns
Section titled “Returns”Promise<Rectangle>
Implementation of
Section titled “Implementation of”ISourceFlash.getCustomResolution
getValue()
Section titled “getValue()”getValue():
Promise<string>
Defined in: core/source/iflash.ts:240
return: Promise
Gets the URL path of the image file used as a source
source.getValue().then(function(value) { // Do something with the value});Returns
Section titled “Returns”Promise<string>
Implementation of
Section titled “Implementation of”isSourceAvailable()
Section titled “isSourceAvailable()”isSourceAvailable():
Promise<boolean>
Defined in: core/source/iflash.ts:223
return: Promise
Check if file used as source is available
item.isSourceAvailable().then(function(isAvail) { // The rest of your code here});Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”ISourceFlash.isSourceAvailable
setAllowRightClick()
Section titled “setAllowRightClick()”setAllowRightClick(
value):Promise<SourceFlash>
Defined in: core/source/iflash.ts:200
param: (value:boolean)
return: Promise<Item>Allow or disallow right click events to be sent to the item. Note that
you can only catch right click events using mouseup/mousedown
Chainable
item.setAllowRightClick(true).then(function(item) { // Promise resolves with the same Item instance});Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<SourceFlash>
Implementation of
Section titled “Implementation of”ISourceFlash.setAllowRightClick
setCustomResolution()
Section titled “setCustomResolution()”setCustomResolution(
value):Promise<SourceFlash>
Defined in: core/source/iflash.ts:160
param: (value: Rectangle)
return: Promise<FlashSource>Sets the custom resolution for the item regardless of its layout on the mixer
Chainable.
See also: #util/Rectangle Util/Rectangle
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<SourceFlash>
Implementation of
Section titled “Implementation of”ISourceFlash.setCustomResolution
setValue()
Section titled “setValue()”setValue(
filename):Promise<SourceFlash>
Defined in: core/source/iflash.ts:259
param: (value: string)
return: Promise<ISourcePlayback>Set the image file to be used as source
source.setValue('C:\\SomeFolder\\SomeFile.png') .then(function(source) { // Promise resolves with same Source instance});Parameters
Section titled “Parameters”filename
Section titled “filename”string
Returns
Section titled “Returns”Promise<SourceFlash>