• Shotcut QML Scripting API
  • org.shotcut.qml
  • MarkersModel
  • MarkersModel QML Type

    A model of timeline markers (cue points with optional range spans and colors). More...

    Import Statement: import org.shotcut.qml

    Properties

    Signals

    Methods

    Detailed Description

    MarkersModel is available as the markers context property in the Timeline dock. Each row represents one marker.

    Roles

    Role nameDescription
    textMarker label text
    startStart position in frames
    endEnd position in frames (== start for point markers)
    colorMarker color (color type)

    Property Documentation

    recentColors : list<string>

    The list of recently used marker color strings, most-recent first.


    Signal Documentation

    modified()

    Emitted whenever any marker is added, removed, or edited.

    Note: The corresponding handler is onModified.


    rangesChanged()

    Emitted when any marker's start/end range changes.

    Note: The corresponding handler is onRangesChanged.


    recentColorsChanged()

    Emitted when the recent-colors list is updated.

    Note: The corresponding handler is onRecentColorsChanged.


    Method Documentation

    void clear()

    Removes all markers from the timeline.


    void move(int markerIndex, int start, int end)

    Moves the marker at markerIndex so it spans start to end (in frames). For a point marker set end equal to start.


    int nextMarkerPosition(int position)

    Returns the start frame of the nearest marker after position, or -1 if no marker exists after that position.


    int prevMarkerPosition(int position)

    Returns the start frame of the nearest marker before time position, or -1 if no marker exists before that position.


    void remove(int markerIndex)

    Removes the marker at markerIndex.


    void setColor(int markerIndex, color color)

    Sets the display color of the marker at markerIndex.