Render Settings¶

Render settings are stored as a RenderSettings TypedDict on the RenderQueueItem.settings attribute, with ExtendScript-compatible keys matching the format from RenderQueueItem.getSettings(GetSettingsFormat.NUMBER).

RenderSettings ¶

RenderSettings = TypedDict(
    "RenderSettings",
    {
        "3:2 Pulldown": PulldownSetting,
        "Color Depth": ColorDepthSetting,
        "Disk Cache": DiskCacheSetting,
        "Effects": EffectsSetting,
        "Field Render": FieldRender,
        "Frame Blending": FrameBlendingSetting,
        "Frame Rate": FrameRateSetting,
        "Guide Layers": GuideLayers,
        "Motion Blur": MotionBlurSetting,
        "Proxy Use": ProxyUseSetting,
        "Quality": RenderQuality,
        "Resolution": list,
        "Skip Existing Files": bool,
        "Solo Switches": SoloSwitchesSetting,
        "Time Span Duration": float,
        "Time Span End": float,
        "Time Span Start": float,
        "Time Span": TimeSpanSource,
        "Use comp's frame rate": float,
        "Use this frame rate": float,
    },
)

Render settings for a render queue item.

Keys match the ExtendScript RenderQueueItem.getSettings(GetSettingsFormat.NUMBER) output.

Example

from aep_parser import parse

project = parse("project.aep").project
for rq_item in project.render_queue.items:
    for output_module in rq_item.output_modules:
        settings = output_module.settings
        print(f"Video Output: {settings['Video Output']}")
        print(f"Dimensions: {output_module.width}x{output_module.height}")
        print(f"Color Mode: {settings['Color'].name}")
        print(f"Output Frame Rate: {output_module.frame_rate}")

Available Keys¶

Key	Type	Description
`"3:2 Pulldown"`	PulldownSetting	Pulldown phase setting
`"Color Depth"`	ColorDepthSetting	Color depth setting
`"Disk Cache"`	DiskCacheSetting	Disk cache setting
`"Effects"`	EffectsSetting	Effects setting
`"Field Render"`	FieldRender	Field render setting
`"Frame Blending"`	FrameBlendingSetting	Frame blending setting
`"Frame Rate"`	FrameRateSetting	Frame rate source
`"Guide Layers"`	GuideLayers	Guide layers setting
`"Motion Blur"`	MotionBlurSetting	Motion blur setting
`"Proxy Use"`	ProxyUseSetting	Proxy use setting
`"Quality"`	RenderQuality	Quality setting
`"Resolution"`	`list[int]`	Resolution factor `[x, y]` (e.g. `[1, 1]` = Full, `[2, 2]` = Half, `[3, 3]` = Third, `[4, 4]` = Quarter)
`"Skip Existing Files"`	`bool`	Whether to skip rendering if output file exists
`"Solo Switches"`	SoloSwitchesSetting	Solo switches setting
`"Time Span Duration"`	`float`	Duration in seconds
`"Time Span End"`	`float`	End time in seconds
`"Time Span Start"`	`float`	Start time in seconds
`"Time Span"`	TimeSpanSource	Time span source
`"Use comp's frame rate"`	`float`	The composition's frame rate
`"Use this frame rate"`	`float`	Custom frame rate value (when `"Frame Rate"` is `USE_THIS_FRAME_RATE`)

Enum Values¶

PulldownSetting¶

Member	Value	Label
`OFF`	0	`"Off"`
`WSSWW`	1	`"WSSWW"`
`SSWWW`	2	`"SSWWW"`
`SWWWS`	3	`"SWWWS"`
`WWWSS`	4	`"WWWSS"`
`WWSSW`	5	`"WWSSW"`

ColorDepthSetting¶

Member	Value	Label
`CURRENT_SETTINGS`	-1	`"Current Settings"`
`EIGHT_BITS_PER_CHANNEL`	0	`"8 bits per channel"`
`SIXTEEN_BITS_PER_CHANNEL`	1	`"16 bits per channel"`
`THIRTY_TWO_BITS_PER_CHANNEL`	2	`"32 bits per channel"`

FieldRender¶

Member	Value	Label
`OFF`	0	`"Off"`
`UPPER_FIELD_FIRST`	1	`"Upper Field First"`
`LOWER_FIELD_FIRST`	2	`"Lower Field First"`

FrameRateSetting¶

Member	Value	Label
`USE_COMP_FRAME_RATE`	0	`"Use comp's frame rate"`
`USE_THIS_FRAME_RATE`	1	`"Use this frame rate"`

RenderQuality¶

Member	Value	Label
`CURRENT_SETTINGS`	-1	`"Current Settings"`
`WIREFRAME`	0	`"Wireframe"`
`DRAFT`	1	`"Draft"`
`BEST`	2	`"Best"`

MotionBlurSetting¶

Member	Value	Label
`OFF_FOR_ALL_LAYERS`	0	`"Off for All Layers"`
`ON_FOR_CHECKED_LAYERS`	1	`"On for Checked Layers"`
`CURRENT_SETTINGS`	2	`"Current Settings"`

FrameBlendingSetting¶

Member	Value	Label
`OFF_FOR_ALL_LAYERS`	0	`"Off for All Layers"`
`ON_FOR_CHECKED_LAYERS`	1	`"On for Checked Layers"`
`CURRENT_SETTINGS`	2	`"Current Settings"`

EffectsSetting¶

Member	Value	Label
`ALL_OFF`	0	`"All Off"`
`ALL_ON`	1	`"All On"`
`CURRENT_SETTINGS`	2	`"Current Settings"`

ProxyUseSetting¶

Member	Value	Label
`USE_NO_PROXIES`	0	`"Use No Proxies"`
`USE_ALL_PROXIES`	1	`"Use All Proxies"`
`CURRENT_SETTINGS`	2	`"Current Settings"`
`USE_COMP_PROXIES_ONLY`	3	`"Use Comp Proxies Only"`

SoloSwitchesSetting¶

Member	Value	Label
`ALL_OFF`	0	`"All Off"`
`CURRENT_SETTINGS`	2	`"Current Settings"`

GuideLayers¶

Member	Value	Label
`ALL_OFF`	0	`"All Off"`
`CURRENT_SETTINGS`	2	`"Current Settings"`

DiskCacheSetting¶

Member	Value	Label
`READ_ONLY`	0	`"Read Only"`
`CURRENT_SETTINGS`	2	`"Current Settings"`

TimeSpanSource¶

Member	Value	Label
`LENGTH_OF_COMP`	0	`"Length of Comp"`
`WORK_AREA_ONLY`	1	`"Work Area Only"`
`CUSTOM`	2	`"Custom"`