Project

Project ¶

Project(
    bits_per_channel: BitsPerChannel,
    revision: int,
    color_management_system: ColorManagementSystem,
    compensate_for_scene_referred_profiles: bool,
    effect_names: list[str],
    expression_engine: str,
    feet_frames_film_type: FeetFramesFilmType,
    lut_interpolation_method: LutInterpolationMethod,
    ocio_configuration_file: str,
    file: str,
    footage_timecode_display_start_type: FootageTimecodeDisplayStartType,
    frame_rate: float,
    frames_count_type: FramesCountType,
    frames_use_feet_frames: bool,
    linear_blending: bool,
    linearize_working_space: bool,
    working_gamma: float,
    working_space: str,
    display_color_space: str,
    gpu_accel_type: GpuAccelType | None,
    audio_sample_rate: float,
    items: dict[int, Item],
    render_queue: RenderQueue | None,
    time_display_type: TimeDisplayType,
    transparency_grid_thumbnails: bool,
    xmp_packet: Element,
    active_item: Item | None = None,
    root_folder: FolderItem | None = None,
)

The Project object represents an After Effects project. Attributes provide access to specific objects within the project, such as imported files or footage and compositions, and also to project settings such as the timecode base.

See: https://ae-scripting.docsforadobe.dev/general/project/

Attributes¶

active_item ¶

active_item: Item | None = None

The item that is currently active and is to be acted upon, or None if no item is currently selected or if multiple items are selected.

audio_sample_rate ¶

audio_sample_rate: float

The project audio sample rate in Hz (e.g. 22050.0, 44100.0, 48000.0, 96000.0).

Note

Not exposed in ExtendScript

bits_per_channel ¶

bits_per_channel: BitsPerChannel

The color depth of the current project, either 8, 16, or 32 bits.

color_management_system ¶

color_management_system: ColorManagementSystem

The color management system used by the project (Adobe or OCIO). Available in CC 2024 and later.

compensate_for_scene_referred_profiles ¶

compensate_for_scene_referred_profiles: bool

When True, After Effects compensates for scene-referred profiles when rendering.

compositions ¶

compositions: list[CompItem]

All the compositions in the project.

display_color_space ¶

display_color_space: str

The name of the display color space used for the project (e.g., "ACES/sRGB"). Only relevant when color_management_system is OCIO. "None" when not set.

Note

Not exposed in ExtendScript

display_start_frame ¶

display_start_frame: int = field(init=False)

The start frame number for the project display.

effect_names ¶

effect_names: list[str]

The names of all effects used in the project.

expression_engine ¶

expression_engine: str

The Expressions Engine setting in the Project Settings dialog box ("extendscript" or "javascript-1.0").

feet_frames_film_type ¶

feet_frames_film_type: FeetFramesFilmType

The film type for feet+frames timecode display, either MM16 (16mm) or MM35 (35mm).

file ¶

file: str

The full path to the project file.

folders ¶

folders: list[FolderItem]

All the folders in the project.

footage_timecode_display_start_type ¶

footage_timecode_display_start_type: (
    FootageTimecodeDisplayStartType
)

The Footage Start Time setting in the Project Settings dialog box, which is enabled when Timecode is selected as the time display style.

footages ¶

footages: list[FootageItem]

All the footages in the project.

frame_rate ¶

frame_rate: float

The frame rate of the project.

frames_count_type ¶

frames_count_type: FramesCountType

The Frame Count menu setting in the Project Settings dialog box.

frames_use_feet_frames ¶

frames_use_feet_frames: bool

When True, the Frames field in the UI is displayed as feet+frames.

gpu_accel_type ¶

gpu_accel_type: GpuAccelType | None

The GPU acceleration type for the project. None if not recognised.

items ¶

items: dict[int, Item] = field(repr=False)

All the items in the project.

linear_blending ¶

linear_blending: bool

When True, linear blending is used for the project. When False, the standard blending mode is used.

linearize_working_space ¶

linearize_working_space: bool

When True, the working color space is linearized for blending operations.

lut_interpolation_method ¶

lut_interpolation_method: LutInterpolationMethod

The LUT interpolation method for the project (Trilinear or Tetrahedral).

ocio_configuration_file ¶

ocio_configuration_file: str

The OCIO configuration file for the project. Only relevant when color_management_system is OCIO.

project_name ¶

project_name: str = field(init=False)

The name of the project, derived from the file name.

render_queue ¶

render_queue: RenderQueue | None

The Render Queue of the project.

revision ¶

revision: int

The current revision of the project. Every user action increases the revision number by one. A new project starts at revision 1.

root_folder ¶

root_folder: FolderItem | None = None

The root folder. This is a virtual folder that contains all items in the Project panel, but not items contained inside other folders in the Project panel.

time_display_type ¶

time_display_type: TimeDisplayType

The time display style, corresponding to the Time Display Style section in the Project Settings dialog box.

transparency_grid_thumbnails ¶

transparency_grid_thumbnails: bool

When True, thumbnail views use the transparency checkerboard pattern.

working_gamma ¶

working_gamma: float

The gamma value used for the working color space, typically 2.2 or 2.4.

working_space ¶

working_space: str

The name of the working color space (e.g., "sRGB IEC61966-2.1", "None").

xmp_packet ¶

xmp_packet: Element

The XMP packet for the project, containing metadata.

Functions¶

layer_by_id ¶

layer_by_id(layer_id: int) -> Layer

Get a layer by its unique ID.