Automation Toolkit Documentation
Layer
Layer Object Properties
name
Text
true
Text,Number,Boolean,Array
the name of the layer
specify a name for the layer
name include
Text
false
none
checks if the layer name includes a specified phrase (works only via "If" automation line)
name starts with
Text
false
none
checks if the layer name starts with a specified phrase (works only via "If" automation line)
name ends with
Text
false
none
checks if the layer name ends with a specified phrase (works only via "If" automation line)
comment
Text
true
Text,Number,Boolean,Array
the comment of the layer
specify a text for the comment of the layer
layer id
Number
false
none
unique and persistent identification number used internally to identify a Layer. the value of the id remains the same when the project is saved to a file and later reloaded (when you import this project into another project, new IDs are assigned to all Layers in the imported project) (from AE 2022)
active
Boolean
false
none
checks if the layer is enabled and within the range of the time indicator
enabled
Boolean
true
Boolean
checks if the layer is enabled
set to true to enable the layer
audio enabled
Boolean
true
Boolean
checks if the layer's audio is turned on
set to true to turn on the layer's audio
selected
Boolean
true
Boolean
checks if the layer is selected in the timeline
set to true to select the layer
selected index
Number
false
none
indicator for the position of a specific layer in the selection order of the layers
first selected
Boolean
false
none
checks if the layer was first selected in the selection order of the layers
last selected
Boolean
false
none
checks if the layer was last selected in the selection order of the layers
index
Number
false
none
indicator for the position of a specific layer in the order of the layers
in point
Number
true
Number
the time of the composition in which the in point of the layer is placed
specify the time in which the in point of the layer will be placed
out point
Number
true
Number
the time of the composition in which the out point of the layer is placed
specify the time in which the out point of the layer will be placed
start time
Number
true
Number
the time of the composition in which the start point of the layer is placed (the start point is the first frame of the layer source footage)
specify the time in which the start point of the layer will be placed
current time
Number
false
none
the current time in which the time indicator of the composition is placed
is locked
Boolean
true
Boolean
checks if the layer is locked
set to true to lock the layer
is null
Boolean
false
none
checks if the layer is a null object
is solid
Boolean
false
none
checks if the layer is a solid layer
is camera
Boolean
false
none
checks if the layer is a camera layer
is light
Boolean
false
none
checks if the layer is a light layer
is shape
Boolean
false
none
checks if the layer is a shape layer
is text
Boolean
false
none
checks if the layer is a text layer
is precomp
Boolean
false
none
checks if the layer is a precomp layer
parent
Layer
true
Layer
the parent layer of the layer
specify a target layer to be linked to
this layer
Layer
false
none
this layer
is shy
Boolean
true
Boolean
checks if the layer's shy option is enabled
set to true to enable the shy option
is solo
Boolean
true
Boolean
checks if the layer's solo option is enabled
set to true to enable the solo option
stretch
Number
true
Number
the percentage value of the time stretch of the layer
specify a percentage number for the time stretch of the layer
label
Array
true
Array
the label color
none,Red,Yellow,Aqua,Pink,Lavender,Peach,Sea Foam,Blue,Green,Purple,Orange,Brown,Fuchsia,Cyan,Sandstone,Dark Green
isAdjustment
Boolean
true
Boolean
checks if the layer's adjustment layer option is enabled
set to true to enable the adjustment layer option
motion Blur
Boolean
true
Boolean
checks if the layer's motion blur option is enabled
set to true to enable the motion blur option
3d
Boolean
true
Boolean
checks if the layer's 3d layer option is enabled
set to true to enable the 3d layer option
blending mode
Array
true
Array
the blending mode of the layer
Normal,Dissolve,Dancing Dissolve,Darken,Multiply,Color Burn,Classic Color Burn,Linear Burn,Darker Color,Add,Lighten,Screen,Color Dodge,Classic Color Dodge,Linear Dodge,Lighter Color,Overlay,Soft Light,Hard Light,Linear Light,Vivid Light,Pin Light,Hard Mix,Difference,Classic Difference,Exclusion,Subtract,Divide,Hue,Saturation,Color,Luminosity,Stencil Alpha,Stencil Luma,Silhouette Alpha,Silhouette Luma,Alpha Add,Luminescent Premul
track matte
Array
true
Array
the track matte of the layer
choose a track matte type for the layer, if this layer has no applied track matte layer (track matte set to none) it will set the layer above it as the new track matte layer (from AE 2023) if you want to set other layer as the track matte layer, first set a track matte layer using the layer property"track matte layer" and then use this property to set track matte type
No Track Matte,Alpha Matte,Alpha Inverted Matte,Luma Matte,Luma Inverted Matte
track matte layer
Layer
true
Layer
the track matte target layer of the layer (from AE 2023)
specify a target layer to be a matte layer
is track matte
Boolean
false
none
checks if this layer is being used as a track matte
frame blending
Array
true
Array
frame blending
None,Frame Mix,Pixel Motion
collapse transformation
Boolean
true
Boolean
checks if the layer's collapse transformations option is enabled
set to true to enable the collapse transformations option
time remap enabled
Boolean
true
Boolean
checks if the layer's time remapping option is enabled
set to true to enable the time remapping option
effects active
Boolean
true
Boolean
checks if the layer's effect option is enabled
set to true to enable the effect option
guide layer
Boolean
true
Boolean
checks if the layer is a guide layer
set to true to make the layer a guide layer
height
Number
false
none
the height of the layer (in pixels)
width
Number
false
none
the width of the layer (in pixels)
opacity
Number
true
Number
the opacity value of the layer
position x
Number
true
Number
the position x value of the layer
position y
Number
true
Number
the position y value of the layer
position z
Number
true
Number
the position z value of the layer
anchor point x
Number
true
Number
the anchor point x value of the layer
anchor point y
Number
true
Number
the anchor point y value of the layer
anchor point z
Number
true
Number
the anchor point z value of the layer
scale
Number
true
Number
the scale value of the layer
scale x
Number
true
Number
the scale x value of the layer
scale y
Number
true
Number
the scale y value of the layer
scale z
Number
true
Number
the scale z value of the layer
rotation
Number
true
Number
the rotation value of the layer
rotation x
Number
true
Number
the rotation x value of the layer
rotation y
Number
true
Number
the rotation y value of the layer
rotation z
Number
true
Number
the rotation z value of the layer
orientation
Number
true
Number
the orientation value of the layer
orientation x
Number
true
Number
the orientation x value of the layer
orientation y
Number
true
Number
the orientation y value of the layer
orientation z
Number
true
Number
the orientation z value of the layer
time remap
Number
true
Number
the time remap value of the layer
audio levels
Number
true
Number
the audio levels value of the layer
isDuplicate
Boolean
false
none
check if the layer is a duplicate of another layer, that was created during the current loop
source text
Text
true
Text,Number,Boolean,Array
the source text value of a text layer
font
Text
true
Text,Number,Boolean,Array
the font name of a text layer
font size
Number
true
Number
the font size of a text layer
text justification
Array
true
Array
the justification of a text layer
Left,Center,Right,Justify last left,Justify last centered,Justify last right,Justify all
camera depth of field
Boolean
true
Boolean
the depth of field value of a camera layer
camera zoom
Number
true
Number
the zoom value of a camera layer
number of markers
Number
false
none
the number of markers in the layer
number of effects
Number
false
none
the number of effects in the layer
containing comp
Item
false
none
the composition item that contains the layer
source
Item
false
none
the source footage of the layer
###Layer Object Actions
UiName
input parameter objectType
info
options
supportedVersion
delete
none
deletes the layer
duplicate
none
duplicates the layer
copy to comp
Item
copies the layer into a specified composition specify an item object for the destination composition
move to beginning
none
moves the layer to the top in the order of the layers
move to end
none
moves the layer to the bottom in the order of the layers
move after
Layer
moves the layer below a specified layer in composition specify a layer for the rearrangement operation
move before
Layer
moves the layer above a specified layer in composition specify a layer for the rearrangement operation
reposition anchor point
Array
moves the anchor point to the center or the corners of the layer
top left,top center,top right,middle left,middle center,middle right,bottom left,bottom center,bottom right
set parent with jump
Layer
sets the parent of the layer with jump (same as holding shift when parenting) to a specified layer in the composition the layer will jump to the position, anchor point, scale, rotation of the specified parent layer specify a target layer to be linked to
remove all effects
none
removes all the effects from the layer
add effect
Text,Number,Boolean
applies an effect to the layer based on on its displayed name in the effects list specify the EXACT name of the effect
add effect (match name)
Text,Number,Boolean
applies an effect to the layer based on its "match name" property so it will work on all languages of after effects specify the EXACT "match name" property of the effect
add marker
Number
creates or overrides a marker at a specified time (in seconds) specify the time in which the marker will be placed
delete all markers
none
removes all the markers from the layer
apply animation preset
Text,Number,Boolean
applies an animation preset to the layer specify the EXACT name of the preset the preset should be installed inside the presets folder of the application windows - C:\Program Files\Adobe\Adobe After Effects 2021\Support Files\Presets mac - Applications/Adobe After Effects 2021/Presets
apply animation preset file
File
applies an animation preset to the layer from specified preset file specify a preset file
replace layer
Item
replaces a layer with a different source specify an item for the new source
retime selected keyframes
Number
moves the selected keyframes of the layer as a group to a specified time (in seconds) specify the time in which the keyframes will start at
retime all the keyframes
Number
moves all the keyframes of the layer as a group to a specified time (in seconds) specify the time in which the keyframes will start at
offset selected keyframes
Number
shifts the selected keyframes of the layer as a group by a specified amount time (in seconds) specify the amount of time (in seconds) that the selected keyframes will be shifted
offset all the keyframes
Number
shifts all the keyframes of the layer as a group by a specified amount time (in seconds) specify the amount of time (in seconds) that the all the keyframes will be shifted
run scene edit detection
Array
runs scene edit detection on the layer this is the same as selecting a layer in the timeline and choosing "layer > scene edit detection" with the single argument determining whether the edits are applied as markers, layer splits, pre-comps (from AE 2022)
create markers,split layer,split and precompose
---
## Item
Item Object Properties
name
Text
true
Text,Number,Boolean,Array
the name of the item
specify a name for the item
name include
Text
false
none
checks if the layer name includes a specified phrase (works only via "If" automation line)
name starts with
Text
false
none
checks if the layer name starts with a specified phrase (works only via "If" automation line)
name ends with
Text
false
none
checks if the layer name ends with a specified phrase (works only via "If" automation line)
file extension
Text
false
none
the extension of the file source of the item for example - ".mp4"
item id
Number
false
none
a unique number associated with the item
parent folder
Item
true
Item
the folder that contains the item in the project panel (if the item is not in a folder the property value will be equal to the "root folder" item property)
specify a folder item to which the item should be moved
project folder contains
Item
false
none
checks if the folder contains a specified project item (works only via "If" automation line)
is selected
Boolean
true
Boolean
checks if the item is selected in the project panel
set to true to select the item
item type
Array
false
none
the type of the project panel item
Folder,Footage,Composition
footage type
Array
false
none
the type of the footage
File,Solid,Placeholder
is still frame
Boolean
false
none
checks if the item is a still image
has video
Boolean
false
none
checks if the item has video
has audio
Boolean
false
none
checks if the item has audio
use proxy
Boolean
true
Boolean
checks if a proxy is used for the item
set to true to enable the proxy
background color
Text
true
Text,Number,Boolean,Array
the background color of the composition
specify a color (hex color "D6D6D6" or rgb color - "0.5,0.5,0.5")
has alpha channel
Boolean
false
none
checks if the item has an alpha channel
alpha channel mode
Array
true
Array
the alpha channel mode
Ignore,Straight - Unmatted,Premultiplied - Matted With Color
loop
Number
true
Number
the number of loops that the footage item will be played
number of layers
Number
false
none
the number of layers in the composition
number of markers
Number
false
none
the number of markers in the item
number of sub-items
Number
false
none
the number of items contained in the folder item if the folder contains another folder, only that folder is counted, not any subitems contained in it
this item
Item
false
none
this item
label
Array
true
Array
the label color
none,Red,Yellow,Aqua,Pink,Lavender,Peach,Sea Foam,Blue,Green,Purple,Orange,Brown,Fuchsia,Cyan,Sandstone,Dark Green
height
Number
true
Number
the height of the item (in pixels)
specify a number for the height value of the item *works only on compositions and solids
width
Number
true
Number
the width of the item (in pixels)
specify a number for the width value of the item *works only on compositions and solids
duration
Number
true
Number
the duration (in seconds) of the item
specify a number for the duration value of the item *works only on compositions
start timecode
Number
true
Number
the time set as the beginning of the composition (in seconds)
specify a number (in seconds) for the first frame of the composition
frame rate
Number
true
Number
the frame rate of the item
specify a number for the frame rate value of the item
pixel aspect ratio
Number
true
Number
the pixel aspect ratio of the item
specify a number for the pixel aspect ratio value of the item
time indicator
Number
true
Number
the current time of the composition (in seconds)
specify a number (in seconds) for time indicator of the composition
work area start
Number
true
Number
the time when the composition work area begins (in seconds)
specify a number (in seconds) for the work area start time in the composition
work area end
Number
true
Number
the time when the composition work area ends (in seconds)
specify a number (in seconds) for the work area out point in the composition
isMissing
Boolean
false
none
checks if the item represents footage with a source file that cannot be found
motion Blur
Boolean
true
Boolean
checks if the layer's motion blur option is enabled
set to true to enable the motion blur option
isDuplicate
Boolean
false
none
check if the item is a duplicate of another item, that was created during the current loop
project name
Text
false
none
the name of the current project
root folder
Item
false
none
the root folder containing the contents of the project this is a virtual folder that contains all items in the Project panel, but not items contained inside other folders in the Project panel
source file
File
true
File
the file that the item is linked to
specify a file to replace the current source of the footage
source proxy file
File
true
File
the proxy file that the item is linked to
specify a file to replace the current proxy of the footage
###Item Object Actions
UiName
input parameter objectType
info
options
supportedVersion
open in viewer
none
opens the item in the viewer
delete
none
deletes the item
duplicate
none
duplicates the item in the project panel
precompose (move all attributes)
Text,Number,Boolean
precomposes the selected layers in the composition using the "move all attributes" option specify a name for the precomp
precompose (move and adjust duration)
Text,Number,Boolean
precomposes the selected layers in the composition using the "move all attributes" option. the duration of the precomp is adjusted to the time span of the layers specify a name for the precomp
precompose (leave all attributes)
Text,Number,Boolean
precomposes the layer in the composition using the "leave all attributes" option specify a name for the precomp
add item
Item
adds a specified item to the composition as a new layer specify an item
replace item
Item
replaces the source file of the item with a source file of a different specified item specify an item
replace with solid
none
replaces the item with a black solid
replace with placeholder
none
replaces the item with a placeholder
add solid
Text,Number,Boolean
creates a new black solid with a specified name at the dimensions of the composition specify a name for the solid
add adjustment layer
Text,Number,Boolean
creates a new adjustment layer with a specified name at the dimensions of the composition specify a name for the adjustment layer
add null
Text,Number,Boolean
creates a new null object with a specified name specify a name for the null object
add text
Text,Number,Boolean
creates a new text layer with a specified text specify a text for the source of the text layer
add paragraph text
Text,Number,Boolean
creates a new empty paragraph (box) text layer with a specified dimensions specify the dimensions for the box of the paragraph text layer type the width and height with a comma (",") between them for example - 100,400
add Camera
Text,Number,Boolean
creates a new camera with a specified name specify a name for the camera
add light
Text,Number,Boolean
creates a new light with a specified name specify a name for the light
add shape
Text,Number,Boolean
creates a new empty shape layer with a specified name specify a name for the shape layer
add to render queue
none
sends the composition to the render queue
send to media encoder
none
adds queued render items to the adobe media encoder queue (Queue in AME) *this action conflicts with the undo option
set proxy
Item
sets the proxy file of the item to a different specified item specify an item
unset proxy
none
removes the proxy file of the item
add vertical guide
Number
adds a vertical guide to the composition at a specified x position specify a position for the guide *after effects 16.1 and above
16.1
add horizontal guide
Number
adds a horizontal guide to the composition at a specified y position specify a position for the guide *after effects 16.1 and above
16.1
remove all guides
none
removes all the guides from the composition *after effects 16.1 and above
16.1
copy all guides
Item
copies all the guides from a specified composition/footage specify a composition (item) *after effects 16.1 and above
16.1
add marker
Number
adds a marker to the composition/footage at a specified time specify a time for the marker (in seconds)
delete all markers
none
deletes all the markers from the composition/footage
---
## Effect
Effect Object Properties
name
Text
true
Text,Number,Boolean,Array
the name of the effect
specify a name for the effect
match name
Text
false
none
the unique id of the effect
default display name
Text
false
none
the default display name (as seen in the Effect menu)
index
Number
false
none
indicator for the position of a specific effect in the order of the effects
enabled
Boolean
true
Boolean
checks if the effect is enabled
set to true to enable the effect
selected
Boolean
true
Boolean
checks if the effect is selected
set to true to select the effect
version
Number
false
none
effect's internal version This value might be different than the version number the plug-in vendor decides to show in the effect's about box
###Effect Object Actions
UiName
input parameter objectType
info
options
supportedVersion
delete
none
deletes the effect from the layer
move to beginning
none
moves the effect to the top in the order of the layer effects
move to end
none
moves the effect to the bottom in the order of the layer effects
move to
Number
moves the effect to a specified position in the order of the layer effects specify a number for the new position index of the effect
duplicate
none
duplicates the effect of the layer
set dropdown menu items
Text,Number,Boolean
sets the parameters for the effect "Dropdown Menu Control". this action overwrite the existing set of menu items with the provided menu items. specify the menu items with commas between them. for example "option1,option2,option3" * some characters are not supported: - empty item texts are not allowed - duplicate item texts are not allowed - the character “
” is not allowed in the item text. * The text “(-” - will appear as separator lines in the dropdown menu.
---
## Output Module
Output Module Object Properties
name
Text
false
none
the name of the last applied template of the output module
index
Number
false
none
indicator for the position of a specific output module in the order of the render job outputs
post render
Array
true
Array
An operation to be performed after the rendering work is completed
none,import,import and replace usage,set proxy
file
File
true
File
a file object for the output module that will be created/overwritten at the start of the render process
specify a file for the output module
parent folder
Folder
true
Folder
a folder object for the output module into which the file will be rendered
specify a folder for the output module
subfolder name
Text
true
Text,Number,Boolean,Array
a subfolder name for the output module into which the file will be rendered
specify a subfolder name for the output module (leave empty to disable the subfolder option) * Note that you must set the "parent folder" or "file" properties before setting this property (only if they are not already set)
file name
Text
true
Text,Number,Boolean,Array
the file name for the output module into which the file will be rendered
specify a file name for the output module (leave empty to disable the subfolder option) * Note that you must set the "parent folder" or "file" properties before setting this property (only if they are not already set)
file name template
Text
true
Text,Number,Boolean,Array
the file name template for the output module into which the file will be rendered
specify a naming template for the name of the file for example: [compName]_[outputModuleName].[fileExtension] * Note that you must set the "parent folder" or "file" properties before setting this property (only if they are not already set)
format
Text
false
none
the "format" setting of the output module
video output
Boolean
true
Boolean
checks if the "video output" setting of the output module is enabled
set to true to enable the "video output" setting
use comp frame number
Boolean
true
Boolean
checks if the "use comp frame number" setting of the output module is enabled
set to true to enable the "use comp frame number" setting
starting frame
Number
true
Number
the "starting frame" setting of the output module a number that will determine the starting frame number in the file name of an image sequence (this number will override the comp frame number)
if the composition start at frame "100" by default the image sequence will start from frame #100 (for example shot_00100.png), set this property to "0" to name the first image in the image sequence as shot_00000.png
resize
Boolean
true
Boolean
checks if the "resize" setting of the output module is enabled
set to true to enable the "resize" setting
resize lock aspect ratio
Boolean
true
Boolean
checks if the "resize lock aspect ratio" setting of the output module is enabled
set to true to enable the "resize lock aspect ratio" setting
resize quality
Array
true
Array
the "resize quality" setting of the output module
set to one of the options: low,high
low,high
resize to
Text
true
Text,Number,Boolean,Array
the "resize to" setting of the output module this property returns the width and height dimensions with a comma between them
set the "resize to" setting, type the 2 values with a comma (",") between them for example - 960,540
crop
Boolean
true
Boolean
checks if the "crop" setting of the output module is enabled
set to true to enable the "crop" setting
crop bottom
Number
true
Number
the "crop bottom" setting of the output module
crop left
Number
true
Number
the "crop left" setting of the output module
crop right
Number
true
Number
the "crop right" setting of the output module
crop top
Number
true
Number
the "crop top" setting of the output module
crop use region of interest
Boolean
true
Boolean
checks if the "crop use region of interest" setting of the output module is enabled
set to true to enable the "crop use region of interest" setting
audio output
Array
true
Array
the "audio output" setting of the output module
set to one of the options: auto,on,off
auto,on,off
audio bit depth
Array
true
Array
the "audio bit depth" setting of the output module
set to one of the options: 8 bit,16 bit,32 bit
8 bit,16 bit,32 bit
audio channels
Array
true
Array
the "audio channels" setting of the output module
set to one of the options: mono,stereo
mono,stereo
audio sample rate
Array
true
Array
the "audio sample rate" setting of the output module
set to one of the options: 16.000 kHz,22.050 kHz,24.000 kHz,32.000 kHz,44.100 kHz,48.000 kHz
16.000 kHz,22.050 kHz,24.000 kHz,32.000 kHz,44.100 kHz,48.000 kHz
include project link
Boolean
true
Boolean
checks if the "include project link" setting of the output module is enabled
set to true to enable the "include project link" setting
include source xmp metadata
Boolean
true
Boolean
checks if the "include source xmp metadata" setting of the output module is enabled
set to true to enable the "include source xmp metadata" setting
###Output Module Object Actions
UiName
input parameter objectType
info
options
supportedVersion
delete
none
deletes the output module from the render job (render job must have at list one output module)
apply template
Text,Number,Boolean
applies a template to the "output module" option specify the EXACT name of the template, for example "Multi-Machine Sequence"
save destination file
none
opens a dialogue window for saving the render output file
---
## Render Queue Item
Render Queue Item Object Properties
render enabled
Boolean
true
Boolean
checks if the render job is enabled
set to true to enable the render job
index
Number
false
none
indicator for the position of a specific render job in the order of the render queue items
render status
Array
false
none
information about the current state of the render job item
will continue,need output,unqueued,queued,rendering,user stopped,error stopped,done
number of outputs
Number
false
none
the number of outputs of the render job
source comp
Item
false
none
the composition that will be rendered by the render job
quality
Array
true
Array
the "quality" setting of the render item
set to one of the options: Current Settings,Best,Draft,Wireframe
Current Settings,Best,Draft,Wireframe
resolution
Array
true
Array
the "resolution" setting of the render item
set to one of the options: Current Settings,Full,Half,Third,Quarter
Current Settings,Full,Half,Third,Quarter
frame rate
Array
true
Array
the "frame rate" setting of the render item
set to one of the options: Use comp's frame rate,Use this frame rate
Use comp's frame rate,Use this frame rate
use this frame rate
Number
true
Number
the "use this frame rate" setting of the render item a number that represents a custom framerate for the render queue item
sets a number as custom framerate to this render queue item
time span
Array
true
Array
the "time span" setting of the render item
set to one of the options: Length of Comp,Work Area Only
Length of Comp,Work Area Only
time span start
Number
true
Number
the "time span start" setting of the render item a number that will determine the beginning time in the composition from which the render will start, this property overrides the "work area start" property
set the time from which the after effects will start rendering the composition
time span end
Number
true
Number
the "time span end" setting of the render item a number that will determine the ending time in the composition from which the render will end, this property overrides the "work area end" property
set the time from which the after effects will end rendering the composition
time span duration
Number
true
Number
the "time span duration" setting of the render item a number that will determine the duration time in the composition of the render, this property changes the "time span end" property
set the duration time of the render item
skip existing files
Boolean
true
Boolean
checks if the "skip existing files" setting of the render item is enabled
set to true to enable the "skip existing files" setting this setting available only on image sequence format, use this property to enable multi machine rendering
color depth
Array
true
Array
the "color depth" setting of the render item
set to one of the options: Current Settings,8 bits per channel,16 bits per channel,32 bits per channel
Current Settings,8 bits per channel,16 bits per channel,32 bits per channel
disk cache
Array
true
Array
the "disk cache" setting of the render item
set to one of the options: Current Settings,Read Only
Current Settings,Read Only
effects
Array
true
Array
the "effects" setting of the render item
set to one of the options: Current Settings,All On,All Off
Current Settings,All On,All Off
field render
Array
true
Array
the "field render" setting of the render item
set to one of the options: Off,Upper Field First,Lower Field First
Off,Upper Field First,Lower Field First
frame blending
Array
true
Array
the "frame blending" setting of the render item
set to one of the options: Current Settings,On for Checked Layers,Off for All Layers
Current Settings,On for Checked Layers,Off for All Layers
guide layers
Array
true
Array
the "guide layers" setting of the render item
set to one of the options: Current Settings,All Off
Current Settings,All Off
motion blur
Array
true
Array
the "motion blur" setting of the render item
set to one of the options: Current Settings,On for Checked Layers,Off for All Layers
Current Settings,On for Checked Layers,Off for All Layers
proxy use
Array
true
Array
the "proxy use" setting of the render item
set to one of the options: Current Settings,Use All Proxies,Use Comp Proxies Only,Use No Proxies
Current Settings,Use All Proxies,Use Comp Proxies Only,Use No Proxies
solo switches
Array
true
Array
the "solo switches" setting of the render item
set to one of the options: Current Settings,All Off
Current Settings,All Off
###Render Queue Item Object Actions
UiName
input parameter objectType
info
options
supportedVersion
delete
none
deletes the render job from the render queue panel
duplicate
none
duplicates the render job in the render queue panel
apply template by name
Text,Number,Boolean
applies a template to the "render settings" option specify the EXACT name of the template, for example "Draft Settings"
apply template from list
Array
applies a template to the "render settings" option using a list of all the templates that comes by default with after effects
Best Settings,Current Settings,DV Settings,Draft Settings,Multi-Machine Settings
add output module
none
adds an output module to the render job for rendering multiple file formats as different files at once
---
## Marker
Marker Object Properties
comment
Text
true
Text,Number,Boolean,Array
the text value of the marker at a specified time (the "time" property)
specify the text value of the marker
time
Number
true
Number
indicator for the time of an existing marker or a time in which a marker can be placed later
set this value to a number that represents a time (in seconds) in which a marker will be added/removed/adjusted
index
Number
false
none
indicator for the position of a specific marker in the order of the markers
label
Array
true
Array
the label color of the marker
none,Red,Yellow,Aqua,Pink,Lavender,Peach,Sea Foam,Blue,Green,Purple,Orange,Brown,Fuchsia,Cyan,Sandstone,Dark Green
16
duration
Number
true
Number
the duration of the marker (in seconds)
number of markers
Number
false
none
the number of markers in the layer/footage/composition
###Marker Object Actions
UiName
input parameter objectType
info
options
supportedVersion
add marker
Text,Number,Boolean
adds or overrides a marker at a specified time (the "time" property) with a specified comment text value specify a text value for the comment
delete marker
none
deletes a marker at the specified time (the "time" property)
---
## Property
Property Object Properties
name
Text
true
Text,Number,Boolean,Array
the displayed ui name of the property
specify a name for the property (works only for properties that can be named)
match name
Text
false
none
the unique id of the property
value
Text
true
Text,Number,Boolean,Array
the text value of the property at a specified time (the "time" property)
sets the value of the property (only works if the property doesn't contain keyframes) if there are keyframes use the property action "add key" instead if the property contains 2 or more values (for example positional or scale properties), type the 2 values with a comma (",") between them for example - 960,540
time
Number
true
Number
indicator for the time of an existing keyframe or a time in which a keyframe can be placed later
set this value to a number that represents a time (in seconds) in which a keyframe will be added/removed/adjusted
property selected
Boolean
true
Boolean
checks if the property is selected in the timeline
set to true to select the property
keyframe selected
Boolean
true
Boolean
checks if the keyframe is selected in the timeline
set to true to select the keyframe
speed in-out
Number
true
Number
the value of the keyframe velocity "speed In" and "speed out" option (if the values of the "influence in" and "influence out" are different, it only returns the value of the "influence in" property)
set this value to a number will used for both the "speed in" and "speed out" of the keyframe
speed in
Number
true
Number
the value of the keyframe velocity "speed in" option
speed out
Number
true
Number
the value of the keyframe velocity "speed out" option
influence in-out
Number
true
Number
the value of the keyframe velocity "influence in" and "influence out" option (if the values of the "influence in" and "influence out" are different, it only returns the value of the "influence in" property)
set this value to a number will used for both the "influence in" and "influence out" of the keyframe
influence in
Number
true
Number
the value of the keyframe velocity "influence in" option
influence out
Number
true
Number
the value of the keyframe velocity "influence out" option
hold keyframe
Boolean
true
Boolean
checks if the keyframe is hold keyframe
set true to convert the keyframe to hold keyframe
temporal interpolation in
Array
true
Array
the temporal interpolation in of the keyframe
Linear,Bezier,Continuous Bezier,Auto Bezier,Hold
temporal interpolation out
Array
true
Array
the temporal interpolation out of the keyframe
Linear,Bezier,Continuous Bezier,Auto Bezier,Hold
temporal interpolation in-out
Array
true
Array
the temporal interpolation in and out of the keyframe
Linear,Bezier,Continuous Bezier,Auto Bezier,Hold
rove across time
Boolean
true
Boolean
checks if the keyframe is roving
set true to rove the keyframe across time
index
Number
false
none
indicator for the position of a specific keyframe in the order of the keyframes
keyframe label
Array
true
Array
the label color of the keyframe (supported from AE 2022)
none,Red,Yellow,Aqua,Pink,Lavender,Peach,Sea Foam,Blue,Green,Purple,Orange,Brown,Fuchsia,Cyan,Sandstone,Dark Green
expression
Text
true
Text,Number,Boolean,Array
the expression text of the property (if exists)
specify an expression text for the property
is expression enabled
Boolean
true
Boolean
checks if the expression of the property is enabled (if exists)
set to true for enable the expression
expression error
Text
false
none
the error, if any, generated by evaluation of the text most recently set in expression
have keyframes
Boolean
false
none
checks if the property has keyframes
number of keyframes
Number
false
none
the number of keyframes in the property
this property
Property/Effect
false
none
this property
parent property
Property/Effect
false
none
the property group that is the immediate parent of this property
enabled
Boolean
true
Boolean
checks if the property is enabled
set to true to enable the property
modified
Boolean
false
none
checks if the property has been changed since its creation
value type
Array
false
none
the type of value stored in the property each type of data is stored and retrieved in a different kind of structure. all property objects store data according to one of these categories. No Value - stores no data 1 Value - a number value 2 Values - array of 2 values. for example, a Scale value might be "5.1, 100.0" 3 Values - array of 3 values. for example, an Anchor Point value might be "10.0, 20.2, 0.0" Color (3/4 Values) - array of 4 number values in the range 0.0-1.0. for example, "0.8, 0.3, 0.1, 1.0" Custom Value - custom property value, such as the Histogram property for the Levels effect Shape - the shape object encapsulates information describing a shape in a shape layer, or the outline shape of a Mask Text Value - the TextDocument object stores a value for a TextLayer's Source Text property
No Value,1 Value,2 Values,3 Values,Color - 3 Values,Custom Value,Marker,Layer Index,Mask Index,Shape,Text Value
property index
Number
false
none
The position index of this property within its parent group
property depth
Number
false
none
the number of levels of parent groups between this property and the containing layer. the value 1 represents the top level properties
number of sub-properties
Number
false
none
the number of child properties under this property group.
is effect
Boolean
false
none
checks if the property is an effect
is mask
Boolean
false
none
checks if the property is a mask
###Property Object Actions
UiName
input parameter objectType
info
options
supportedVersion
add key
Text,Number,Boolean
adds or overrides a keyframe value at a specified time (the "time" property) with a specified value specify a value for the keyframe
delete key
none
deletes a keyframe at the specified time (the "time" property)
delete all keyframes
none
deletes all the keyframes of the property
retime selected keyframes
Number
moves the selected keyframes of the property as a group to a specified time (in seconds) specify the time in which the keyframes will start at
retime all the keyframes
Number
moves all the keyframes of the property as a group to a specified time (in seconds) specify the time in which the keyframes will start at
offset selected keyframes
Number
shifts the selected keyframes of the property as a group by a specified amount time (in seconds) specify the amount of time (in seconds) that the selected keyframes will be shifted
offset all the keyframes
Number
shifts all the keyframes of the property as a group by a specified amount time (in seconds) specify the amount of time (in seconds) that the all the keyframes will be shifted
copy keyframe
Property/Effect
copies a specific keyframe from a specified property and paste it in this property at the time (the "time" property) of this property specify a property with a defined time of a keyframe (the "time" property)
delete property
none
deletes the property from the layer
set dropdown menu items
Text,Number,Boolean
sets parameters for a Dropdown Menu Control's Menu Property this action will overwrite the existing set of Menu items with the provided array of texts use comma (",") as a separation between the menu items for example - Menu item 1,Menu item 2,Menu item 3
---
## Number Collection
Number Collection Object Properties
index
Number
true
Number
indicator for the position of a specific element in the order of the collection (defaults to 1)
set this value to a number to gain access to the element at this position in the collection
element at index
Number
true
Number
the number at the current index (collection "index" property) of the collection
overrides the number at the current index (collection "index" property) of the collection
collection length
Number
false
none
the number of elements in the collection
separator
Text
true
Text,Number,Boolean,Array
a phrase that is used to separate a text to multiple parts
for example - set this value to "AND" to add "1AND2AND3" --> "1,2,3" as separate elements to the collection
all elements as text
Text
false
none
combines all the text elements with commas between them
all elements as text with separator
Text
false
none
combines all the text elements with a specified phrase (collection "separator" property) between them
user prompt style
Array
true
Array
the style of the user prompt window when running the collection action "show user prompt"
drop-down list,radio buttons
###Number Collection Object Actions
UiName
input parameter objectType
info
options
supportedVersion
add element
Number
adds a number to the collection
add element at index
Number
adds a number at the current index (collection "index" property) of the collection
remove element at index
none
removes an element at the current index (collection "index" property) of the collection
remove all
none
removes all the elements in the collection
add a list of numbers as elements
Text,Number,Boolean
adds all the numbers separated by a comma as individual number variables to a collection for example "1,2,3,4,5"
show user prompt
Text,Number,Boolean
opens a new window that asks the user to select one item from the collection the index (collection "index" property) of the collection will be changed to the selected item * you can change the window style using the collection "user prompt style" property (the default is drop-down list) specify a message for the user prompt window
---
## Text Collection
Text Collection Object Properties
index
Number
true
Number
indicator for the position of a specific element in the order of the collection (defaults to 1)
set this value to a number to gain access to the element at this position in the collection
element at index
Text
true
Text,Number,Boolean,Array
the text at the current index (collection "index" property) of the collection
overrides the text at the current index (collection "index" property) of the collection
collection length
Number
false
none
the number of elements in the collection
separator
Text
true
Text,Number,Boolean,Array
a phrase that is used to separate a text to multiple parts
for example - set this value to "AND" to add "1AND2AND3" --> "1,2,3" as separate elements to the collection
joined text
Text
false
none
combines all the text elements
all elements as text
Text
false
none
combines all the text elements with commas between them
all elements as text with separator
Text
false
none
combines all the text elements with a specified phrase (collection "separator" property) between them
user prompt style
Array
true
Array
the style of the user prompt window when running the collection action "show user prompt"
drop-down list,radio buttons
###Text Collection Object Actions
UiName
input parameter objectType
info
options
supportedVersion
add element
Text,Number,Boolean
adds a text to the collection
add element at index
Text,Number,Boolean
adds a text at the current index (collection "index" property) of the collection
remove element at index
none
removes an element at the current index (collection "index" property) of the collection
remove all
none
removes all the elements in the collection
add letters as elements
Text,Number,Boolean
adds all the letters of a specified text as individual text variables to a collection
add words as elements
Text,Number,Boolean
adds all the words of a specified text as individual text variables to a collection
add lines as elements
Text,Number,Boolean
adds all the lines of a specified text as individual text variables to a collection
add text elements by separator
Text,Number,Boolean
adds all the characters separated by a specified separator (collection "separator" property) as individual text variables to a collection
show user prompt
Text,Number,Boolean
opens a new window that asks the user to select one item from the collection the index (collection "index" property) of the collection will be changed to the selected item * you can change the window style using the collection "user prompt style" property (the default is drop-down list) specify a message for the user prompt window
separate csv data to rows
Text,Number,Boolean
adds all the rows of a specified csv text as individual text elements to a collection
separate csv row to cells
Text,Number,Boolean
adds all the cells of a specified csv row text as individual text elements to a collection
---
## Layer Collection
Layer Collection Object Properties
index
Number
true
Number
indicator for the position of a specific element in the order of the collection (defaults to 1)
set this value to a number to gain access to the element at this position in the collection
element at index
Layer
true
Layer
the layer at the current index (collection "index" property) of the collection
overrides the layer at the current index (collection "index" property) of the collection
collection length
Number
false
none
the number of elements in the collection
user prompt style
Array
true
Array
the style of the user prompt window when running the collection action "show user prompt"
drop-down list,radio buttons
###Layer Collection Object Actions
UiName
input parameter objectType
info
options
supportedVersion
add element
Layer
adds a layer to the collection
add element at index
Layer
adds a layer at the current index (collection "index" property) of the collection
remove element at index
none
removes an element at the current index (collection "index" property) of the collection
remove all
none
removes all the elements in the collection
show user prompt
Text,Number,Boolean
opens a new window that asks the user to select one item from the collection the index (collection "index" property) of the collection will be changed to the selected item * you can change the window style using the collection "user prompt style" property (the default is drop-down list) specify a message for the user prompt window
---
## Item Collection
Item Collection Object Properties
index
Number
true
Number
indicator for the position of a specific element in the order of the collection (defaults to 1)
set this value to a number to gain access to the element at this position in the collection
element at index
Item
true
Item
the item at the current index (collection "index" property) of the collection
overrides the item at the current index (collection "index" property) of the collection
collection length
Number
false
none
the number of elements in the collection
user prompt style
Array
true
Array
the style of the user prompt window when running the collection action "show user prompt"
drop-down list,radio buttons
###Item Collection Object Actions
UiName
input parameter objectType
info
options
supportedVersion
add element
Item
adds an item to the collection
add element at index
Item
adds an item at the current index (collection "index" property) of the collection
remove element at index
none
removes an element at the current index (collection "index" property) of the collection
remove all
none
removes all the elements in the collection
show user prompt
Text,Number,Boolean
opens a new window that asks the user to select one item from the collection the index (collection "index" property) of the collection will be changed to the selected item * you can change the window style using the collection "user prompt style" property (the default is drop-down list) specify a message for the user prompt window
---
## Property Collecection
Property Collecection Object Properties
index
Number
true
Number
indicator for the position of a specific element in the order of the collection (defaults to 1)
set this value to a number to gain access to the element at this position in the collection
element at index
Property/Effect
true
Property/Effect
the property/effect at the current index (collection "index" property) of the collection
overrides the property/effect at the current index (collection "index" property) of the collection
collection length
Number
false
none
the number of elements in the collection
###Property Collecection Object Actions
UiName
input parameter objectType
info
options
supportedVersion
add element
Property/Effect
adds a property/effect to the collection
add element at index
Property/Effect
adds a property/effect at the current index (collection "index" property) of the collection
remove element at index
none
removes an element at the current index (collection "index" property) of the collection
remove all
none
removes all the elements in the collection
---
## Boolean Collection
Boolean Collection Object Properties
index
Number
true
Number
indicator for the position of a specific element in the order of the collection (defaults to 1)
set this value to a number to gain access to the element at this position in the collection
element at index
Boolean
true
Boolean
the boolean at the current index (collection "index" property) of the collection
overrides the boolean at the current index (collection "index" property) of the collection
collection length
Number
false
none
the number of elements in the collection
separator
Text
true
Text,Number,Boolean,Array
a phrase that is used to separate a text to multiple parts
for example - set this value to "AND" to add "1AND2AND3" --> "1,2,3" as separate elements to the collection
all elements as text
Text
false
none
combines all the text elements with commas between them
all elements as text with separator
Text
false
none
combines all the text elements with a specified phrase (collection "separator" property) between them
###Boolean Collection Object Actions
UiName
input parameter objectType
info
options
supportedVersion
add element
Boolean
adds a boolean to the collection
add element at index
Boolean
adds a boolean at the current index (collection "index" property) of the collection
remove element at index
none
removes an element at the current index (collection "index" property) of the collection
remove all
none
removes all the elements in the collection
---
## Number Variable
Number Variable Object Properties
value
Number
true
Number
number value
specify a number
random minimum
Number
true
Number
the lowest possible value of a random number
random maximum
Number
true
Number
the highest possible value of a random number
round random
Boolean
true
Boolean
controls the rounding of a random number (defaults to true)
set to true for a round result
###Number Variable Object Actions
UiName
input parameter objectType
info
options
supportedVersion
randomize number
none
chooses a random number between the "random minimum" variable property value and the "random maximum" variable property value use the "round random" property to limit the results to round numbers only default values - "round random": true, "random minimum": 0, "random maximum": 100
round number
Number
rounds the value of a decimal number to a specified number of decimals by default it will round the closet integer, you can specify how many decimals needs to be in the number for example typing 0 will round 6.56 to 7, while typing 1 will round 6.56 to 6.6 specify the number of decimals (default is 0)
round up number
none
rounds the value of a decimal number to the nearest larger integer number (5.1 will be rounded to 6)
round down number
none
rounds the value of a decimal number to the nearest smaller integer number (5.9 will be rounded to 5)
snap to frame rate
Number
rounds the value to fit a certain frame rate specify the framerate number
convert text to number
Text,Number,Boolean
applies the value of a text variable to a number variable (if it contains a number)
---
## Text Variable
Text Variable Object Properties
value
Text
true
Text,Number,Boolean,Array
text value
specify a text
text element
Text
true
Text,Number,Boolean,Array
a phrase that's used to perform actions on the text value
contains text element
Boolean
false
none
checks if a phrase (a text element property value) appears in the text
starts with text element
Boolean
false
none
checks if a phrase (a text element property value) appears at the start of the text
ends with text element
Boolean
false
none
checks if a phrase (a text element property value) appears at the end of the text
text length
Number
false
none
the number of characters in the text
word count
Number
false
none
the number of words in the text
is number
Boolean
false
none
checks if the text value represents a valid number
number value
Number
false
none
returns a number if the text value represents a valid number (if the text does not represent a valid number it will return -1)
###Text Variable Object Actions
UiName
input parameter objectType
info
options
supportedVersion
find and replace text element
Text,Number,Boolean
replaces all the occurrences of the specified phrase (the "text element" property value) with a different phrase specify the text that you want to replace with
find and replace first text element
Text,Number,Boolean
replaces the first occurrence of the specified phrase (the "text element" property value) with a different phrase specify the text that you want to replace with
find and replace last text element
Text,Number,Boolean
replaces the last occurrence of the specified phrase (the "text element" property value) with a different phrase specify the text that you want to replace with
make uppercase
none
converts all the characters to uppercase letters
make lowercase
none
converts all the characters to lowercase letters
remove whitespace
none
removes all the spaces and empty lines in the beginning and the end of the text
remove after last text element
none
removes all the text characters after the last occurrence of the specified phrase (the "text element" property value)
remove before last text element
none
removes all the text characters before the last occurrence of the specified phrase (the "text element" property value)
remove after first text element
none
removes all the text characters after the first occurrence of the specified phrase (the "text element" property value)
remove before first text element
none
removes all the text characters before the first occurrence of the specified phrase (the "text element" property value)
convert rgb to hex color
Text,Number,Boolean
converts rgb color format value ("r,g,b" ==> 0.5,0.5,0.5) to hex color format ("52ab3c") rgb color format is the only color format that every after effects color property can accept while hex color format is mainly used in the user interface to view and select colors specify 3 numbers between 0-1 with a comma between them
convert hex to rgb color
Text,Number,Boolean
converts hex color format value ("52ab3c") to rgb color format ("r,g,b" ==> 0.5,0.5,0.5) rgb color format is the only color format that every after effects color property can accept while hex color format is mainly used in the user interface to view and select colors specify an hex color value for example: "52ab3c"
---
## Boolean Variable
Boolean Variable Object Properties
value
Boolean
true
Boolean
boolean value (true/false)
specify a boolean
###Boolean Variable Object Actions
UiName
input parameter objectType
info
options
supportedVersion
---
## Project
Project Object Properties
name
Text
false
none
the name of the current project file
color bit depth
Array
true
Array
the color bit depth of the project
8,16,32
linearize working space
Boolean
true
Boolean
the "linearize working space" option in the project settings
16
linear blending
Boolean
true
Boolean
the "blend colors using 1.0 gamma" option in the project settings
working space
Array
true
Array
the "working space" option of the project settings
none
16
working gamma
Array
true
Array
the "working gamma" option of the project settings
2.2(sRGB),2.4(Rec.709)
16
time display style
Array
true
Array
the "time display style" option of the project settings
timecode,frames
number of render queue items
Number
false
none
the number of items currently in the render queue (both pending and rendered)
number of items
Number
false
none
the total number of items contained in the project, including folders and all types of footage
operating system
Text
false
none
the type of the operating system (WINDOWS/MAC)
app version
Number
false
none
the after effects version
active comp
Item
false
none
the composition that is currently active and is to be acted upon
project file
File
false
none
the file of the current project
javascript variable inputs
Text
true
Text,Number,Boolean,Array
the variables that the javascript code can access
specify the variable names with commas between them. for example "variable1,variable2,variable3"
javascript code result
Text
false
none
the text output from the javascript code
is shift clicked
Boolean
false
none
checks if the shift key was pressed when running the automation
is alt clicked
Boolean
false
none
checks if the alt key was pressed when running the automation
is control clicked
Boolean
false
none
checks if the control key was pressed when running the automation
launched via shortcut
Boolean
false
none
checks if the automation was ran by using a keyboard shortcut
layer/item id
Number
true
Number
id value for a layer/item in the project this property used to set a unique id number value of a specific layer/item in the project use this property in combination with the project properties "layer by id" and "item by id" to get the layer/item variable of this specific id
set this value to a number that represent an id of a layer/item in the project
layer by id
Layer
none
the layer of a specific id in the project, using the id value of the "layer/item id" project property set the "layer/item id" project property value to a specific layer id number before using this property
item by id
Item
none
the item of a specific id in the project, using the id value of the "layer/item id" project property set the "layer/item id" project property value to a specific item id number before using this property
###Project Object Actions
UiName
input parameter objectType
info
options
supportedVersion
add composition
Text,Number,Boolean
creates a new composition specify the name of the new composition
add folder
Text,Number,Boolean
creates a new folder specify the name of the new folder
menu command
Text,Number,Boolean
simulates a click on any after effects ui menu option specify the EXACT name of the menu option
menu command id
Number
simulates a click on any after effects ui menu option by the id number of the menu item search online for the full "list of Menu Command ID's available for After Effects" specify the id (number) of the menu option
run javascript code
Text,Number,Boolean
runs a javascript code with access to some of the automation variables using the "javascript variable inputs" project property. use the "variables" javascript object to access the automation variables, for example -"variables[varName]" return a text value to the "javascript code result" project property using the javascript "return" operation * this action is disabled by default for security measures (read more in the settings) in order to use this action please enable the "Allow automation to run external javascript code" option in "edit information" >> "Advanced Settings" or enable this option globally in the settings window
start render
none
opens the render queue and starts rendering (freezes the software)
queue in adobe media encoder
Array
send all the render queue queued items to adobe media encoder specify if adobe media encoder should start rendering immediately
queue only,start rendering
remove unused footage
none
deletes any item that's not used in any composition
open project
File
opens a project file specify a file object
save as
File
saves the project. the same as the File > Save As command specify a file object * this action is disabled by default for security measures (read more in the settings), in order to use this action please enable the "Allow automation to create/modify external file" option in "edit information" >> "Advanced Settings" or enable this option globally in the settings window
copy to clipboard
Text,Number,Boolean
copies text to the clipboard so that the user can paste this text later specify the text
show project panel
Array
activates, shows or hides the project panel window
make active,show,hide
close project
Array
closes the project with the option of saving changes automatically, prompting the user to save changes or closing without saving changes
save changes,prompt to save changes,don't save changes
---
## File
File Object Properties
full name
Text
true
Text,Number,Boolean,Array
the full name of the file (with extension)
name
Text
true
Text,Number,Boolean,Array
the name of the file (without extension)
path
Text
true
Text,Number,Boolean,Array
full path for the file
use "/" forward slash as a separation between the folders and finish with the file name and extension example- C:/Users/Your User name/desktop/my_file.txt or ~/desktop/my_file.txt start with the "~" character to reference the user path
path encoded
Text
false
none
full path for the file with encoded characters
system path
Text
false
none
full system path for the file
data
Text
false
none
the text data of the file
exists
Boolean
false
none
checks if the file exists in the computer (using the file "path" property)
extension
Text
true
Text,Number,Boolean,Array
the extension of the file
date created
Text
false
none
the creation date of the file according to the "date format" file property
date modified
Text
false
none
the modification date of the file according to the "date format" file property
current date
Text
false
none
the current date according to the "date format" file property
date format
Text
true
Text,Number,Boolean,Array
a custom text formatting for a date
use the tokens D/DD/MM/YY/YYYY/mm/ss with any separator between them to create a custom formatted date for example DD_MM - YYYY will result 10_02 - 2022 Month - M --> 1 2 ... 11 12 , MM --> 01 02 ... 11 12 , MMM --> Jan Feb ... Nov Dec , MMMM --> January February ... November December Day of Month - D --> 1 2 ... 30 31 , Do --> 1st 2nd ... 30th 31st , DD --> 01 02 ... 30 31 Day of Week - d --> 0 1 ... 5 6 , ddd --> Sun Mon ... Fri Sat , dddd --> Sunday Monday ... Friday Saturday Year - YY --> 70 71 ... 29 30 , YYYY --> 1970 1971 ... 2029 2030 AM/PM - A --> AM PM , a --> am pm Hour - H --> 0 1 ... 22 23 , HH --> 00 01 ... 22 23 , h --> 1 2 ... 11 12 , hh --> 01 02 ... 11 12 Minutes - m --> 0 1 ... 58 59 , mm --> 00 01 ... 58 59 Seconds - s --> 0 1 ... 58 59 , ss --> 00 01 ... 58 59 Timezone - Z --> -07:00 -06:00 ... +06:00 +07:00 , ZZ --> -0700 -0600 ... +0600 +0700
size
Number
false
none
the size of the file (in bytes)
parent folder
Folder
false
none
the folder that contains this file
is image sequence
Boolean
true
Boolean
checks if the file is set as an image sequence file
imported item
Item
false
none
if the file was imported using the file "import" action, returns the project item for the imported file
this file
File
true
File
this file
specify a file
###File Object Actions
UiName
input parameter objectType
info
options
supportedVersion
import
Array
imports the file into the project returns the imported project item to the "imported item" file property
auto,file,image sequence
file select window
Text,Number,Boolean
opens a window that lets you choose a path to a file on your computer
file save window
Text,Number,Boolean
opens a window that lets you choose a path to a file that doesn't exit yet
create
Text,Number,Boolean
creates the file in the computer (using the "path" file property) *only if it does not already exist specify the text data for the file * this action is disabled by default for security measures (read more in the settings), in order to use this action please enable the "Allow automation to create/modify external file" option in "edit information" >> "Advanced Settings" or enable this option globally in the settings window
overwrite
Text,Number,Boolean
overwrites the content of the file (.atae extension only) in the computer (using the "path" file property) *only if it already exists * To prevent file contents loss due to human error only files with .atae extension can be overwritten so if you must overwrite an existing file you will first need to rename (in the os file system) the file extension to .atae and then overwrite the file specify the text data for the file * this action is disabled by default for security measures (read more in the settings), in order to use this action please enable the "Allow automation to create/modify external file" option in "edit information" >> "Advanced Settings" or enable this option globally in the settings window
rename
Text,Number,Boolean
renames the file specify a new name for the file * files with a standard extension cannot be turned into an (.atae) extension as a precaution * these characters cannot be used in the file name /:"*?<>
* this action is disabled by default for security measures (read more in the settings), in order to use this action please enable the "Allow automation to create/modify external file" option in "edit information" >> "Advanced Settings" or enable this option globally in the settings window
open
none
opens the file using the appropriate application, as if it had been double-clicked in a file browser
copy to
Folder
copies the file to a specified folder * this action is disabled by default for security measures (read more in the settings), in order to use this action please enable the "Allow automation to create/modify external file" option in "edit information" >> "Advanced Settings" or enable this option globally in the settings window
check image sequence
none
checks if the file is the first file of an image sequences and set the "is image sequence" file property value accordingly
---
## Folder
Folder Object Properties
name
Text
true
Text,Number,Boolean,Array
the name of the folder
path
Text
true
Text,Number,Boolean,Array
full path for the folder
use "/" forward slash as a separation between the folders and finish with the folder name example- C:/Users/Your User name/desktop or ~/desktop start with the "~" character to reference the user path
path encoded
Text
false
none
full path for the folder with encoded characters
system path
Text
false
none
full system path for the folder
number of files
Number
false
none
the number of files in the folder (not including folders)
number of folders
Number
false
none
the number of folders in the folder (not including files)
exists
Boolean
false
none
checks if the folder exists in the computer (using the folder "path" property)
date created
Text
false
none
the creation date of the folder according to the "date format" folder property
date modified
Text
false
none
the modification date of the folder according to the "date format" folder property
current date
Text
false
none
the current date according to the "date format" folder property
date format
Text
true
Text,Number,Boolean,Array
a custom text formatting for a date
use the tokens D/DD/MM/YY/YYYY/mm/ss with any separator between them to create a custom formatted date for example DD_MM - YYYY will result 10_02 - 2022 Month - M --> 1 2 ... 11 12 , MM --> 01 02 ... 11 12 , MMM --> Jan Feb ... Nov Dec , MMMM --> January February ... November December Day of Month - D --> 1 2 ... 30 31 , Do --> 1st 2nd ... 30th 31st , DD --> 01 02 ... 30 31 Day of Week - d --> 0 1 ... 5 6 , ddd --> Sun Mon ... Fri Sat , dddd --> Sunday Monday ... Friday Saturday Year - YY --> 70 71 ... 29 30 , YYYY --> 1970 1971 ... 2029 2030 AM/PM - A --> AM PM , a --> am pm Hour - H --> 0 1 ... 22 23 , HH --> 00 01 ... 22 23 , h --> 1 2 ... 11 12 , hh --> 01 02 ... 11 12 Minutes - m --> 0 1 ... 58 59 , mm --> 00 01 ... 58 59 Seconds - s --> 0 1 ... 58 59 , ss --> 00 01 ... 58 59 Timezone - Z --> -07:00 -06:00 ... +06:00 +07:00 , ZZ --> -0700 -0600 ... +0600 +0700
size
Number
false
none
the size of the folder (in bytes) *this action can be very slow on large folders and freeze the program while calculating the size
parent folder
Folder
false
none
the folder that contains this folder
this folder
Folder
true
Folder
this folder
specify a folder
###Folder Object Actions
UiName
input parameter objectType
info
options
supportedVersion
import
Text,Number,Boolean
imports the folder's content into the project
folder select window
Text,Number,Boolean
opens a window that lets you choose a path to a folder on your computer
create
none
creates the folder in the computer (using the "path" folder property) * this action is disabled by default for security measures (read more in the settings), in order to use this action please enable the "Allow automation to create/modify external file" option in "edit information" >> "Advanced Settings" or enable this option globally in the settings window
rename
Text,Number,Boolean
renames the folder specify a new name for the folder * these characters cannot be used in the folder name /:"*?<>
* this action is disabled by default for security measures (read more in the settings), in order to use this action please enable the "Allow automation to create/modify external file" option in "edit information" >> "Advanced Settings" or enable this option globally in the settings window
open
none
opens the folder in the platform-specific file browser, as if it had been double-clicked in a file browser
Was this helpful?