asyncio wrapper for Adobe After Effects aerender
Render Adobe After Effects projects using Python
aerender is an asyncio wrapper over
aerender (Adobe After Effects 2019)
built and tested on Windows 10. It can be used to automate the rendering of
After Effects projects.
pip install aerender
- To render just Comp 1 to a specified file:
from pathlib import Path
from aerender import AERenderWrapper
if __name__ == '__main__':
AERENDER_FULLPATH = Path('C:/Program Files/Adobe/Adobe After Effects CC 2019/Support Files/aerender')
aerender = AERenderWrapper(exe_path=AERENDER_FULLPATH)
coro = aerender.run(
Below you can see the
-help output of
aerender executable on Windows.
aerenderrenders After Effects comps. The render may be performed either by an already running instance of AE or by a newly invoked instance. By default,
aerenderwill invoke a new instance of AE, even if one is already running. To change this, see the
aerendertakes a series of optional arguments.
Some are single flags, like
-reuse. Some come in flag-argument pairs, like
-project project_path. And one comes in a triplet,
-mem_usage image_cache_percent max_mem_percent.
aerenderwith 0 arguments, or with any argument equaling
-h, prints this usage message.
The arguments are:
-hprint this usage message
-helpprint this usage message
-reuseuse this flag if you want to try and reuse an already running instance of AE to perform the render. By default, aerender will launch a new instance of After Effects, even if one is already running. But, if AE is already running, and the
-reuseflag is provided, then
aerenderwill ask the already running instance of AE to perform the render. Whenever
aerenderlaunches a new instance of AE, it will tell AE to quit when rendering is completed; otherwise, it will not quit AE. Also, the preferences will be written to file upon quit when the
-reuseflag is specified; otherwise it will not be written.
project_pathis a file path or URI specifying a project file to open. If none is provided, aerender will work with the currently open project. If no project is open and no project is provided, an error will result.
project_nameis a name of a team project to open.
comp_namespecifies a comp to be rendered. If the comp is in the render queue already, and in a queueable state, then (only) the first queueable instance of that comp on the render queue will be rendered. If the comp is in the project but not in the render queue, then it will be added to the render queue and rendered. If no
-compargument is provided,
aerenderwill render the entire render queue as is. In this case (no
-comp), the only other arguments used will be
-iarguments will be ignored.
index_in_render_queuespecifies a render queue item to be rendered. Options that make sense when rendering a single render queue item are available like with the
render_settings_templateis the name of a template to apply to the render queue item.If the template does not exist it is an error. Default is to use the render template already defined for the item.
output_module_templateis the name of a template to apply to the output module. If the template does not exist it is an error. Default is to use the template already defined for the output module.
output_pathis a file path or URI specifying the destination render file. Default is the path already in the project file.
logfile_pathis a file path or URI specifying the location of the log file. Default is stdout.
start_frameis the first frame to render. Default is the start frame in the file.
end_frameis the last frame to render. Note, this is "inclusive;" the final frame will be rendered. Default is the end frame in the file.
incrementis the number of frames to advance before rendering a new frame. A value of 1 (the default) results in a normal rendering of all frames. Higher increments will repeat the same (frame increment-1) times and then render a new one, starting the cycle again. Higher values result in faster renders but choppier motion. Default is 1.
-mem_usage image_cache_percent max_mem_percentwhere
image_cache_percentspecifies the maximum percent of memory used to cache already rendered images/footage, and
max_mem_percentspecifies the total percent of memory that can be used by After Effects.
verbose_flagspecifies the type of messages reported. Possible values are
ERRORS(prints only fatal and problem errors) or
ERRORS_AND_PROGRESS(prints progress of rendering as well). Default value is
close_flagspecifies whether or not to close the project when done rendering, and whether or not to save changes. If close_flag is
DO_NOT_SAVE_CHANGES, project will be closed without saving changes. If close_flag is
SAVE_CHANGES, project will be closed and changes will be saved. If close_flag is
DO_NOT_CLOSEthe project will be left open; but the project is left open only if using an already-running instance of AE, since new invocations of AE must always close and quit when done. Default value is
sound_flagspecifies whether or not to play a sound when rendering is complete. Possible values are "
ON" or "
OFF". Default value is "
-versiondisplays the version number of aerender to the console. Does not render.
-continueOnMissingFootageDo not stop rendering on missing footage. Log and render with placeholder color bars.
EXAMPLES: To render just Comp 1 to a specified file:
aerender -project c:\projects\proj1.aep -comp "Comp 1" -output c:\output\proj1\proj1.avi
To render everything in the render queue as is in the project file:
aerender -project c:\projects\proj1.aep
To render frames 1-10 using multi-machine render:
aerender -project c:\projects\proj1.aep -comp "Comp 1" -s 1 -e 10 -RStemplate "Multi-Machine Settings" -OMtemplate "Multi-Machine Sequence" -output c:\output\proj1\frames[####].psd
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.