Marker

Since: 25.6

Properties

Name

Type

Access

Min Version

Description

guid

Guid

26.3

The unique identifier of the marker.

Instance Methods

createSetColorByIndexAction

Return an action to set the color of the marker by the color index

Since: 25.6

Returns: Action

Parameters

Name

Type

Description

colorIndex

number

createSetCommentsAction

Return an action to set the comments of the marker.

Since: 25.6

Returns: Action

Parameters

Name

Type

Description

comments

string

createSetDurationAction

Return an action to set the duration of the marker.

Since: 25.6

Returns: Action

Parameters

Name

Type

Description

tickTime

TickTime

createSetNameAction

Return an action to set the name of the marker.

Since: 25.6

Returns: Action

Parameters

Name

Type

Description

name

string

createSetTypeAction

Return an action to set the type of the marker.

Since: 25.6

Returns: Action

Parameters

Name

Type

Description

markerType

string

Can be set to "Comment", "Chapter", "Segmentation", or "WebLink"

getColor

Get color code of the marker.

Since: 25.6

Returns: Color

getColorIndex

Get color index of the marker.

Since: 25.6

Returns: number

getComments

Get comments of the marker.

Since: 25.6

Returns: string

getDuration

Get duration time of the marker.

Since: 25.6

Returns: TickTime

getName

Get name of the marker.

Since: 25.6

Returns: string

getStart

Get start time of the marker.

Since: 25.6

Returns: TickTime

getTarget

Get target of the marker. Used together with url for web targets.

Since: 25.6

Returns: string

getType

Get type of the marker. e.g. Cue / Track / Subclip / Cart

Since: 25.6

Returns: string

getUrl

Get url of the marker.

Since: 25.6

Returns: string