Namespace: DuAE

DuAE

After Effects general tools

Members

static,readonlyDuAE.Axisint

The axis or channels
Properties:
Name Type Default Description
X int 1
Y int 2
Z int 3
RED int 4
GREEN int 5
BLUE int 6
ALPHA int 7
HUE int 8
SATURATION int 9
VALUE int 10

static,readonlyDuAE.ColorLabels

Default color labels
TODO
  • get real labels (from pref file?)

staticDuAE.CompactExpressionObject

Associative array that converts property match names to their compact English expression statements.
Example
DuAE.CompactExpression["ADBE Transform Group"]
//returns "'transform'"

staticDuAE.DuAELayeredFileTypeDuList

List of file extensions whih may be imported as several items with the same source

static,readonlyDuAE.LayerAttributestring

Attributes of layers in Ae
Properties:
Name Type Default Description
SELECTED string selected
VISIBLE string visible
AUDIO string audio
SOLO string solo
LOCKED string locked
SHY string shy
EFFECTS_ENABLED string effects
MOTION_BLUR string motionblur
THREE_D string 3d
GUIDE string guide

static,readonlyDuAE.LayerPlacementint

How to place new layers
Properties:
Name Type Default Description
BOTTOM int 0
UNDER_LAYER int 1
ABOVE_LAYER int 2
TOP int 3

static,readonlyDuAE.LayerTypestring

Types of layers used by Ae
Properties:
Name Type Default Description
NULL string null
SOLID string solid
SHAPE string shape
TEXT string text
ADJUSTMENT string adjustment
LIGHT string light
CAMERA string camera

static,readonlyDuAE.LoopTypestring

Loop types
Properties:
Name Type Default Description
HOLD string hold
NONE string none
CYCLE string cycle
PINGPONG string pingpong
OFFSET string offset
CONTINUE string continue

static,readonlyDuAE.MenuCommandIDint

Menu Command Ids
These are the ids which can be found using app.findMenuCommandID("insertMenuNameHere");
Use app.executeCommand(id) to run them.
Properties:
Name Type Default Description
CUT int 18
COPY int 19
COPY_WITH_PROPERTY_LINKS int 10310
PASTE int 20
DUPLICATE int 2080
UNDO int 16
GENERAL_PREFERENCES int 2359
SCRIPTING_PREFERENCES int 3131
LAYER_CONTROLS int 2435
REVEAL_EXPRESSION_ERRORS int 2731
CONVERT_AUDIO_TO_KEYFRAMES int 4218
Example
app.executeCommand(DuAE.MenuCommandID.COPY); //copies the selection
app.executeCommand(DuAE.MenuCommandID.PASTE); //pastes the selection

static,readonlyDuAE.PrefTypeint

The type of AE preferences
Properties:
Name Type Default Description
BOOL int 0
STRING int 1
FLOAT int 2
LONG int 3

static,readonlyDuAE.SelectionModeint

Enum for selections
Properties:
Name Type Default Description
SELECTED_PROPERTIES int 0
SELECTED_LAYERS int 1
ACTIVE_COMPOSITION int 2
SELECTED_COMPOSITIONS int 3
ALL_COMPOSITIONS int 4

static,readonlyDuAE.TimeAlignmentstring

How to align in time
Properties:
Name Type Default Description
CENTER string center
IN_POINT string in
OUT_POINT string out

static,readonlyDuAE.Typeint

Types of values
Properties:
Name Type Default Description
VALUE int 1
SPEED int 2
VELOCITY int 3

static,readonlyDuAE.Unitstring

Abbreviated units used in the UI.
These strings are localized based on internal After Effects dictionnaries.
Properties:
Name Type Default Description
PIXELS string
DEGREES string
PERCENT string

static,readonlyDuAE.UnitTextstring

Units used in the UI
These strings are localized based on internal After Effects dictionnaries.
Properties:
Name Type Default Description
PERCENT string
DEGREES string
PIXELS string

static,readonlyDuAE.versionDuVersion

Informations about the version of after effects.

Methods

staticDuAE.beginUndoGroup(groupName, autoClose)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 17712
Begins an undoGroup.
Automatically prepend the group name with the script name.
Using this method is safer than the native one, as DuAEF will try to avoid opening several undo groups at once.
The group name is translatable.
Name Type Default Description
groupName string The name of the Undo Group.
autoClose boolean true optional By default, DuAEF will close any previously opened undogroup (which has a different name) to prevent any error.
Set this to false in order to ignore this new group beginning and keep the previously opened one.

staticDuAE.convertCollectionToArray(collection){Array}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 17896
Converts an AE Collection to an Array
This method is deprecated, you should use a DuList otherwise
Name Type Description
collection Array | Collection The collection to convert
Deprecated
  • Yes
Returns:
Type Description
Array The array

