Marker object

Marker

Description

Both projectItems and sequences have associated marker objects, which represent their associated markers.

Attributes

name

marker.name

Description

The name of the marker.

Type

String; read/write.


comments

marker.comments

Description

The comments within the marker.

Type

String; read/write.


type

marker.type

Description

The type of marker; either “Comment”, “Chapter”, “Segmentation”, or “WebLink”. Note: Premiere Pro can import some marker types, which cannot be created from within Premiere Pro.

Type

String; read-only.


guid

marker.guid

Description

The unique identifier of the marker, created at time of instantiation.

Type

String; read-only.


start

marker.start

Description

A Time object containing the value of the beginning of the marker.

Type

Time; read/write.


end

marker.end

Description

A Time object containing the value of the ending of the marker.

Type

Time; read/write.

Methods

setTypeAsComment

marker.setTypeAsComment()

Description

Sets the type of the marker to “Comment”.

Parameters

None.

Returns

Returns 0 if successful.


setTypeAsChapter

marker.setTypeAsChapter()

Description

Sets the type of the marker to “Chapter”.

Parameters

None.

Returns

Returns 0 if successful.


setTypeAsSegmentation

marker.setTypeAsSegmentation()

Description

Sets the type of the marker to “Segmentation”.

Parameters

None.

Returns

Returns 0 if successful.


getWebLinkURL

marker.getWebLinkURL()

Description

Retrieves the URL, from the marker’s URL field.

Parameters

None.

Returns

Returns a String containing the URL, or 0 if unsuccessful.


getWebLinkFrameTarget

marker.getWebLinkFrameTarget()

Description

Retrieves the frame target, from the marker’s FrameTarget field.

Parameters

None.

Returns

Returns a String containing the frame target, or 0 if unsuccessful.