Text Layer
TextLayer(
auto_orient: AutoOrientType,
comment: str,
containing_comp: CompItem,
effects: list[PropertyGroup],
enabled: bool,
frame_in_point: int,
frame_out_point: int,
frame_start_time: int,
id: int,
in_point: float,
label: Label,
layer_type: str,
locked: bool,
markers: list[MarkerValue],
name: str,
null_layer: bool,
out_point: float,
_parent_id: int,
start_time: float,
shy: bool,
solo: bool,
stretch: float,
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,
)
Bases: AVLayer
The TextLayer object represents a text layer within a composition.
Info
TextLayer is a subclass of AVLayer object. All methods and
attributes of AVLayer are available when working with TextLayer.
See: https://ae-scripting.docsforadobe.dev/layer/textlayer/
Attributes¶
audio_enabled: bool
When True, the layer's audio is enabled. This value corresponds to the audio toggle switch in the Timeline panel.
auto_orient: AutoOrientType
The type of automatic orientation to perform for the layer.
collapse_transformation: bool
True if collapse transformation is on for this layer.
The composition that contains this layer. Set after parsing when the full project structure is available.
effects_active: bool
True if the layer's effects are active, as indicated by the
environment_layer: bool
True if this is an environment layer in a Ray-traced 3D composition.
frame_blending_type: FrameBlendingType
The type of frame blending to perform when frame blending is enabled for the layer.
frame_in_point: int
The "in" point of the layer, expressed in composition time (frames). This
is the first frame where the layer becomes visible. The binary format
stores this relative to start_time; parsed value is absolute composition
time.
frame_out_point: int
The "out" point of the layer, expressed in composition time (frames). This is the first frame where the layer is no longer visible. Clamped to composition duration to match ExtendScript behavior.
frame_start_time: int
The start time of the layer, expressed in composition time (frames). This determines where the layer's first frame of content appears in the composition timeline.
height: int
The height of the layer in pixels.
Returns the source item's height if available, otherwise falls back to the containing composition's height (matches ExtendScript behavior for source-less layers like text and shape layers).
id: int
Unique and persistent identification number used internally to identify a Layer between sessions.
in_point: float
The "in" point of the layer, expressed in composition time (seconds). This
is the time at which the layer starts being visible in the composition.
The binary format stores this relative to start_time as a signed integer;
parsed value is absolute composition time.
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.
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).
locked: bool
When True, the layer is locked. This corresponds to the lock toggle in
the Layer panel.
out_point: float
The "out" point of the layer, expressed in composition time (seconds).
This is the time at which the layer stops being visible in the composition.
Clamped to composition duration to match ExtendScript API behavior (a
layer's out_point cannot exceed its containing composition's duration).
The binary format stores this relative to start_time.
preserve_transparency: bool
True if preserve transparency is enabled for the layer.
shy: bool
When True, the layer is "shy", meaning that it is hidden in the Layer
panel if the composition's "Hide all shy layers" option is toggled on.
start_time: float
The start time of the layer, expressed in composition time (seconds).