After Effects scripting referenceApplication object
26
SwatchValue.LSwatchValue.aSwatchValue.bSwatchValue.value
When type = \, the color values.
L is in the range [0.0..1.0]. a and b are in the range [-128.0..+128.0]0, 0, 0 is Black.
When type = \, the value range is [0.0..1.0]. 0.0 is Black.
Application pauseWatchFolder() method
app.pauseWatchFolder(pause)Description
Pauses or resumes the search of the target watch folder for items to render.
ParameterspauseReturns
True to pause, false to resume.
Nothing.
See also
“Application isWatchFolder attribute” on page23“Application watchFolder() method” on page29“Application endWatchFolder() method” on page21
Application project attribute
app.projectDescription
The project that is currently loaded. See “Project object” on page114.
Type
Project object; read-only.
Application purge() method
app.purge(target)Description
Purges unused data of the specified types from memory. Replicates the Purge options in the Edit menu.
26
After Effects scripting referenceApplication object
27
Parameterstarget
The type of elements to purge from memory; a PurgeTarget enumerated value, one of:
?PurgeTarget.ALL_CACHES: Purges all data that After Effects has cached to physical memory.?PurgeTarget.UNDO_CACHES: Purges all data saved in the undo cache.
?PurgeTarget.SNAPSHOT_CACHES: Purges all data cached as composition/layer snapshots.?PurgeTarget.IMAGE_CACHES: Purges all saved image data.
Returns
Nothing.
Application quit() method
app.quit()Description
Quits the After Effects application.
Parameters
None.
Returns
Nothing.
Application saveProjectOnCrash attribute
app.saveProjectOnCrashDescription
When true (the default), After Effects attempts to display a dialog box that allows you to save the current project if an error causes the application to quit unexpectedly. Set to false to suppress this dialog box and quit without saving.
Type
Boolean; read/write.
Application scheduleTask() method
app.scheduleTask(stringToExecute, delay, repeat)Description
Schedules the specified JavaScript for delayed execution.
ParametersstringToExecutedelay
A string containing JavaScript to be executed.
A number of milliseconds to wait before executing the JavaScript. A floating-point value.
27
After Effects scripting referenceApplication object
28
repeat
When true, execute the script repeatedly, with the specified delay between each execution. When false the script is executed only once.
Returns
Integer, a unique identifier for this task, which can be used to cancel it with app.cancelTask().
Application setMemoryUsageLimits() method
app.setMemoryUsageLimits(imageCachePercentage, maximumMemoryPercentage)Description
Sets memory usage limits as in the Memory & Cache preferences area. For both values, if installed RAM is less than a given amount (n gigabytes), the value is a percentage of the installed RAM, and is otherwise a
percentage of n. The value of n is: 2 GB for 32-bit Windows, 4 GB for 64-bit Windows, 3.5 GB for Mac OS.
Parameters
imageCachePercentagemaximumMemoryPercentageReturns
Floating-point value, the percentage of memory assigned to image cache.Floating-point value, the maximum usable percentage of memory.
Nothing.
Application setSavePreferencesOnQuit() method
app.setSavePreferencesOnQuit(doSave)Description
Set or clears the flag that determines whether preferences are saved when the application is closed.
ParametersdoSaveReturns
When true, preferences saved on quit, when false they are not.
Nothing.
Application settings attribute
app.settingsDescription
The currently loaded settings. See “Settings object” on page170.
Type
Settings object; read-only.
28
After Effects scripting referenceApplication object
29
Application version attribute
app.versionDescription
An alphanumeric string indicating which version of After Effects is running.
Type
String; read-only.
Example
var ver = app.version;
alert(\
Application watchFolder() method
app.watchFolder(folder_object_to_watch)Description
Starts a Watch Folder (network rendering) process pointed at a specified folder.
Parameters
folder_object_to_watchReturns
The ExtendScript Folder object for the folder to watch.
Nothing.
Example
var theFolder = new Folder(“c:/tool”);app.watchFolder(theFolder);See also
“Application endWatchFolder() method” on page21“Application parseSwatchFile() method” on page25“Application isWatchFolder attribute” on page23
29
After Effects scripting referenceAVItem object
30
AVItem object
app.project.item(index)Description
The AVItem object provides access to attributes and methods of audio/visual files imported into After Effects.
?AVItem is a subclass of Item. All methods and attributes of Item, in addition to those listed below, are
available when working with AVItem. See “Item object” on page78.
?AVItem is the base class for both CompItem and FootageItem, so AVItem attributes and methods are also
available when working with CompItem and FootageItem objects. See “CompItem object” on page52 and “FootageItem object” on page65.
AttributesAttribute
Reference
“AVItem name attribute” on page33“AVItem width attribute” on page37“AVItem height attribute” on page32“AVItem pixelAspect attribute” on page33“AVItem frameRate attribute” on page32
Description
The name of the object as shown in the Project panel.The width of the item.The height of the item.
The pixel aspect ratio of the item.The frame rate of the item.
namewidthheightpixelAspect frameRateframeDurationdurationuseProxyproxySourcetime usedInhasVideohasAudiofootageMissing
“AVItem frameDuration attribute” on page31The frame duration for the item.“AVItem duration attribute” on page31“AVItem useProxy attribute” on page36“AVItem proxySource attribute” on page34“AVItem time attribute” on page36“AVItem usedIn attribute” on page36“AVItem hasVideo attribute” on page32“AVItem hasAudio attribute” on page32“AVItem footageMissing attribute” on page31
The total duration of the item.
When true, a proxy source is used for this item.The FootageItem object used as proxy for the item.Current time of the item.
The CompItem objects that use this item.When true, the item has a video component.When true, the item has an audio component.
When true, the item cannot be found or is a placeholder.
MethodsMethod
Reference
“AVItem setProxy() method” on page34“AVItem setProxyWithSequence() method” on page35
“AVItem setProxyWithSolid() method” on page35
Description
Sets a proxy for the item.
Sets a sequence as a proxy for the item.Sets a solid as a proxy for the item.
setProxy()
setProxyWithSequence()setProxyWithSolid()setProxyWithPlaceholder()setProxyToNone()
“AVItem setProxyWithPlaceholder() method” on Sets a placeholder as a proxy for the item.page35
“AVItem setProxyToNone() method” on page34
Removes the proxy for the item.
30