• Shotcut QML Scripting API
  • org.shotcut.qml QML Module
  • org.shotcut.qml QML Module

    import org.shotcut.qml

    This module contains the core types used when writing Shotcut filter UI panels and VUI overlays. The most important type is Filter, which gives read/write access to an MLT filter's properties and keyframes.

    Types

    Application

    Application-wide utilities, accessed via the application context property

    AttachedFiltersModel

    A list model of filters attached to the currently selected clip or track

    File

    A file URL wrapper with optional filesystem change watching

    Filter

    Provides access to the current filter's properties, keyframes, and presets

    KeyframesDock

    Keyframes panel controller, available as the keyframes context property

    KeyframesMetadata

    Describes the keyframe capabilities of a filter

    KeyframesModel

    A two-level item model describing a filter's keyframeable parameters and their keyframes

    MarkersModel

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

    Metadata

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

    MotionTrackerModel

    A list model of motion tracker entries attached to the current producer

    MultitrackModel

    A two-level item model representing the timeline: tracks at the top level, clips within each track

    Parameter

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

    Producer

    Represents the clip currently loaded in the Filters panel, accessed via the producer context property

    Profile

    Describes the current project's Video Mode, accessed via the profile context property

    QmlExtension

    Represents a loadable Shotcut extension (e.g. the Whisper speech-to-text package)

    QmlExtensionFile

    Describes a single downloadable file within an extension package

    QmlView

    Provides access to the host widget geometry, available via the view context property

    RichText

    Provides rich-text editing helpers for the Text: Rich filter panel

    Settings

    Persistent application settings, accessed via the settings context property

    SubtitlesModel

    A two-level item model for subtitle tracks and subtitle items on the timeline

    SubtitlesSelectionModel

    Tracks the selected track and selected subtitle items in the Subtitles dock

    TimelineDock

    Timeline dock controller, available as the timeline context property