Skip to content

Item (Base Class)

Item dataclass

Item(comment: str, item_id: int, label: Label, name: str, parent_folder: FolderItem | None, type_name: str)

Bases: ABC

Abstract base class storing information about folders, compositions, or footages.

Attributes:

Name Type Description
comment str

The item comment.

item_id int

The item unique identifier.

label Label

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).

name str

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

parent_folder FolderItem | None

The parent folder of this item. None for the root folder.

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.

is_folder property

is_folder: bool

True if the item is a folder.

is_composition property

is_composition: bool

True if the item is a composition.

is_footage property

is_footage: bool

True if the item is a footage.