API Reference¶

Welcome to the py_aep API reference. This section provides detailed documentation for all modules, classes, and functions in the library.

Main Entry Point¶

The primary function you'll use is parse().

Core Modules¶

Application¶

The top-level Application representing the After Effects application.

Project¶

The Project containing all project information.

Items¶

Project items represent different types of content in the project panel:

• Item - Base class for all items
• AV Item - Base class for Audio/Video items
• Composition - Composition items
• Footage - Footage items
• Folder - Folder items

Layers¶

Layers are the building blocks of compositions:

• Base Layer - Base class for all layers
• AV Layer - Audio/Video layers
• Text Layer - Text layers
• Shape Layer - Shape layers
• Camera Layer - Camera layers
• Light Layer - Light layers
• 3D Model Layer - 3D model layers

Properties¶

Properties control layer appearance and behavior:

• Property Base - Base class for properties
• Property - Individual properties
• Property Group - Property containers
• Mask Property Group - Mask property groups
• Keyframe - Animation keyframes
• Keyframe Ease - Keyframe easing
• MarkerValue - Timeline markers
• Shape - Shape data

Sources¶

Sources provide the content for footage items:

• Footage Source - Base class for sources
• File Source - File-based sources
• Solid Source - Solid color sources
• Placeholder Source - Placeholder sources

Text¶

Text-related classes:

• Text Document - Text layer content and styling
• Font Object - Font information

Render Queue¶

Render queue management and output settings:

• Render Queue - The render queue container
• Render Queue Item - Individual render items
• Render Settings - Render settings reference
• Output Module - Output module configuration
• Output Module Settings - Output settings reference
• Format Options - Format-specific encoding options

Viewer¶

Viewer panel state:

• Viewer - Viewer panel
• View - Individual view within a viewer
• View Options - View display options

Enums¶

Enumerations for various After Effects settings and modes.

Quick Start¶

See the Quick Start guide for usage examples (parsing, iteration, modification, saving).