Footage

FootageItem ¶

FootageItem(
    comment: str,
    id: int,
    label: Label,
    name: str,
    parent_folder: FolderItem | None,
    type_name: str,
    duration: float,
    frame_duration: int,
    frame_rate: float,
    height: int,
    pixel_aspect: float,
    width: int,
    main_source: FileSource
    | SolidSource
    | PlaceholderSource,
    asset_type: str,
    end_frame: int,
    start_frame: int,
)

Bases: AVItem

The FootageItem object represents a footage item imported into a project, which appears in the Project panel.

Info

FootageItem is a subclass of AVItem object, which is a subclass of Item object. All methods and attributes of AVItem and Item are available when working with FootageItem.

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

Attributes¶

asset_type ¶

asset_type: str

The footage type (placeholder, solid, file).

comment ¶

comment: str

The item comment.

duration ¶

duration: float

The duration of the item in seconds. Still footages have a duration of 0.

end_frame ¶

end_frame: int

The footage end frame.

file ¶

file: str | None

The footage file path if its source is a FileSource, else None.

footage_missing ¶

footage_missing: bool

When True, the AVItem is a placeholder, or represents footage with a source file that cannot be found. In this case, the path of the missing source file is in the missing_footage_path attribute of the footage item's source-file object. See FootageItem.main_source and FileSource.missing_footage_path.

frame_duration ¶

frame_duration: int

The duration of the item in frames. Still footages have a duration of 0.

frame_rate ¶

frame_rate: float

The frame rate of the item in frames-per-second.

height ¶

height: int

The height of the item in pixels.

id ¶

id: int

The item unique identifier.

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.

label ¶

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

main_source ¶

main_source: FileSource | SolidSource | PlaceholderSource

The footage source.

name ¶

name: str

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

parent_folder ¶

parent_folder: FolderItem | None = field(repr=False)

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

pixel_aspect ¶

pixel_aspect: float

The pixel aspect ratio of the item (1.0 is square).

start_frame ¶

start_frame: int

The footage start frame.

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.

used_in ¶

used_in: list[CompItem]

All the compositions that use this AVItem.

width ¶

width: int

The width of the item in pixels.