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

    Describes a filter's identity, capabilities, and keyframe configuration. More...

    Import Statement: import org.shotcut.qml

    Properties

    Detailed Description

    Metadata is the read-only descriptor for a filter service. It is available in Filters panels as the metadata context property. Use it to inspect the filter type, supported capabilities, and keyframe parameters.

    Property Documentation

    allowMultiple : bool

    Whether multiple instances of this filter can be applied to the same clip.


    help : string

    A link to the documentation page for this filter.


    isAudio : bool

    Whether this filter operates on audio rather than video.


    isClipOnly : bool

    Whether this filter can only be applied to clips (not tracks or timeline output).


    isDeprecated : bool

    Whether this filter has been deprecated and should not be used in new projects.


    isFavorite : bool

    Whether the user has marked this filter as a favorite.


    isHidden : bool

    Whether this filter is hidden from the filter list UI.


    isOutputOnly : bool

    Whether this filter can only be applied to the timeline output.


    isTrackOnly : bool

    Whether this filter can only be applied to tracks.


    keyframes : KeyframesMetadata

    The keyframes configuration object for this filter.

    See also KeyframesMetadata.


    keywords : string

    Space-separated keywords for searching this filter in the filter list.


    minimumVersion : string

    The minimum MLT metadata version required for this filter.


    mlt_service : string

    The MLT service identifier (e.g. "avfilter.boxblur").


    name : string

    The human-readable display name of the filter (e.g. "Blur").


    needsGPU : bool

    Whether this filter requires GPU (GLSL) processing.


    qml : string

    The file name of the filter's User Interface (UI) parameter panel (relative to the filter directory).


    qmlFilePath : url

    The full URL to the filter's QML parameter panel file.


    seekReverse : bool

    Whether this filter may need to repeatedly perform reverse seeking for certain Time filters.


    type : int

    The plugin type. One of Filter (0), Producer (1), Transition (2), Link (3), or FilterSet (4).


    vui : string

    The file name of the filter's VUI overlay QML file (relative to the filter directory).


    vuiFilePath : url

    The full URL to the filter's VUI overlay file.