MLT XML Annotations

Shotcut adds several XML elements and attributes to the MLT XML it generates. Also, currently it needs many of these to properly map MLT objects into the Shotcut UI.

MLT Object MLT Property XPath Description
tractor shotcut /mlt/tractor/property[@name = ‘shotcut’] Set to 1 on a to indicate that Shotcut can edit this MLT XML.
tractor shotcut:virtual /mlt/tractor/property[@name = ‘shotcut:virtual’] Set to 1 to force Shotcut to load this XML as a virtual clip.
producer shotcut:comment //producer/property[@name = ‘shotcut:comment’] Stores the user’s comments about a clip or shot.
playlist shotcut:name //playlist/property[@name = ‘shotcut:name’] The name of the track in the multitrack timeline.
playlist shotcut:audio //playlist/property[@name = ‘shotcut:audio’] Set to 1 to indicate this is an audio-only track.
playlist shotcut:video //playlist/property[@name = ‘shotcut:video’] Set to 1 to indicate this is an audio/video track.
tractor shotcut:trackHeight /mlt/tractor/property[@name = ‘shotcut:trackHeight’] Stores the track height in pixel units.
tractor shotcut:scaleFactor /mlt/tractor/property[@name = ‘shotcut:scaleFactor’] Stores the timeline zoom level as a real number.
filter shotcut:filter //filter/property[@name = ‘shotcut:filter’] This is the Shotcut identifier for a filter. There can be more than one Shotcut filter UI for a single MLT filter. This provides disambiguation. The identifier comes from the filter’s QML Metadata.
transition shotcut:transition //transition/property[@name = ‘shotcut:transition’] This is the Shotcut identifier for a transition. There can be more than one Shotcut transition UI for a single MLT transition. This provides disambiguation. A lot of times in the code, this is just checked to see if the MLT transition represents a transition that the user added instead of one that Shotcut adds automatically to provide audio mixing and video compositing.
producer shotcut:producer //producer/property[@name = ‘shotcut:producer’] This is the Shotcut identifier for a producer. There can be more than one Shotcut producer UI for a single MLT producer. Or, there can be more than one MLT producer for a single Shotcut UI. This property can be used to specify the proper Shotcut UI in case it can not be inferred from the producer service name.
producer shotcut_aspect_num //producer[property/@name =’mlt_service’ and (property/text() = ‘avformat’ or property/text() = ‘qimage’ or property/text() = ‘pixbuf’)]/property[@name = ‘shotcut_aspect_num’] The numerator of the display aspect ratio.
producer shotcut_aspect_den //producer[property/@name = ‘mlt_service’ and (property/text() = ‘avformat’ or property/text() = ‘qimage’ or property/text() = ‘pixbuf’)]/property[@name = ‘shotcut_aspect_den’] The denominator of the display aspect ratio.
producer shotcut_sequence //producer[property/@name = ‘mlt_service’ and (property/text() = ‘qimage’ or property/text() = ‘pixbuf’)]/property[@name=’shotcut_sequence’] Set to 1 to indicate this is an image sequence.
producer shotcut_resource //producer[property/@name = ‘mlt_service’ and (property/text() = ‘qimage’ or property/text() = ‘pixbuf’)]/property[@name=’shotcut_resource’] When working with image sequences, this stores the image file that the user selected since Shotcut will set the MLT resource property to something suitable for image sequences.
producer shotcut:caption //producer/property[@name = ‘shotcut:caption’] Used to provide a friendly name for a producer to be used for display to the user
producer shotcut:detail //producer/property[@name = ‘shotcut:detail’] Used to provide a more detailed description for the producer than the caption. For example if the caption is the file name, the detail could be the full file path

Warning: All of these are subject to change as Shotcut is still in early development.

In addition to these, Shotcut expects the following things in regular MLT XML:

About

Shotcut is a free, open source, cross-platform video editor for Windows, Mac and Linux. Major features include support for a wide range of formats; no import required meaning native timeline editing; Blackmagic Design support for input and preview monitoring; and resolution support to 4k.

Social Links

Copyright © 2011-2016 by Meltytech, LLC.
Shotcut is a trademark of Meltytech, LLC.

Site design by Magnetic Image. Magnetic Image, Inc.