Skip to content

Item

Item

The Item object represents an item that can appear in the Project panel.

Info

Item is the base class for AVItem object and for FolderItem object, which are in turn the base classes for various other item types, so Item attributes and methods are available when working with all of these item types.

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

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.

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", "value", validate=validate_name
)

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

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.

Functions

add_guide 

add_guide(orientation_type: int, position: int) -> int

Adds a new guide to the item.

Any orientation_type value other than 0 (horizontal) or 1 (vertical) defaults to horizontal.

Parameters:

  • orientation_type (int) –

    0 for horizontal, 1 for vertical.

  • position (int) –

    The pixel position of the guide.

Returns:

  • int –

    The index of the new guide.

remove 

remove() -> None

Remove this item from the project.

Subclasses add their own cleanup before calling super().remove():

  • FolderItem removes children recursively.
  • AVItem removes layers that reference this item as their source and cleans up viewer references.
  • CompItem removes render-queue items targeting this composition.

Raises:

remove_guide 

remove_guide(guide_index: int) -> None

Removes an existing guide by index.

Parameters:

  • guide_index (int) –

    The 0-based index of the guide to remove.

Raises: