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

    The Keyframes panel controller, available as the keyframes context property. More...

    Import Statement: import org.shotcut.qml

    Properties

    Signals

    Methods

    Detailed Description

    keyframes is injected into the Keyframes QML view and exposes navigation methods and the time-scale zoom state.

    Property Documentation

    timeScale : real

    The horizontal zoom factor of the Keyframes ruler. Settable.


    Signal Documentation

    changed()

    Emitted when a filter parameter value changes from within the Keyframes panel.

    Note: The corresponding handler is onChanged.


    dockClicked()

    Emitted when the user clicks inside the Keyframes dock area.

    Note: The corresponding handler is onDockClicked.


    newFilter()

    Emitted when the filter itself (not just a parameter) has been changed.

    Note: The corresponding handler is onNewFilter.


    seekNextSimple()

    Emitted to request seeking to the next simple-keyframe boundary.

    Note: The corresponding handler is onSeekNextSimple.


    seekPreviousSimple()

    Emitted to request seeking to the previous simple-keyframe boundary.

    Note: The corresponding handler is onSeekPreviousSimple.


    timeScaleChanged()

    Emitted when timeScale changes.

    Note: The corresponding handler is onTimeScaleChanged.


    zoomIn()

    Emitted to request zooming in on the keyframes ruler.

    Note: The corresponding handler is onZoomIn.


    zoomOut()

    Emitted to request zooming out on the keyframes ruler.

    Note: The corresponding handler is onZoomOut.


    zoomToFit()

    Emitted to request resetting zoom to show all keyframes.

    Note: The corresponding handler is onZoomToFit.


    Method Documentation

    void load(bool force)

    Loads (or reloads if force is true) the Keyframes panel for the current filter.


    void reload()

    Reloads the keyframes model for the current filter without resetting the view.


    int seekNext()

    Seeks the playhead to the next keyframe position. Returns the new playhead position in frames.


    int seekPrevious()

    Seeks the playhead to the previous keyframe position. Returns the new playhead position in frames.