project

aeq. project

Source:

[project description]

Methods

(static) findFolder(name, parentFolderopt) → {FolderItem|null}

Source:

Find folder by name in target folder.

Parameters:
Name Type Attributes Default Description
name string

Folder name to find.

parentFolder FolderItem | string <optional>
app.project.root

Folder to search in by name or item, or root if undefined.

Returns:

FolderItem with the name. Or null if not found.

Type
FolderItem | null

(static) getFolder(folder, parentFolderopt) → {FolderItem|null}

Source:

Gets folder item, or null if can't find

Parameters:
Name Type Attributes Default Description
folder FolderItem | string

Folder to get by name or item, or root if undefined

parentFolder FolderItem | string <optional>
app.project.root

Parent folder to search in by name or item, or root if undefined

Returns:

Target folder item, or null

Type
FolderItem | null

(static) getFolderOrRoot(folderopt) → {FolderItem}

Source:

Gets folder item, or root if undefined

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

Folder to get by name or item, or root if undefined

Returns:

Target folder item

Type
FolderItem

(static) getFolders(parentFolderopt) → {Array.<FolderItem>}

Source:

Gets all folders within target folder, or root

Parameters:
Name Type Attributes Default Description
parentFolder FolderItem | string <optional>
app.project.root

Folder to search in by name or item, or root if undefined

Returns:

ArrayEx of folder items

Type
Array.<FolderItem>

(static) getFootage() → {Array.<Item>}

Source:

Gets all footage items in project

Returns:

ArrayEx of project footage items

Type
Array.<Item>

(static) getOrCreateFolder(folder, parentFolderopt) → {FolderItem}

Source:

Gets folder item, or creates it if can't find

Parameters:
Name Type Attributes Default Description
folder FolderItem | string

Folder to get by name or item, or root if undefined

parentFolder FolderItem | string <optional>
app.project.root

Parent folder to search in by name or item, or root if undefined

Returns:

Target folder item

Type
FolderItem

(static) getSelectedComps() → {Array.<CompItem>}

Source:

Gets all comp items that are selected

Returns:

ArrayEx of all selected comp items

Type
Array.<CompItem>

(static) getSelectedFolders() → {Array.<FolderItem>}

Source:

Gets all folder items that are selected

Returns:

ArrayEx of all selected folder items

Type
Array.<FolderItem>

(static) getSelectedFootage() → {Array.<Item>}

Source:

Gets all footage items that are selected

Returns:

ArrayEx of all selected footage items

Type
Array.<Item>

(static) importFile(file, folderopt, optionsopt) → {Item}

Source:

Imports a file into After Effects.

Parameters:
Name Type Attributes Default Description
file string | File

The file to import.

folder string | FolderItem <optional>
app.project

The folder where the imported item will be placed.

options object <optional>

options for importOptions.

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

true if file should import as sequence.

Returns:

The imported item

Type
Item

(static) importFiles(fileArray, folderopt, optionsopt) → {Array.<Items>}

Source:

Imports array of files or paths to target folder

Parameters:
Name Type Attributes Description
fileArray Array.<File> | Array.<string>

Array of files or paths to import

folder FolderItem <optional>

Folder to import items to

options object <optional>

options for importOptions.

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

true if file should import as sequence.

Returns:

ArrayEx of imported items

Type
Array.<Items>

(static) importSequence(file, folderopt) → {Item}

Source:

Imports a sequence by file object or path

Parameters:
Name Type Attributes Description
file File | string

File or path of sequence to import

folder FolderItem <optional>

Folder to import items to

Returns:

Imported sequence

Type
Item

(static) moveToFolder(items, folder)

Source:

Moves item(s) to specified folder

Parameters:
Name Type Description
items Item | Array.<Item>

Item or array of items

folder FolderItem

Folder to move item(s) to

(static) quickSave() → {File}

Source:

Saves current AEP to current path

Returns:

File object of AEP

Type
File

(static) reduceToQueuedComps() → {Array.<CompItem>|null}

Source:

Reduces current project to only comps that are queued

Returns:

Array of queued comps, or null

Type
Array.<CompItem> | null

(static) save(pathopt) → {File}

Source:

Saves current AEP to target path, or prompts user if no path

Parameters:
Name Type Attributes Description
path string <optional>

Path to save AEP to

Returns:

File object of AEP

Type
File

(static) simpleImportFile(file, optionsopt) → {Item}

Source:

Like aeq.project.importFile, but without the extra.

Parameters:
Name Type Attributes Description
file File

File object to import

options object <optional>

options for importOptions

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

true if file should import as sequence

Returns:

The imported item

Type
Item