aeq

aeq

Source:

Classes

arrayEx
Comp
Key
Layer
Property
ui.Container
ui.Window

Namespaces

app
command
comp
file
layer
project
property
renderqueue
settings
snippet
ui

Members

(static) isMac :Boolean

Source:

true if system is a MacOS

Type:
  • Boolean

(static) isWindows :Boolean

Source:

true if system is a Windows

Type:
  • Boolean

Methods

(static) assertIsEmpty(o, err) → {Boolean}

Source:

Checks if array is empty. Throws an error if it is not.

Parameters:
Name Type Description
o Array

The array to check is empty.

err String

The error message to throw

Returns:

true if no error was thrown

Type
Boolean

(static) assertIsFalse(o, err) → {Boolean}

Source:

Checks if value is false. Throws an error if it is not.

Parameters:
Name Type Description
o Any

The value to check against false.

err String

The error message to throw

Returns:

true if no error was thrown

Type
Boolean

(static) assertIsNotEmpty(o, err) → {Boolean}

Source:

Checks if array is empty. Throws an error if it is.

Parameters:
Name Type Description
o Array

The array to check is empty.

err String

The error message to throw

Returns:

true if no error was thrown

Type
Boolean

(static) assertIsNotNull(o, err) → {Boolean}

Source:

Checks if value is null. Throws an error if it is.

Parameters:
Name Type Description
o Any

The value to check against null.

err String

The error message to throw

Returns:

true if no error was thrown

Type
Boolean

(static) assertIsNull(o, err) → {Boolean}

Source:

Checks if value is null. Throws an error if it is not.

Parameters:
Name Type Description
o Any

The value to check against null.

err String

The error message to throw

Returns:

true if no error was thrown

Type
Boolean

(static) assertIsTrue(o, err) → {Boolean}

Source:

Checks if value is true. Throws an error if it is not.

Parameters:
Name Type Description
o Any

The value to check against true.

err String

The error message to throw

Returns:

true if no error was thrown

Type
Boolean

(static) attr(array, attributeName, newValue) → {Any}

Source:

[description]

Parameters:
Name Type Description
array array

[description]

attributeName string

[description]

newValue Any

[description]

Returns:

[description]

Type
Any

(static) createResourceFiles(resources, folderPath, extension) → {Object}

Source:

Saves object of name:binaryContents pairs to files, returns object of files

Parameters:
Name Type Description
resources Object

Object of name:contents pairs

folderPath Folder | string

String path to a folder, or folder object

extension string

File extension to save files as

Returns:

Object of created files

Type
Object

(static) createUndoGroup(name, callback, args) → {any}

Source:

Creates an undoGroup and wraps passed function in it

Parameters:
Name Type Description
name string

Undo group name

callback function

Function to wrap in undo group

args any | array

Argument or array of arguments to pass to callback

Returns:

Returned value from function

Type
any

(static) error(err, args)

Source:

Creates and alerts an aequery error from a JS error

Parameters:
Name Type Description
err Error

JS error object

args type

[description]

(static) extend() → {Object}

Source:
See:
  • jQuery.extend for more information, this function uses the same api.

Merge the contents of two or more objects together into the first object.

If only one object is given, the aeq object is assumed to be the target.

Example
var objectA = {
    test: "example"
};

aeq.extend( objectA, {
    prop: "prop"
});

// ObjectA is now
{
    test: "example",
    prop: "prop"
}
Returns:

The merged object

Type
Object

(static) filter(obj, callback) → {Array}

Source:

Loops through arrays and objects and returns a filtered array

Parameters:
Name Type Description
obj Array | Object

The Array/object to loop through

callback forEachArrayCallback | forEachObjectCallback

The function to execute for each element in the object. Should return a truthy value if the element should be included in the returned array.

Returns:

The filtered array

Type
Array

(static) forEach(obj, callback) → {Array|Object}

Source:

Loops through arrays and objects

Parameters:
Name Type Description
obj Array | Object

The array or object to loop through.

callback forEachArrayCallback | forEachObjectCallback