staticDuAE.copy()

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 17784
Copies the selection (runs the copy menu command)
D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 17800
Copies the selection with property links (runs the copy menu command)
Only on versions of After Effects greater than 11.0 (CS6)
On CS6 and below, a standard copy will be done.

staticDuAE.cut()

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 17777
Cuts the selection (runs the cut menu command)

staticDuAE.duplicate()

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 17791
Duplcates the selection (runs the duplicate menu command)

staticDuAE.endUndoGroup(groupName)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 17734
Ends an undoGroup.
Using this method is safer than the native one, as DuAEF will try to avoid opening several undo groups at once.
Name Type Description
groupName string optional The name of the Undo Group to end. Use this if you used DuAE.beginUndoGroup with the 'autoClose' argument set to false before.

staticDuAE.executeCommand(commandID)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 17746
Runs app.executeCommand in a safer way, taking care of undogroups.
Name Type Description
commandID int | string The ID of the command as given by app.findMenuCommandID(), or if it is a string, the name of the command.

staticDuAE.getAeRender(){File|null}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 17685
Gets the aerender binary
Returns:
Type Description
File | null The aerender binary, or null if not found

staticDuAE.getAEVersion(versionAsFloat){DuVersion}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 17638
Gets the version of After Effects from its public name (like 13.8 for CC2015.3)
Name Type Description
versionAsFloat float optional The version name.
Returns:
Type Description
DuVersion The version.

staticDuAE.getAEVersionName(versionAsFloat){string}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 17608
Gets the public name of a version of After Effects (like CC2015.3 for version 13.8)
Name Type Description
versionAsFloat float optional The version as a float. If not provided, will default to the current version of the running instance of After Effects.
Returns:
Type Description
string The version name.

staticDuAE.getCompactExpression(matchName, name, prop)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 17502
Gets the compact expression synonym of a matchName
Name Type Description
matchName string The matchName of a property
name string optional A replacement name (or index) in case the compact expression does not exist. If omitted, the matchName will be used.
prop Proeprty optional The original property; may be needed to differenciate between 3D layers / cam / lights, etc

staticDuAE.getDuAEProperty(props){Array.<DuAEProperty>}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 17562
Gets the DuAEProperty for the properties
Name Type Description
props Array.<PropertyBase> The Properties
Returns:
Type Description
Array.<DuAEProperty> The info

staticDuAE.getPref(section, key, file, type){any|null}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 17538
Gets a pref
Name Type Default Description
section string The section of the preferences
key string The key
file PREFType PREFType.PREF_Type_MACHINE_SPECIFIC optional The preference file, from the PREFType enum value of the After Effects API
type DuAE.PrefType DuAE.PrefType.STRING optional The type of the preference to return
Returns:
Type Description
any | null The pref or null if it does not exists

staticDuAE.hasPref(section, key, file){Boolean}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 17522
Checks if After Effects has the given preference
Name Type Default Description
section string The section of the preferences
key string The key
file PREFType PREFType.PREF_Type_MACHINE_SPECIFIC optional The preference file, from the PREFType enum value of the After Effects API
Returns:
Type Description
Boolean true if the pref exists

staticDuAE.isAutoSaveFolder(folder){boolean}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 17824
Checks if the Folder is an Auto-Save folder
Name Type Description
folder Folder | string The folder or path to check
Returns:
Type Description
boolean true if the folder is an auto-save folder

staticDuAE.isDebuggerEnabled(){Boolean}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 17598
Checks if the javascript debugger is enabled
Returns:
Type Description
Boolean true if the debugger is enabled.

staticDuAE.isLayeredFile(file){boolean}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 17581
Checks if the file is a layered type (psd, ai, psb, fla...)
Name Type Description
file String | File optional The file or the path
Returns:
Type Description
boolean true if it's a layered file

staticDuAE.isVersionAtLeast(versionName){boolean}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 17676
Checks if the current version is at least a given one
Name Type Description
versionName string The minimum version
Returns:
Type Description
boolean True if the current version is higher or the same

staticDuAE.isVersionHigherThan(versionName){boolean}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 17666
Checks if the current version is higher than a given one
Name Type Description
versionName string The minimum version
Returns:
Type Description
boolean True if the current version is higher (strict, will be false if they're equal)

staticDuAE.openScriptUIPanel(panelScriptName)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 17761
Opens a ScriptUI Panel if it is installed, or displays an alert otherwise.
Name Type Description
panelScriptName string The Script name of the panel "script.jsx"

staticDuAE.paste()

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 17808
Pastes the selection (runs the paste menu command)

staticDuAE.scriptFolders(suboflder){Array.<Folder>}

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 17853
Gets the list of folders where scripts may be installed
Name Type Description
suboflder string optional The name of a subfolder, like "ScriptUI Panels" or "Startup" or "Shutdown"...
Returns:
Type Description
Array.<Folder> the list of Folder objects.

staticDuAE.toggleLayerControls()

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 17844
Shows/hides the layer controls

staticDuAE.undo()

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 17815
Undoes (runs the undo command)