Output Module

OutputModule

OutputModule(
    file_template: str,
    format_options: CineonFormatOptions
    | JpegFormatOptions
    | OpenExrFormatOptions
    | PngFormatOptions
    | TargaFormatOptions
    | TiffFormatOptions
    | XmlFormatOptions
    | None,
    frame_rate: float,
    include_source_xmp: 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.

Example

from aep_parser import parse

app = parse("project.aep")
om = app.project.render_queue.items[0].output_modules[0]
print(om.file)

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.

format_options

format_options: (
    CineonFormatOptions
    | JpegFormatOptions
    | OpenExrFormatOptions
    | PngFormatOptions
    | TargaFormatOptions
    | TiffFormatOptions
    | XmlFormatOptions
    | None
)

Format-specific render options for this output module. The concrete type depends on the output format:

• CineonFormatOptions for Cineon/DPX sequences
• JpegFormatOptions for JPEG sequences
• OpenExrFormatOptions for OpenEXR sequences
• PngFormatOptions for PNG sequences
• TargaFormatOptions for Targa sequences
• TiffFormatOptions for TIFF sequences
• XmlFormatOptions for XML-based formats (AVI, H.264, MP3, QuickTime, WAV)
• None for formats without parsed format options

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.

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.

settings

settings: OutputModuleSettings

OutputModuleSettings dict with ExtendScript-compatible keys. Includes "Video Output", "Audio Bit Depth", "Output Color Space", "Preserve RGB", "Convert to Linear Light", 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:

• key

  (str) –

  The setting key (e.g. "Video Output", "Audio Bit Depth").

• format

  (GetSettingsFormat, default: STRING ) –

  The output format.

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