Function to execute for each element in the object or array

Returns:

The value of obj

Type
Array | Object

(static) forEachComp(callback) → {aeq}

Source:

Loops through the comps in a project and executes a function for each one.

Parameters:
Name Type Description
callback forEachArrayCallback

The function to execute for each comp.

Returns:

The AEQuery library.

Type
aeq

(static) forEachComposition()

Source:
See:

(static) forEachEffect(objopt, callback) → {aeq}

Source:

Loops through the effects in a Comp, or on a Layer, and executes a function for each one.

Parameters:
Name Type Attributes Description
obj CompItem | Layer | Array | forEachArrayCallback <optional>

The object or array of objects to get effects from. If this is function, the function will loop through all properties in the project.

callback forEachArrayCallback

The function to execute for each effect

Returns:

The AEQuery library.

Type
aeq

(static) forEachItem(callback) → {aeq}

Source:

Loops through the Project items in a project and executes a function for each one.

Parameters:
Name Type Description
callback forEachArrayCallback

The function to execute for each item.

Returns:

The AEQuery library.

Type
aeq

(static) forEachLayer(objopt, callback) → {aeq}

Source:

Loops through the layers of a comp, array of comps, or all layers in the project, and executes a function for each one.

Parameters:
Name Type Attributes Description
obj CompItem | Array.<CompItem> | forEachArrayCallback <optional>

A CompItem or array of compItems to get layers from. If this is function, the function will loop through all layers in the project.

callback forEachArrayCallback

The function to execute for each layer

Returns:

The AEQuery library.

Type
aeq

(static) forEachOM()

Source:
See:

(static) forEachOutputModule(callback) → {aeq}

Source:

Loops through the output modules in the renderqueue and executes a function for each one.

Parameters:
Name Type Description
callback forEachArrayCallback

The function to execute for each Output Module.

Returns:

The AEQuery library.

Type
aeq

(static) forEachProp()

Source:
See:

(static) forEachProperty(objopt, callback) → {aeq}

Source:

Loops through the properties of a Comp, Layer, PropertyGroup, or an array of any of them, and executes a function for each one.

Parameters:
Name Type Attributes Description
obj CompItem | Layer | PropertyGroup | Array | forEachArrayCallback <optional>

The object or array of objects to get properties from. If this is function, the function will loop through all properties in the project.

callback forEachArrayCallback

The function to execute for each property

Returns:

The AEQuery library.

Type
aeq

(static) forEachRenderQueueItem(callback) → {aeq}

Source:

Loops through the items in the renderqueue and executes a function for each one.

Parameters:
Name Type Description
callback forEachArrayCallback

The function to execute for each renderQueue Item.

Returns:

The AEQuery library.

Type
aeq

(static) forEachRQItem()

Source:
See:

(static) framesToTime(frames, frameRate) → {number}

Source:

Converts frame count to time.

Parameters:
Name Type Description
frames number
frameRate number
Returns:
Type
number

(static) getActiveComp()

Source:
See:

(static) getActiveComposition() → {CompItem|null}

Source:

Gets the active CompItem. This gets app.project.activeItem and verifies that it is a comp. If it not, it returns null.

Returns:

The active comp, or null if there is none.

Type
CompItem | null

(static) getBinaryString(filePath) → {string}

Source:

Takes a file (or file path) and converts it to a binary string

Parameters:
Name Type Description
filePath File | string

Path or file to get data from

Returns:

Binary string of file data

Type
string

(static) getComp()

Source:
See:

(static) getComposition(name) → {CompItem|null}

Source:

Gets the CompItem with the matching name, or null if none is found.

Parameters:
Name Type Description
name string

The name of the comp to found

Returns:

The comp with the matching name, or null if none is found

Type
CompItem | null

(static) getCompositions() → {aeq.arrayEx}

Source:

Gets all the CompItems in the project

Returns:

Array of CompItems

Type
aeq.arrayEx

(static) getComps()

Source:
See:

(static) getEffects(layers) → {aeq.arrayEx}

Source:

Gets the propertyGroups inside the effects group from all layers given.

