RenderQueueItem object
app.project.renderQueue.item(index)
The RenderQueueItem object represents an individual item in the render queue. It provides access to the specific settings for an item to be rendered. Create the object by adding a composition to the Render Queue with the RQItemCollection object; see “RQItemCollection add() method” on page 169.
Attributes
Methods
Attribute Reference Description numOutputModules “RenderQueueItem numOutputModules attribute” on page 165 The total number of Output Modules assigned to the item. render “RenderQueueItem render attribute” on page 166 When true, this item is rendered when the queue is started. startTime “RenderQueueItem startTime attribute” on page 167 The time when rendering began for the item. elapsedSeconds “RenderQueueItem elapsedSeconds attri- bute” on page 164 The time elapsed in the current rendering of this item. timeSpanStart “RenderQueueItem timeSpanStart attri- bute” on page 168 The start time in the composition to be rendered. timeSpanDuration “RenderQueueItem timeSpanDuration attribute” on page 168 The duration of the composition to be rendered. skipFrames “RenderQueueItem skipFrames attribute” on page 167 The number of frames to skip when rendering this item. comp “RenderQueueItem comp attribute” on page 164 The composition to be rendered by this item. outputModules “RenderQueueItem outputModules attri- bute” on page 166 The collection of Output Modules for this item. templates “RenderQueueItem templates attribute” on page 168 A set of Render Settings templates. status “RenderQueueItem status attribute” on page 167 The current rendering status of the item. onStatusChanged “RenderQueueItem onStatusChanged attri- bute” on page 165 A callback function that is called during the rendering process when the status of the item changes. logType “RenderQueueItem logType attribute” on page 165 A log type for this item. Method Reference Description outputModule() “RenderQueueItem outputModule() method” on page 166 Gets an Output Module for the item. remove() “RenderQueueItem remove() method” on page 16 6 Removes the item from the render queue. saveAsTemplate() “RenderQueueItem saveAsTemplate() method” on page 167 Saves a new Render Settings template. applyTemplate() “RenderQueueItem applyTemplate() method” on page 164 Applies a Render Settings template. duplicate “RenderQueueItem duplicate() method” on page 164 Duplicates this item. templateName A string containing the name of the template to apply.
applyTemplate() method
app.project.renderQueue.item(index).applyTemplate(templateName)
Applies a Render Settings template to the item. See also “RenderQueueItem saveAsTemplate() method” on
page 167 and “RenderQueueItem templates attribute” on page 168.
Parameters: Returns: Nothing.
comp attribute
app.project.renderQueue.item(index).comp
The composition that will be rendered by this render-queue item. To change the composition, you must delete
this render-queue item and create a new one.
Type: CompItem object; read-only
duplicate() method
app.project.renderQueue.item(index).duplicate()
Creates a duplicate of this item and adds it this render queue.
NOTE: Duplicating an item whose status is “Done” sets the new item’s status to “Queued”.
Parameters: None.
Returns: RenderQueueItem object.
elapsedSeconds attribute
app.project.renderQueue.item(index).elapsedSeconds
The number of seconds spent rendering this item.
Type: Integer, or null if item has not been rendered; read-only
logType attribute
app.project.renderQueue.item(index).logType
A log type for this item, indicating which events should be logged while this item is being rendered.
Type: A LogType enumerated value; (read/write). One of:
- LogType.ERRORS_ONLY
- LogType.ERRORS_AND_SETTINGS
- LogType.ERRORS_AND_PER_FRAME_INFO
numOutputModules attribute
app.project.renderQueue.item(index).numOutputModules
The total number of Output Modules assigned to this item.
Type: Integer; read-only
onStatusChanged attribute
app.project.renderQueue.item(index).onStatusChanged
The name of a callback function that is called whenever the value of the RenderQueueItem.status attribute changes. See “RenderQueueItem status attribute” on page 167. You cannot make changes to render queue items or to the application while rendering is in progress or paused; you can, however, use this callback to pause or stop the rendering process. See “RenderQueue pauseRen- dering() method” on page 161 and “RenderQueue stopRendering() method” on page 162. See also “Application onError attribute” on page 24.
Type: A function name string, or null if no function is assigned.
Example:
function myStatusChanged() {
alert(app.project.renderQueue.item(1).status)
}
app.project.renderQueue.item(1).onStatusChanged = myStatusChanged();
app.project.renderQueue.item(1).render = false; //changes status and shows dialog
outputModules attribute
app.project.renderQueue.item(index).outputModules
The collection of Output Modules for the item.
Type: OMCollection object; read-only
outputModule() method
app.project.renderQueue.item(index).outputModule(index)
Gets an output module with the specified index position.
Parameters:
- index The position index of the output module. An integer in the range [1..numOutputModules].
Returns: OutputModule object.
remove() method
app.project.renderQueue.item(index).remove()
Removes this item from the render queue.
Parameters: None.
Returns: Nothing.
render attribute
app.project.renderQueue.item(index).render
When true, the item will be rendered when the render queue is started. When set to true, the Render-
QueueItem.status is set to RQItemStatus.QUEUED. When set to false, status is set to RQItem-
Status.UNQUEUED.
Type: Boolean read/write.
saveAsTemplate() method
app.project.renderQueue.item(index).saveAsTemplate(name)
Saves the item’s current render settings as a new template with the specified name.
Parameters:
- name A string containing the name of the new template.
Returns: Nothing.
skipFrames attribute
app.project.renderQueue.item(index).skipFrames
The number of frames to skip when rendering this item. Use this to do rendering tests that are faster than a full render.
A value of 0 skip no frames, and results in regular rendering of all frames. A value of 1 skips every other frame. This is equivalent to "rendering on twos." Higher values skip a larger number of frames. The total length of time remains unchanged. For example, if skip has a value of 1, a sequence output would have half the number of frames and in movie output, each frame would be double the duration.
Type: Integer in the range [0..99]. Read/write.
startTime attribute
app.project.renderQueue.item(index).startTime
The day and time that this item started rendering.
Type: Date object, or null if the item has not started rendering; read-only
status attribute
app.project.renderQueue.item(index).status
The current render status of the item.
Type: An RQItemStatus enumerated value; read-only One of:
- RQItemStatus.WILL_CONTINUE Rendering process has been paused.
- RQItemStatus.NEEDS_OUTPUT Item lacks a valid output path.
- RQItemStatus.UNQUEUED Item is listed in the Render Queue panel but composition is not ready to render.
- RQItemStatus.QUEUED Composition is ready to render.
- RQItemStatus.RENDERING Composition is rendering
- RQItemStatus.USER_STOPPED Rendering process was stopped by user or script.
- RQItemStatus.ERR_STOPPED Rendering process was stopped due to an error.
- RQItemStatus.DONE Rendering process for the item is complete.
templates attribute
app.project.renderQueue.item(index).templates
The names of all Render Settings templates available for the item. See also “RenderQueueItem saveAsTem- plate() method” on page 167.
Type: Array of strings; read-only
timeSpanDuration attribute
app.project.renderQueue.item(index).timeSpanDuration
The duration in seconds of the composition to be rendered. The duration is determined by subtracting the start time from the end time. Setting this value is the same as setting a custom end time in the Render Settings dialog box.
Type: Floating-point value; read/write.
timeSpanStart attribute
app.project.renderQueue.item(index).timeSpanStart
The time in the composition, in seconds, at which rendering will begin. Setting this value is the same as setting a custom start time in the Render Settings dialog box.
Type: Floating-point value; read/write.