ISourceFlash
Defined in: core/source/iflash.ts:8
Methods
Section titled “Methods”getAllowRightClick()
Section titled “getAllowRightClick()”getAllowRightClick():
Promise<boolean>
Defined in: core/source/iflash.ts:48
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>
getCustomResolution()
Section titled “getCustomResolution()”getCustomResolution():
Promise<Rectangle>
Defined in: core/source/iflash.ts:18
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>
getValue()
Section titled “getValue()”getValue():
Promise<string|XML>
Defined in: core/source/iflash.ts:100
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 | XML>
isSourceAvailable()
Section titled “isSourceAvailable()”isSourceAvailable():
Promise<boolean>
Defined in: core/source/iflash.ts:84
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>
setAllowRightClick()
Section titled “setAllowRightClick()”setAllowRightClick(
value):Promise<ISourceFlash>
Defined in: core/source/iflash.ts:69
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<ISourceFlash>
setCustomResolution()
Section titled “setCustomResolution()”setCustomResolution(
value):Promise<ISourceFlash>
Defined in: core/source/iflash.ts:33
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<ISourceFlash>
setValue()
Section titled “setValue()”setValue(
value):Promise<any>
Defined in: core/source/iflash.ts:119
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”string
Returns
Section titled “Returns”Promise<any>