Parameters:
Name Type Description
layers Array.<Layer> | Layer

The Layer(s) to get effects from.

Returns:

Array of PropertyGroup objects

Type
aeq.arrayEx

(static) getFileObject(filePath) → {File}

Source:

Takes a file path or a file object, and returns a file object allows functions to be flexible in whether they take a path vs file

Parameters:
Name Type Description
filePath File | string

String path to a file, or file object

Returns:

Resolved file object

Type
File

(static) getFolderObject(folderPath) → {Folder}

Source:

Takes a folder path or a folder object, and returns a folder object allows functions to be flexible in whether they take a path vs folder

Parameters:
Name Type Description
folderPath Folder | string

String path to a folder, or folder object

Returns:

Resolved folder object

Type
Folder

(static) getItemInComps(item) → {aeq.arrayEx}

Source:

Gets the all layers where the given Item object is used as a source.

Parameters:
Name Type Description
item Item

The item to find in comps

Returns:

Array of Layer objects

Type
aeq.arrayEx

(static) getItems(folderopt) → {aeq.arrayEx}

Source:

Gets all the item in a folder or project.

Parameters:
Name Type Attributes Default Description
folder FolderItem <optional>
app.project

The Folder to get items from.

Returns:

Array of Item objects

Type
aeq.arrayEx

(static) getKeys(property) → {aeq.arrayEx}

Source:

Gets all keys on the given property or array of properties. Returns an aeq.Keys object which can be used to see all attributes of the key.

Parameters:
Name Type Description
property Property | Array.<Property>

The Property or Properties to get keys from.

Returns:

Array of aeq.Key objects.

Type
aeq.arrayEx

(static) getLayers(comps) → {aeq.arrayEx}

Source:

Gets all layers layers in a comp or an array of comps. This differs from comp.layers in that this returns an actual array. Instead of a colletion with a start index of 1.

Parameters:
Name Type Description
comps Array.<CompItem> | CompItem

CompItem(s) to get layers from.

Returns:

Layer objects in the comp(s)

Type
aeq.arrayEx

(static) getMarkerGroup(objopt) → {MarkerPropertyGroup|null}

Source:

Gets the Marker property group from the given layer or comp. If no object is given, the active comp is used. If there is no active comp, null is returned. Note: Marker groups for comps is only available for After Effects version 14.0 and later. If a comp is used in a earlier version. This function will return null

Parameters:
Name Type Attributes Description
obj Layer | CompItem <optional>

The object to get the marker group from.

Returns:
Type
MarkerPropertyGroup | null

(static) getModifiers() → {Object}

Source:

Returns a pressed-state object of modifier keys

Returns:

Pressed-states object of modifier keys

Type
Object

(static) getProperties(layers, optionsopt) → {aeq.arrayEx}

Source:

Gets all Property objects of all Layer objects in an array.

Parameters:
Name Type Attributes Description
layers Array.<Layer>

Layer Objects to get properties from.

options Object <optional>

Options for the function.

Properties
Name Type Description
separate boolean

set to true to separate properties (e.g separates Position into xPosition and yPosition). Default is true;

Returns:

Array of Property objects

Type
aeq.arrayEx

(static) getPropertyChildren(propertyParent, optionsopt) → {Array}

Source:

Gets all children of the given layer or propertyGroup. This is a recursive function, so it also gets grandchildren an so on.

Parameters:
Name Type Attributes Description
propertyParent Layer | PropertyGroup

Object to get properties from

options Object <optional>

Options for the function.

Properties
Name Type Description
separate boolean

set to true to separate properties (e.g separates Position into xPosition and yPosition). Default is true;

Returns:

Array of Property objects

Type
Array

(static) getSelectedLayers(compopt) → {aeq.arrayEx}

Source:

Gets selected layers from a given comp or from the active comp if no comp is given. If there is no active comp, an empty array is returned.

Parameters:
Name Type Attributes Description
comp CompItem <optional>

The comp to get selected layers from.

Returns:

Array of Layer objects.

Type
aeq.arrayEx

