Skip to content

AVLayer (Audio/Video Layer)

AVLayer dataclass

AVLayer(auto_orient: AutoOrientType, comment: str, containing_comp: CompItem | None, effects: list[PropertyGroup], enabled: bool, frame_in_point: int, frame_out_point: int, frame_start_time: int, in_point: float, label: Label, layer_id: int, layer_type: LayerType, locked: bool, markers: list[Marker], name: str, null_layer: bool, out_point: float, parent_id: int | None, start_time: float, shy: bool, solo: bool, stretch: float | None, text: PropertyGroup | None, time: float, transform: list[Property], blending_mode: BlendingMode, frame_blending_type: FrameBlendingType, quality: LayerQuality, sampling_quality: LayerSamplingQuality, track_matte_type: TrackMatteType, adjustment_layer: bool, audio_enabled: bool, collapse_transformation: bool, effects_active: bool, environment_layer: bool, frame_blending: bool, guide_layer: bool, motion_blur: bool, preserve_transparency: bool, three_d_layer: bool, time_remap_enabled: bool, source_id: int | None)

Bases: Layer

An AVLayer object represents an audiovisual layer within a composition.

Attributes:

Name Type Description
adjustment_layer bool

When true, the layer is an adjustment layer.

audio_enabled bool

When true, the layer's audio is enabled. This value corresponds to the audio toggle switch in the Timeline panel.

blending_mode BlendingMode

The blending mode of the layer. See Blending modes.

collapse_transformation bool

True if collapse transformation is on for this layer.

effects_active bool

True if the layer's effects are active, as indicated by the icon next to it in the user interface.

environment_layer bool

True if this is an environment layer in a Ray-traced 3D composition. Setting this attribute to true automatically makes the layer 3D (three_d_layer becomes true).

frame_blending bool

True if frame blending is enabled for this layer.

frame_blending_type FrameBlendingType

The type of frame blending to perform when frame blending is enabled for the layer.

guide_layer bool

True if the layer is a guide layer.

motion_blur bool

True if motion blur is enabled for the layer.

preserve_transparency bool

True if preserve transparency is enabled for the layer.

quality LayerQuality

The layer's draft quality setting.

sampling_quality LayerSamplingQuality

The layer's sampling method.

source Item | None

The source AVItem for this layer. Set after parsing when the full project structure is available.

source_id int | None

The ID of the source item for this layer. None for a text layer.

three_d_layer bool

True if this layer is a 3D layer.

time_remap_enabled bool

True if time remapping is enabled for this layer.

track_matte_type TrackMatteType

Specifies the way the track matte is applied.

source property writable

source: Item | None

The source item for this layer.

width property

width: int

The width of the layer in pixels (from source item).

height property

height: int

The height of the layer in pixels (from source item).

is_name_from_source property

is_name_from_source: bool

True if the layer has no expressly set name, but contains a named source.

In this case, layer.name has the same value as layer.source.name. False if the layer has an expressly set name, or if the layer does not have a source.