Skip to content

Output Module

OutputModule 

OutputModule(
    file_template: str,
    frame_rate: float,
    include_source_xmp: bool,
    output_color_space: str | None,
    preserve_rgb: bool,
    name: str,
    parent: RenderQueueItem,
    post_render_action: PostRenderAction,
    post_render_target_comp: CompItem,
    settings: OutputModuleSettings,
    templates: list[str],
    _project_color_depth: int,
    _project_name: str,
    _video_codec: str | None = None,
)

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.

See: https://ae-scripting.docsforadobe.dev/renderqueue/outputmodule/

Attributes

file 

file: str

The full path for the file this output module is set to render.

Resolves template variables like [compName], [width], [frameRate], etc. to their actual values based on the composition and render settings.

file_template 

file_template: str

The raw file path template, may contain [compName] and [fileExtension] variables.

frame_rate 

frame_rate: float

The output frame rate for this output module.

include_source_xmp 

include_source_xmp: bool

When True, writes all source footage XMP metadata to the output file.

name 

name: str

The name of the output module, as shown in the user interface.

output_color_space 

output_color_space: str | None

The output color space.

parent 

parent: RenderQueueItem = field(repr=False)

Reference to parent RenderQueueItem, used for resolving file paths and accessing comp and render settings.

post_render_action 

post_render_action: PostRenderAction

An action to perform when rendering is complete. Only used when post_render_action is IMPORT_AND_REPLACE or SET_PROXY. When 0 or None, uses the render queue item's comp.

post_render_target_comp 

post_render_target_comp: CompItem = field(repr=False)

The CompItem to use for post-render actions that require a comp. Only used when post_render_action is IMPORT_AND_REPLACE or SET_PROXY.

preserve_rgb 

preserve_rgb: bool

When True, disable color management conversions for this output module.

Note

Not exposed in ExtendScript.

settings 

settings: OutputModuleSettings

OutputModuleSettings dict with ExtendScript-compatible keys. Includes "Video Output", "Audio Bit Depth", "Audio Channels", "Color", etc. Matches the format from OutputModule.getSettings(GetSettingsFormat.NUMBER).

templates 

templates: list[str]

The names of all output-module templates available in the local installation of After Effects.

Functions

get_setting 

get_setting(
    key: str, format: GetSettingsFormat = STRING
) -> Any

Return a single output module setting in the specified format.

Parameters:

get_settings 

get_settings(
    format: GetSettingsFormat = STRING,
) -> dict[str, Any]

Return output module settings in the specified format.

Parameters:

  • format
    (GetSettingsFormat, default: STRING ) –

    The output format. GetSettingsFormat.NUMBER returns numeric values (enums unwrapped to ints). GetSettingsFormat.STRING returns all values as strings