Render Queue Item

RenderQueueItem ¶

RenderQueueItem(
    comment: str,
    comp: CompItem,
    elapsed_seconds: int,
    log_type: LogType,
    name: str,
    output_modules: list[OutputModule],
    queue_item_notify: bool,
    render: bool,
    settings: RenderSettings,
    skip_frames: int,
    start_time: datetime | None,
    status: RQItemStatus,
    time_span_duration_frames: int,
    time_span_start_frames: int,
    templates: list[str] = list(),
)

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

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.

comp ¶

comp: CompItem = field(repr=False)

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

comp_name ¶

comp_name: str

The name of the composition being rendered.

elapsed_seconds ¶

elapsed_seconds: int

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

log_type ¶

log_type: LogType

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

name ¶

name: str

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

output_modules ¶

output_modules: list[OutputModule]

The list of Output Modules for the item.

queue_item_notify ¶

queue_item_notify: bool

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

render ¶

render: bool

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

settings ¶

settings: RenderSettings

RenderSettings dict with ExtendScript-compatible keys matching getSettings() output. Contains quality, resolution, motion blur, frame blending, and other rendering options.

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.

start_time ¶

start_time: datetime | None

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

status ¶

status: RQItemStatus

The current render status of the item.

templates ¶

templates: list[str] = field(default_factory=list)

The names of all render-item templates available in the local installation of After Effects.

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.

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.

time_span_end ¶

time_span_end: float

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

time_span_end_frames ¶

time_span_end_frames: int

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

time_span_start ¶

time_span_start: float

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

time_span_start_frames ¶

time_span_start_frames: int

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

Functions¶

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

Render Queue Item