RenderQueue object
app.project.renderQueue
The RenderQueue object represents the render automation process, the data and functionality that is available
through the Render Queue panel of a particular After Effects project. Attributes provide access to items in the
render queue and their render status. Methods can start, pause, and stop the rendering process.
The RenderQueueItem object provides access to the specific settings for an item to be rendered. See “Render-
QueueItem object” on page 163.
Attributes
Methods
item() method
app.project.renderQueue.item(index)
Gets a specified item from the items collection.
Parameters: Returns: RenderQueueItem object.
Attribute Reference Description
rendering “RenderQueue rendering attribute” on page 162 When true, a render is in progress.
numItems “RenderQueue numItems attribute” on page 161 The total number of items in the render queue.
items “RenderQueue items attribute” on page 161 The collection of items in the render queue.
Method Reference Description
showWindow() “RenderQueue showWindow() method”
on page 162
Show or hides the Render Queue panel.
render() “RenderQueue render() method” on
page 161
Starts the rendering process; does not return until render is
complete.
pauseRendering() “RenderQueue pauseRendering()
method” on page 161
Pauses or restarts the rendering process.
stopRendering() “RenderQueue stopRendering()
method” on page 162
Stops the rendering process.
item() “RenderQueue item() method” on
page 160
Gets a render-queue item from the collection.
index The position index of the item. An integer in the range [0..numItems].
161
After Effects scripting reference RenderQueue object
items attribute
app.project.renderQueue.items
A collection of all items in the render queue. See “RenderQueueItem object” on page 163.
Type: RQItemCollection object; **read-only*
numItems attribute
app.project.renderQueue.numItems
The total number of items in the render queue.
Type: Integer; read-only
pauseRendering() method
app.project.renderQueue.pauseRendering(pause)
Pauses the current rendering process, or continues a paused rendering process. This is the same as clicking
Pause in the Render Queue panel during a render. You can call this method from an onStatusChanged or
onError callback. See “RenderQueueItem onStatusChanged attribute” on page 165 and “Application onError
attribute” on page 24.
Parameters: Returns: Nothing.
render() method
app.project.renderQueue.render()
Starts the rendering process. This is the same as clicking Render in the Render Queue panel. The method does
not return until the render process is complete. To pause or stop the rendering process, call pauseRendering()
or stopRendering() from an onError or onStatusChanged callback.
- To respond to errors during the rendering process, define a callback function in app.onError; see “Appli-
cation onError attribute” on page 24.
- To respond to changes in the status of a particular item while the render is progressing, define a callback
function in RenderQueueItem.onStatusChanged in the associated RenderQueueItem object; see “Render-
QueueItem onStatusChanged attribute” on page 165.
pause True to pause a current render process, false to continue a paused render.
162
After Effects scripting reference RenderQueue object
Parameters: None.
Returns: Nothing.
rendering attribute
app.project.renderQueue.rendering
When true, the rendering process is in progress or paused. When false, it is stopped.
Type: Boolean read-only
showWindow() method
app.project.renderQueue.showWindow(doShow)
Shows or hides the Render Queue panel.
Parameters: Returns: Nothing.
stopRendering() method
app.project.renderQueue.stopRendering()
Stops the rendering process. This is the same as clicking Stop in the Render Queue panel during a render. You
can call this method from an onStatusChanged or onError callback. See “RenderQueueItem onStatus-
Changed attribute” on page 165 and “Application onError attribute” on page 24.
Parameters: None.
Returns: Nothing.
doShow When true, show the Render Queue panel. When false, hide it.