comp

aeq. comp

Source:

Module dealing with comp objects.

Methods

(static) create(folderopt, optionsopt) → {CompItem}

Source:

Creates a comp with the given settings

Examples

Create a comp in the project root, with name "Example", and a duration of 10 seconds. And use default values for the other options

var comp = aeq.comp.create({
    name: 'Example',
    duration: 10
})

Create comp in a folder, with name "Example"

var comp = aeq.comp.create(compFolder, {
    name: "Example"
})

Create a comp with all default values

var comp = aeq.comp.create()
Parameters:
Name Type Attributes Default Description
folder FolderItem | object <optional>
 app.project

The folder to place the comp inside in the project panel. If not provided, this argument will be used as the options parameter.
options object <optional>

Comp settings:

Properties
Name Type Attributes Default Description
name string <optional>
 Comp

The name of the comp.
width number <optional>
 1920

Comp width, in pixels.
height number <optional>
 1080

Comp height, in pixels.
pixelAspect number <optional>
 1

Comp pixel aspect ratio.
duration number <optional>
 1

Comp duration, in seconds.
frameRate number <optional>
 24

Comp frame rate.
Returns:

The created comp item.

Type
CompItem

(static) getCompInQueue(comp, queuedOnlyopt) → {Array.<RenderQueueItem>}

Source:

Gets the RenderQueueItems that references a given comp.

Example

Get all `RenderQueueItem`s that references the comp.

var RQItems = aeq.comp.getCompInQueue( comp, false )
Parameters:
Name Type Attributes Default Description
comp CompItem

The comp to find in the Render Queue.
queuedOnly boolean <optional>
 true

Only get RenderQueueItems that are queued.
Returns:

The RenderQueueItems that references the comp

Type
Array.<RenderQueueItem>

(static) isInQueue(comp) → {boolean}

Source:

Check if a comp is in the Render Queue, regardless of it being queued or not.

Parameters:
Name Type Description
comp CompItem

The comp to find in the queue.
Returns:

True if comp is in the queue.

Type
boolean

(static) isQueued(comp) → {boolean}

Source:

Check if a comp is in the Render Queue and queued.

Parameters:
Name Type Description
comp CompItem

The comp to find the queue.
Returns:

True if the comp is queued.

Type
boolean