(static) getSelectedLayersOrAll(compopt) → {aeq.arrayEx}

Source:

Gets selected layers, or all layers if none is selected, from a given comp or from the active comp if no comp is given. If there is no active comp, an empty array is returned.

Parameters:
Name Type Attributes Description
comp CompItem <optional>

Comp to get layers from

Returns:

Array of Layer objects

Type
aeq.arrayEx

(static) getSelectedOrAllLayers()

Source:
See:

(static) getSelectedProperties(objopt) → {aeq.arrayEx}

Source:

Gets the selected properties on a layer or in a comp. Uses the active comp if no argument is given. If there is no active comp, an empty array is returned.

Parameters:
Name Type Attributes Description
obj CompItem | Layer <optional>

The object to get selected properties from. Defaults to the active comp.

Returns:

Array of Property objects

Type
aeq.arrayEx

(static) getSelectedProps()

Source:
See:

(static) getSystemInfo() → {string}

Source:

Gets a string containing current OS, AE version and AE language

Returns:

String containing current OS, AE version and AE language

Type
string

(static) isAeq(o) → {Boolean}

Source:

???

Parameters:
Name Type Description
o Any

The value to check

Returns:
Type
Boolean

(static) isApp(o) → {Boolean}

Source:

Returns true if argument is the Application object, false otherwise

Parameters:
Name Type Description
o Any

The value to check

Returns:
Type
Boolean

(static) isArr()

Source:
See:

(static) isArray(o) → {Boolean}

Source:

Returns true if argument is an array, false otherwise

Parameters:
Name Type Description
o Any

The value to check

Returns:
Type
Boolean

(static) isAVLayer(o) → {Boolean}

Source:

Returns true if argument is an AVLayer, false otherwise

Parameters:
Name Type Description
o Any

The value to check

Returns:
Type
Boolean

(static) isBool()

Source:
See:

(static) isBoolean(o) → {Boolean}

Source:

Returns true if argument is a boolean (true or false), false otherwise

Parameters:
Name Type Description
o Any

The value to check

Returns:
Type
Boolean

(static) isCamera()

Source:
See:

(static) isCameraLayer(o) → {Boolean}

Source:

Returns true if argument is a CameraLayer, false otherwise

Parameters:
Name Type Description
o Any

The value to check

Returns:
Type
Boolean

(static) isComp(o) → {Boolean}

Source:

Returns true if argument is a Compitem, false otherwise

Parameters:
Name Type Description
o Any

The value to check

Returns:
Type
Boolean

(static) isComposition()

Source:
See:

(static) isDir()

Source:
See:

(static) isEmpty(o) → {Boolean}

Source:

Returns true if the passed array is empty, false otherwise

Parameters:
Name Type Description
o Array

The array to check

Returns:
Type
Boolean

(static) isFile(o) → {Boolean}

Source:

Returns true if argument is a File object, false otherwise

Parameters:
Name Type Description
o Any

The value to check

Returns:
Type
Boolean

(static) isFolder(o) → {Boolean}

Source:

Returns true if argument is a Folder object, false otherwise

Parameters:
Name Type Description
o Any

The value to check

Returns:
Type
Boolean

(static) isFolderItem(o) → {Boolean}

Source:

Returns true if argument is a FolderItem, false otherwise

Parameters:
Name Type Description
o Any

The value to check

Returns:
Type
Boolean

(static) isFootageItem(o) → {Boolean}

Source:

Returns true if argument is a FootageItem, false otherwise

Parameters:
Name Type Description
o Any

The value to check

Returns:
Type
Boolean

(static) isFunc(o) → {Boolean}

Source:

Returns true if argument is a function, false otherwise

Parameters:
Name Type Description
o Any

The value to check

Returns:
Type
Boolean

(static) isFunction()

Source:
See:

(static) isLayer(o) → {Boolean}

Source:

Returns true if argument is any kind of layer, false otherwise

Parameters:
Name Type Description
o Any

The value to check

Returns:
Type
Boolean

(static) isLight()

Source:
See:

