Render queue item

RenderQueueItem ¶

The RenderQueueItem object represents an individual item in the render queue. It provides access to the specific settings for an item to be rendered.

Example

from py_aep import parse

app = parse("project.aep")
rq_item = app.project.render_queue.items[0]
print(rq_item.status)
for output_module in rq_item:
    ...

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

Attributes¶

comment ¶

comment: str

A comment that describes the render queue item. This shows in the Render Queue panel. Read / Write.

comp ¶

comp: CompItem

The composition that will be rendered by this render-queue item. Read-only.

comp_name ¶

comp_name: str

The name of the composition being rendered.

elapsed_seconds ¶

elapsed_seconds = ChunkField[int](
    "_ldat", "elapsed_seconds", read_only=True
)

The number of seconds that have elapsed in rendering this item. Read-only.

log_type ¶

log_type = enum(LogType, '_ldat', 'log_type')

A log type for this item, indicating which events should be logged while this item is being rendered. Read / Write.

name ¶

name = ChunkField[str]('_ldat', 'template_name')

The name of the render settings template used for this item. Read / Write.

num_output_modules ¶

num_output_modules: int

Return the number of output modules for this render queue item. Read-only.

Note

Equivalent to len(item.output_modules)

output_modules ¶

output_modules: list[OutputModule]

The list of Output Modules for the item. Read-only.

parent ¶

parent: RenderQueue

The RenderQueue containing this item. Read-only.

queue_item_notify ¶

queue_item_notify = ChunkField[bool](
    "_ldat", "queue_item_notify", min_version=22
)

When True, a user notification is enabled for this render queue item, signaling the user upon render completion. Read / Write.

render ¶

render: bool

When True, the item will be rendered when the render queue is started. Read / Write.

settings ¶

settings: SettingsView

[SettingsView][py_aep.models.settings.SettingsView] dict built live from the binary chunk, with ExtendScript-compatible keys matching get_settings() output.

Supports item assignment:

Example

rqi.settings["Quality"] = RenderQuality.BEST

skip_frames ¶

skip_frames: int

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.

Read / Write.

start_time ¶

start_time: ChunkField[datetime | None] = ChunkField(
    "_ldat",
    "start_time",
    transform=_start_time_from_binary,
    read_only=True,
)

The date and time when rendering of this item started, or None if the item has not started rendering. Read-only.

status ¶

status = enum(
    RQItemStatus,
    "_ldat",
    "status",
    post_set="_on_status_changed",
)

The current render status of the item. Read / Write.

templates ¶

templates: list[str]

Available render settings template names.

Requires ae_preferences_dir to have been passed to parse(). Returns an empty list if no preferences directory was provided.

time_span_duration ¶

time_span_duration: float

The duration in seconds of the composition to be rendered. The duration is determined by subtracting the start time from the end time. Read / Write.

Setting this switches the time span source to CUSTOM.

time_span_duration_frames ¶

time_span_duration_frames: int

The duration in frames of the composition to be rendered. The duration is determined by subtracting the start time from the end time. Read / Write.

Setting this switches the time span source to CUSTOM.

time_span_end ¶

time_span_end: float

The time in the composition, in seconds, at which rendering will end. Read / Write.

Setting this adjusts the duration, keeping the start unchanged, and switches the time span source to CUSTOM.

time_span_end_frame ¶

time_span_end_frame: int

The time in the composition, in frames, at which rendering will end. Read / Write.

Setting this adjusts the duration in frames, keeping the start unchanged, and switches the time span source to CUSTOM.

time_span_start ¶

time_span_start: float

The time in the composition, in seconds, at which rendering will begin. Read / Write.

Setting this switches the time span source to CUSTOM.

time_span_start_frame ¶

time_span_start_frame: int

The time in the composition, in frames, at which rendering will begin. Read / Write.

Setting this switches the time span source to CUSTOM.

Functions¶

add ¶

add() -> OutputModule

Add an output module to this render queue item.

Creates a new OutputModule with default settings (or the default template if ae_preferences_dir was passed to parse()).

Returns:

OutputModule –

The newly created OutputModule.

apply_template ¶

apply_template(name: str) -> None

Apply a render settings template by name.

Looks up the template from the AE preferences data (requires ae_preferences_dir in parse()) and copies its settings to this render queue item.

Parameters:

name (str) –

Template name (e.g. "Best Settings", "Draft Settings").

Raises:

ValueError –

If the template name is not found.

duplicate ¶

duplicate() -> RenderQueueItem

Create a duplicate of this item in the render queue.

Returns the new RenderQueueItem. If the original item's status is DONE or ERR_STOPPED, the duplicate's status is set to QUEUED.

get_setting ¶

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

Return a single render setting in the specified format.

Parameters:

key (str) –

The setting key (e.g. "Quality", "Frame Rate").
format (GetSettingsFormat, default: STRING ) –

The output format.

get_settings ¶

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

Return render 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

remove ¶

remove() -> None

Remove this item from the render queue.