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

    Describes a single keyframeable parameter within a filter's keyframes metadata. More...

    Import Statement: import org.shotcut.qml

    Properties

    Detailed Description

    Accessed from KeyframesMetadata::parameters.

    Property Documentation

    gangedProperties : list<string>

    Additional MLT property names that must be adjusted together with property (e.g. linked x/y coordinates).


    gangedRectProperties : list<string>

    Additional rect-type MLT property names that must be adjusted together with property.


    isColor : bool

    Whether this parameter represents a color (uses Filter::getColor() / Filter::set()).


    isCurve : bool

    Whether this parameter can display a curve editor in the Keyframes panel.


    isRectangle : bool

    Whether this parameter represents a rectangle (uses Filter::getRect() / Filter::set()).


    maximum : real

    The maximum allowed value when rangeType is MinMax.


    minimum : real

    The minimum allowed value when rangeType is MinMax.


    name : string

    The human-readable display name of the parameter.


    property : string

    The MLT property name this parameter maps to (used with Filter::get() and Filter::set()).


    rangeType : int

    The range constraint type. 0 = MinMax (clamped to minimum / maximum), 1 = ClipLength (range is 0 to clip duration in frames).


    units : string

    The display units string shown next to the parameter value (e.g. "px", "%").