Folder

FolderItem ¶

Bases: Item

The FolderItem object corresponds to a folder in your Project panel. It can contain various types of items (footage, compositions, solids) as well as other folders.

Example

from py_aep import parse

app = parse("project.aep")
root = app.project.root_folder
print(root.name)
for item in root:
    ...

See: https://ae-scripting.docsforadobe.dev/item/folderitem/

Attributes¶

comment ¶

comment: str

The item comment. Read / Write.

guides ¶

guides: list[Guide]

The item's ruler guides. Each guide has an orientation and a pixel position. Read-only.

id ¶

id = ChunkField[int](
    "_idta", "item_id", read_only=True, default=0
)

The item unique identifier. Read-only.

is_composition ¶

is_composition: bool

True if the item is a composition.

is_folder ¶

is_folder: bool

True if the item is a folder.

is_footage ¶

is_footage: bool

True if the item is a footage.

items ¶

items: list[Item] = []

The items in this folder. Contains only the top-level items in the folder. Read-only.

label ¶

label = enum(Label, '_idta', 'label', default=NONE)

The label color. Colors are represented by their number (0 for None, or 1 to 16 for one of the preset colors in the Labels preferences). Read / Write.

name ¶

name = ChunkField[str](
    "_name_utf8", "contents", transform=strip_null
)

The name of the item, as shown in the Project panel. Read / Write.

num_items ¶

num_items: int

Return the number of items in the folder.

Note

Equivalent to len(folder.items)

parent_folder ¶

parent_folder: FolderItem | None

The parent folder of this item. None for the root folder. Read-only.

selected ¶

selected: bool

When True, this item is selected. Read-only.

Note

Item selection is not stored in the .aep binary format; it is a runtime-only state. Parsed projects always report False.

type_name ¶

type_name: str

A user-readable name for the item type ("Folder", "Footage" or "Composition"). These names are application locale-dependent, meaning that they are different depending on the application's UI language. Read-only.