Shotcut QML Scripting API 26

Overview

Warning: This API is subject to change and may not be stable across Shotcut versions.

Shotcut exposes its internal state to QML views through two mechanisms:

Registered types — classes you can instantiate directly in QML using their type name (e.g. Filter, File, Metadata).
Context properties — singleton objects injected into every view's root context and accessed by a fixed name (e.g. application, profile, settings).

Modules

Shotcut.Controls QML Module	C++-backed UI controls and dialogs for Shotcut QML views.
org.shotcut.qml QML Module	Types for filter scripting, metadata, and file access in Shotcut.

Context Properties (Singletons)

These objects are available in every Shotcut QML view without import statements:

Name	Type	Description
`application`	Application	Application-wide utilities (copy/paste filters, status messages, etc.)
`profile`	Profile	Current project video profile (width, height, fps, aspect ratio)
`settings`	Settings	Persistent user settings (timeline options, fade durations, etc.)

Per-View Context Properties

Additional context properties are injected by specific dock/view classes:

View	Name	Type
Filter panels	`filter`	Filter
Filter panels	`producer`	Producer
Filter panels	`metadata`	Metadata
Filter panels	`motionTrackerModel`	MotionTrackerModel
Video player	`video`	VideoWidget
HDR preview	`hdrWindow`	HdrPreviewWindow
Keyframes dock	`keyframes`	KeyframesDock
Keyframes dock	`parameters`	KeyframesModel
Timeline dock	`timeline`	TimelineDock
Timeline dock	`multitrack`	MultitrackModel
Timeline dock	`markers`	MarkersModel
Timeline dock	`subtitlesModel`	SubtitlesModel
Timeline dock	`subtitlesSelectionModel`	SubtitlesSelectionModel
Filters dock	`attachedfiltersmodel`	AttachedFiltersModel
All docks	`view`	QmlView