OutputModule object
app.project.renderQueue.item(index).outputModule(index)
An OutputModule object of a RenderQueueItem generates a single file or sequence via a render operation, and contains attributes and methods relating to the file to be rendered.
Attribute List
| Attribute | Reference | Description |
|---|---|---|
| file | “OutputModule file attribute” on page 111 | The path and name of the file to be rendered. |
| postRenderAction | “OutputModule postRenderAction attribute” on page 111 | An action to be taken after rendering. |
| name | “OutputModule name attribute” on page 111 | The user-interface name of the output module. |
| templates | “OutputModule templates attribute” on page 112 | All templates for the output module. |
| includeSourceXMP | “OutputModule includeSourceXMP attribute” on page 111 | When true, writes all source footage XMP metadata to the output file. |
Method List
| Method | Reference | Description |
|---|---|---|
| remove() | “OutputModule remove() method” on page 112 | Removes this output module from the render-queue item’s list. |
| saveAsTemplate() | “OutputModule saveAsTemplate() method” on page 112 | Saves a new output-module template. |
| applyTemplate() | “OutputModule applyTemplate() method” on page 110 | Applies an output-module template. templateName A string containing the name of the template to be applied. |
applyTemplate() method
app.project.renderQueue.item(index).outputModule(index).applyTemplate(templateName)
Applies the specified existing output-module template.
Paramters:
Returns: Nothing.
file attribute
app.project.renderQueue.item(index).outputModule(index).file
The ExtendScript File object for the file this output module is set to render.
Type: ExtendScript File object read/write
includeSourceXMP attribute
app.project.renderQueue.item(index).outputModule(index).includeSourceXMP
When true, writes all source footage XMP metadata to the output file. Corresponds to the Include Source XMP Metadata option in the Output Module Settings dialog box.
Type: Boolean read/write
name attribute
app.project.renderQueue.item(index).outputModule(index).name
The name of the output module, as shown in the user interface.
Type: String; read-only.
postRenderAction attribute
app.project.renderQueue.item(index).outputModule(index).postRenderAction
An action to be performed when the render operation is completed.Type: A PostRenderAction enumerated value (read/write); one of:
- postRenderAction.NONE
- postRenderAction.IMPORT
- postRenderAction.IMPORT_AND_REPLACE_USAGE
- postRenderAction.SET_PROXY
remove() method
app.project.renderQueue.item(index).outputModule(index).remove()
Removes this OutputModule object from the collection.
Paramters: None.
Returns: Nothing.
saveAsTemplate() method
app.project.renderQueue.item(index).outputModule(index).saveAsTemplate(name)
Saves this output module as a template and adds it to the templates array.
Paramters:
- name A string containing the name of the new template.
Returns: Nothing.
templates attribute
app.project.renderQueue.item(index).outputModule(index).templates
The names of all output-module templates available in the local installation of After Effects.
Type: Array of strings read-only