Marker

MarkerValue ¶

The MarkerValue object represents a layer or composition marker, which associates a comment, and optionally a chapter reference point, Web-page link, or Flash Video cue point with a particular point in a layer.

Example

from py_aep import parse

app = parse("project.aep")
comp = app.project.compositions[0]
marker = comp.markers[0]
print(marker.comment)

See: https://ae-scripting.docsforadobe.dev/other/markervalue/

Attributes¶

chapter ¶

chapter = ChunkField[str]('_chapter_utf8', 'contents')

A text chapter link for this marker. Chapter links initiate a jump to a chapter in a QuickTime movie or in other formats that support chapter marks. Read / Write.

comment ¶

comment = ChunkField[str]('_comment_utf8', 'contents')

A text comment for this marker. This comment appears in the Timeline panel next to the layer marker. Read / Write.

cue_point_name ¶

cue_point_name = ChunkField[str](
    "_cue_point_name_utf8", "contents"
)

The Flash Video cue point name, as shown in the Marker dialog box. Read / Write.

duration ¶

duration = ChunkField[float](
    "_nmhd",
    "duration",
    reverse_instance_field=_reverse_duration,
)

The marker's duration, in seconds. Read / Write.

event_cue_point ¶

event_cue_point: bool

When True, the FlashVideo cue point is for an event; otherwise, it is for navigation.

frame_duration ¶

frame_duration = ChunkField[int](
    "_nmhd",
    "frame_duration",
    validate=validate_number(min=0, integer=True),
)

The marker's duration, in frames. Read / Write.

frame_target ¶

frame_target = ChunkField[str](
    "_frame_target_utf8", "contents"
)

A text frame target for this marker. Together with the URL value, this targets a specific frame within a Web page. Read / Write.

frame_time ¶

frame_time: int

The time of the marker, in frames.

label ¶

label = enum(Label, '_nmhd', '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). Read / Write.

navigation ¶

navigation = bool('_nmhd', 'navigation')

Whether the marker is a navigation marker. Read / Write.

params ¶

params: dict[str, str]

Key-value pairs for Flash Video cue-point parameters.

protected_region ¶

protected_region = bool('_nmhd', 'protected_region')

State of the Protected Region option in the Composition Marker dialog box. When True, the composition marker behaves as a protected region. Will also return True for protected region markers on nested composition layers, but is otherwise not applicable to layer markers. Read / Write.

url ¶

url = ChunkField[str]('_url_utf8', 'contents')

A URL for this marker. This URL is an automatic link to a Web page. Read / Write.