Footage

FootageItem ¶

Bases: AVItem

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

Example

from py_aep import parse

app = parse("project.aep")
footage = app.project.footages[0]
print(footage.main_source)

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

comment ¶

comment: str

The item comment. Read / Write.

duration ¶

duration = ChunkField[float](
    "_sspc", "duration", read_only=True
)

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

end_frame ¶

end_frame = ChunkField[int](
    "_sspc", "end_frame", read_only=True
)

The footage end frame. Read-only.

file ¶

file: str | None

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

footage_missing ¶

footage_missing = bool(
    "_sspc", "footage_missing_at_save", read_only=True
)

When True, the AVItem is a placeholder, or represents footage with a source file that could not be found when the project was last saved.

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. Read-only.

frame_duration ¶

frame_duration = ChunkField[int](
    "_sspc", "frame_duration", transform=int, read_only=True
)

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

frame_rate ¶

frame_rate = ChunkField[float](
    "_sspc", "display_frame_rate", read_only=True
)

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

frame_time ¶

frame_time: int

The current time of the item when it is being previewed directly from the Project panel. This value is a number of frames.

guides ¶

guides: list[Guide]

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

has_audio ¶

has_audio: bool = bool("_sspc", "has_audio", read_only=True)

When True, the footage has an audio component. Read-only.

has_video ¶

has_video: bool

True if the item has a video component.

An AVItem has video when it has non-zero dimensions (width > 0 and height > 0). In a CompItem, the value is always True. In a FootageItem, the value depends on the footage source (e.g. audio-only files return False).

height ¶

height = ChunkField[int]('_sspc', 'height', read_only=True)

The height of the item in pixels. 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.

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.

main_source ¶

main_source: FileSource | SolidSource | PlaceholderSource

The footage source. Read-only.

name ¶

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

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.

pixel_aspect ¶

pixel_aspect = ChunkField[float](
    "_sspc", "pixel_aspect", read_only=True
)

The pixel aspect ratio of the item (1.0 is square). 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.

start_frame ¶

start_frame = ChunkField[int](
    "_sspc", "start_frame", read_only=True
)

The footage start frame. Read-only.

time ¶

time: float

The current time of the item when it is being previewed directly from the Project panel. This value is a number of seconds. It is an error to set this value for a FootageItem whose main_source is still (item.main_source.is_still is True).

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.

used_in ¶

used_in: list[CompItem]

All the compositions that use this AVItem.

width ¶

width = ChunkField[int]('_sspc', 'width', read_only=True)

The width of the item in pixels. Read-only.