Skip to Content

XML effect file documentation ?

3 replies [Last post]
streumix
User offline. Last seen 1 day 10 hours ago. Offline
Joined: 01/22/2009
Posts:

Hi,

is there any sort of "compact" documentation regarding XML effect files available ?
What's the best place to start ?
Is it worth browsing the Kdenlive-devel mailing-list archive ro should I directly move on
reading the related kdenlive source code ?

Toby

0
Your rating: None
j-b-m
User offline. Last seen 1 day 11 hours ago. Offline
Joined: 07/17/2008
Posts:
Re: XML effect file documentation ?

Hi!

No, currently, there is no doc available. I just committed a minimal list of supported values in effectstackedit.cpp. Basically, the currently supported types are:

  • constant (=double): a slider with an integer value (use the "factor" attribute to divide the value so that you can get a double). For example if you set min=0 and max=100, your slider will return an value between 0 and 100. If you add factor=100, it will return a double between 0 and 1
  • list: a combobox containing a list of values to choose
  • bool: a checkbox
  • complex: designed for keyframe parameters, but old and not finished, do not use
  • geometry: a rectangle that can be moved & resized, with possible keyframes, used in composite transition
  • keyframe: a list widget with a list of entries (position and value)
  • color: a color chooser button
  • position: a slider representing the position of a frame in the current clip
  • wipe: a widget designed for the wipe transition, allowing to choose a position (left, right, top,...)

The xml structure should be fairly easy to understand if you look at the effects xml files. New types can be implemented in effectstackedit.cpp

regards

ddennedy
ddennedy's picture
User offline. Last seen 2 weeks 27 min ago. Offline
Joined: 06/26/2007
Posts:
Re: XML effect file documentation ?

It should be noted that in order to create such a file, you must understand well the MLT properties of the MLT filter you want to work with. Some filters are bridges to frei0r, sox, or LADSPA, and you need to understand the mapping of their parameter to MLT's properties. Unfortunately, not all of the MLT filters and its properties are as well-documented as the framework and API. Please ask questions about this on the mlt-devel mailing list on SourceForge.

streumix
User offline. Last seen 1 day 10 hours ago. Offline
Joined: 01/22/2009
Posts:
Re: XML effect file documentation ?

Thanks for your feedback !
Now I know where I have to search and ask :-)

Toby