(static) isLightLayer(o) → {Boolean}

Source:

Returns true if argument is a LightLayer, false otherwise

Parameters:
Name Type Description
o Any

The value to check

Returns:
Type
Boolean

(static) isNullOrUndefined(o) → {Boolean}

Source:

Returns true if argument is null or undefined, false otherwise

Parameters:
Name Type Description
o Any

The value to check

Returns:
Type
Boolean

(static) isNum()

Source:
See:

(static) isNumber(o) → {Boolean}

Source:

Returns true if argument is a number, false otherwise

Parameters:
Name Type Description
o Any

The value to check

Returns:
Type
Boolean

(static) isObj()

Source:
See:

(static) isObject(o) → {Boolean}

Source:

Returns true if argument is an object, false otherwise. This will most likely return true most of the time, as most things are objects. Try to use a different function to check the type, if applicable.

Parameters:
Name Type Description
o Any

The value to check

Returns:
Type
Boolean

(static) isPanel(o) → {Boolean}

Source:

Returns true if argument is a Panel object, false otherwise

Parameters:
Name Type Description
o Any

The value to check

Returns:
Type
Boolean

(static) isPlainObject(o) → {Boolean}

Source:

Returns true if argument is a plain object, i.e an object created using {} or new Object(), false otherwise

Parameters:
Name Type Description
o Any

The value to check

Returns:
Type
Boolean

(static) isPrecomp(o) → {Boolean}

Source:

Returns true if a layer is a precomp, false otherwise

Parameters:
Name Type Description
o Layer

The layer to check

Returns:
Type
Boolean

(static) isProp()

Source:
See:

(static) isProperty(o) → {Boolean}

Source:

Returns true if argument is a Property, false otherwise

Parameters:
Name Type Description
o Any

The value to check

Returns:
Type
Boolean

(static) isPropertyGroup(o) → {Boolean}

Source:

Returns true if argument is a PropertyGroup, false otherwise

Parameters:
Name Type Description
o Any

The value to check

Returns:
Type
Boolean

(static) isShapeLayer(o) → {Boolean}

Source:

Returns true if argument is a ShapeLayer, false otherwise

Parameters:
Name Type Description
o Any

The value to check

Returns:
Type
Boolean

(static) isStr()

Source:
See:

(static) isString(o) → {Boolean}

Source:

Returns true if argument is a string, false otherwise

Parameters:
Name Type Description
o Any

The value to check

Returns:
Type
Boolean

(static) isTextLayer(o) → {Boolean}

Source:

Returns true if argument is a TextLayer, false otherwise

Parameters:
Name Type Description
o Any

The value to check

Returns:
Type
Boolean

(static) isWindow(o) → {Boolean}

Source:

Returns true if argument is a Window object, false otherwise

Parameters:
Name Type Description
o Any

The value to check

Returns:
Type
Boolean

(static) normalizeCollection(collection) → {aeq.arrayEx}

Source:

Collection arrays have indexes in the range 1-Collection.length, which is usually not ideal when programming. This function takes a Collection object and converts it to a normal array.

Parameters:
Name Type Description
collection Collection

The Collection to convert

Returns:
Type
aeq.arrayEx

(static) pasteKey(keyInfo) → {aeq.Key}

Source:

Pastes key info?

Parameters:
Name Type Description
keyInfo aeq.KeyInfo
Returns:

New key

Type
aeq.Key

(static) propertyType(property) → {type}

Source:

[description]

Parameters:
Name Type Description
property type

[description]

Returns:

[description]

Type
type

(static) readFile(filePath, encodingopt) → {string|null}

Source:

Returns the contents of a specified file

Parameters:
Name Type Attributes Default Description
filePath File | string

Path or file to read

encoding string <optional>
UTF-8

Encoding method

Returns:

Contents of the file, or null if file doesn't exist

Type
string | null

(static) reflect(obj) → {String}

Source:

???

Parameters:
Name Type Description
obj Object

The object

Returns:
Type
String

(static) select(selector, contextopt) → {ArrayEx}

Source:

