Marker object
Marker object
Section titled “Marker object”app.project.activeSequence.markers.getFirstMarker()
app.project.rootItem.children[index].getMarkers().getFirstMarker()
Description
Section titled “Description”Both Project items and sequences have associated Marker objects, which represent their associated markers.
Attributes
Section titled “Attributes”Marker.comments
Section titled “Marker.comments”app.project.activeSequence.markers.getFirstMarker().comments
app.project.rootItem.children[index].getMarkers().getFirstMarker().comments
Description
Section titled “Description”The comments within the marker.
String; read/write.
Marker.end
Section titled “Marker.end”app.project.activeSequence.markers.getFirstMarker().end
app.project.rootItem.children[index].getMarkers().getFirstMarker().end
Description
Section titled “Description”A Time object containing the value of the ending of the marker.
Time object; read/write.
Marker.guid
Section titled “Marker.guid”app.project.activeSequence.markers.getFirstMarker().guid
app.project.rootItem.children[index].getMarkers().getFirstMarker().guid
Description
Section titled “Description”The unique identifier of the marker, created at time of instantiation.
String; read-only.
Marker.name
Section titled “Marker.name”app.project.activeSequence.markers.getFirstMarker().name
app.project.rootItem.children[index].getMarkers().getFirstMarker().name
Description
Section titled “Description”The name of the marker.
String; read/write.
Marker.start
Section titled “Marker.start”app.project.activeSequence.markers.getFirstMarker().start
app.project.rootItem.children[index].getMarkers().getFirstMarker().start
Description
Section titled “Description”A Time object containing the value of the beginning of the marker.
Time object; read/write.
Marker.type
Section titled “Marker.type”app.project.activeSequence.markers.getFirstMarker().type
app.project.rootItem.children[index].getMarkers().getFirstMarker().type
Description
Section titled “Description”The type of marker, one of:
"Comment""Chapter""Segmentation""WebLink"
String; read-only.
Methods
Section titled “Methods”Marker.getColorByIndex()
Section titled “Marker.getColorByIndex()”app.project.activeSequence.markers.getFirstMarker().getColorByIndex(index)
app.project.rootItem.children[index].getMarkers().getFirstMarker().getColorByIndex(index)
Description
Section titled “Description”Gets the marker color index.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
index | Integer | Index of the marker to be read. |
Returns
Section titled “Returns”Returns the color index as an Integer.
Marker.getWebLinkFrameTarget()
Section titled “Marker.getWebLinkFrameTarget()”app.project.activeSequence.markers.getFirstMarker().getWebLinkFrameTarget()
app.project.rootItem.children[index].getMarkers().getFirstMarker().getWebLinkFrameTarget()
Description
Section titled “Description”Retrieves the frame target, from the marker’s FrameTarget field.
Parameters
Section titled “Parameters”None.
Returns
Section titled “Returns”Returns a String containing the frame target, or 0 if unsuccessful.
Marker.getWebLinkURL()
Section titled “Marker.getWebLinkURL()”app.project.activeSequence.markers.getFirstMarker().getWebLinkURL()
app.project.rootItem.children[index].getMarkers().getFirstMarker().getWebLinkURL()
Description
Section titled “Description”Retrieves the URL, from the marker’s URL field.
Parameters
Section titled “Parameters”None.
Returns
Section titled “Returns”Returns a String containing the URL, or 0 if unsuccessful.
Marker.setColorByIndex()
Section titled “Marker.setColorByIndex()”app.project.activeSequence.markers.getFirstMarker().setColorByIndex(colorIndex, markerIndex)
app.project.rootItem.children[index].getMarkers().getFirstMarker().setColorByIndex(colorIndex, markerIndex)
Description
Section titled “Description”Sets the marker color by index. Color indices listed below.
0= Green1= Red2= Purple3= Orange4= Yellow5= White6= Blue7= Cyan
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
colorIndex | Integer | Index of the color to apply to the marker. |
markerIndex | Integer | Index of the marker to be set. |
Returns
Section titled “Returns”Returns undefined.
Marker.setTypeAsChapter()
Section titled “Marker.setTypeAsChapter()”app.project.activeSequence.markers.getFirstMarker().setTypeAsChapter()
app.project.rootItem.children[index].getMarkers().getFirstMarker().setTypeAsChapter()
Description
Section titled “Description”Sets the type of the marker to “Chapter”.
Parameters
Section titled “Parameters”None.
Returns
Section titled “Returns”Returns 0 if successful.
Marker.setTypeAsComment()
Section titled “Marker.setTypeAsComment()”app.project.activeSequence.markers.getFirstMarker().setTypeAsComment()
app.project.rootItem.children[index].getMarkers().getFirstMarker().setTypeAsComment()
Description
Section titled “Description”Sets the type of the marker to “Comment”.
Parameters
Section titled “Parameters”None.
Returns
Section titled “Returns”Returns 0 if successful.
Marker.setTypeAsSegmentation()
Section titled “Marker.setTypeAsSegmentation()”app.project.activeSequence.markers.getFirstMarker().setTypeAsSegmentation()
app.project.rootItem.children[index].getMarkers().getFirstMarker().setTypeAsSegmentation()
Description
Section titled “Description”Sets the type of the marker to “Segmentation”.
Parameters
Section titled “Parameters”None.
Returns
Section titled “Returns”Returns 0 if successful.
Marker.setTypeAsWebLink()
Section titled “Marker.setTypeAsWebLink()”app.project.activeSequence.markers.getFirstMarker().setTypeAsWebLink()
app.project.rootItem.children[index].getMarkers().getFirstMarker().setTypeAsWebLink()
Description
Section titled “Description”Sets the type of the marker to “WebLink”.
Parameters
Section titled “Parameters”None.
Returns
Section titled “Returns”Returns 0 if successful.