Gets objects by looking at a string and finding objects in After Effects matching the description. The context is used to determine a starting point for where the function starts looking for elements.

Parameters:
Name Type Attributes Description
selector aeq.SelectorString

A string containing a selector expression

context CompItem | FolderItem | Layer | PropertyGroup | Array <optional>

The object to start looking from

Returns:

The found After Effects objects

Type
ArrayEx

(static) setDefault(value, defaultVal) → {Any}

Source:

Used for setting the default value in functions. Returns the first argument is not undefined, else it returns defaultVal.

Example
function say( greeting ) {
    a = aeq.setDefault( greeting, 'Hello World!' )
    alert( a )
}
Parameters:
Name Type Description
value Any

The value to check

defaultVal Any

The value to use if value is undefined

Returns:

value if it is not undefined, else defaultVal

Type
Any

(static) timeToFrames(time, frameRate) → {number}

Source:

Converts time to frame count.

Parameters:
Name Type Description
time number
frameRate number
Returns:
Type
number

(static) valueInObject(value, obj) → {type}

Source:

[description]

Parameters:
Name Type Description
value type

[description]

obj type

[description]

Returns:

[description]

Type
type

(static) writeFile(filePath, contents, optionsopt) → {File|null}

Source:

Writes data to a file, returns file

Parameters:
Name Type Attributes Description
filePath File | string

Path or file to write to

contents string

Data to write to the file

options object <optional>

Options for writing file.

Properties
Name Type Attributes Default Description
overwrite boolean <optional>
false

true if file should be overwritten if exists.

encoding string <optional>
"UTF-8"

Encoding method.

Returns:

New file, or null if file was not written correctly or file exits and overwrite = false

Type
File | null

Type Definitions

KeyInfo

Source:
Properties:
Name Type Description
property Property

Prop that the key lives on

value any

Key value

number time

Key time

interpolationType InterpolationType

In/out interpolation type

temporalEase TemporalEase

In/out temporal ease

spatialTangent SpatialTangent

In/out spatial tangents

temporalAutoBezier boolean

Whether key has temporal auto-Bezier interpolation

temporalContinuous boolean

Whether key has temporal continuity

spatialAutoBezier boolean

Whether key has spatial auto-Bezier interpolation

spatialContinuous boolean

Whether key has spatial continuity

roving boolean

Whether key is roving

SelectorString

Source:

The selectorString has 3 expression types:

  • type
  • props
  • pseudo

Type

The type of object to find, one of:

  • item: Finds items in the project panel
  • activecomp: Finds the active composition
  • comp/composition: Finds CompItems
  • layer: Finds Layers
  • propertygroup/propgrp/propgroup: Finds property groups
  • prop/property: Finds properties`
  • effect: Finds effects property groups
  • key: Finds keyframes on properties. Returns aeq.Key objects

The types can be chained after each other, but must be in the order above, but all of them are optional. Only the objects of the last specified type will be returned.

Type is the only expression type that is required. All other expression types are optional.

Props

written right after the type, without a space, and inside square brackes ([ ]). The props are a list attribute names and values, separated by =. The objects must have an attribute with the specified value to qualify as a match. Attributes are separated by a space.

Pseudo

Psoudo are a bit like props but start with a colon, :, followed by a keyword specifying how the attributes should match. The attributes are placed inside parenthesis ().

The keywords that are currently supported are:

  • :is(): all attributes must match.
  • :has(): same as :is()
  • :not(): objects should not have any attributes matching the props.
  • :isnot(): same as :not()

Psoudo selectors can be chained.

Type:
  • String
Examples

Get all comps with width and height of 1920x1080

    aeq("comp[width=1920 heigth=1080]")

Get all properties of layers that are selected and does not have audio:

    aeq("layer[selected hasAudio=false] prop")

Get properties that have `PropertyValueType.OneD` and are not selected.

    aeq("prop[propertyValueType=" + PropertyValueType.OneD + "]:not(selected)");

Get layers that do not have audio inside comps that are selected:

   aeq("comp:is(selected) layer:not(hasAudio)")