git.sesse.net Git - mlt/blob - src/modules/xml/consumer_xml.yml

   1 schema_version: 0.1
   2 type: consumer
   3 identifier: xml
   4 title: XML
   5 version: 1
   6 copyright: Ushodaya Enterprises Limited
   7 creator: Dan Dennedy
   8 license: LGPLv2.1
   9 language: en
  10 tags:
  11   - Audio
  12   - Video
  13 description: >
  14   Serialise the service network to XML.
  15   See docs/mlt-xml.txt for more information.
  16 bugs:
  17    - Untested arbitrary nesting of multitracks and playlists.
  18    - >
  19      Property "id" is generated as service type followed by number if no
  20      property named "id" exists, but it fails to guarantee uniqueness.
  21 parameters:
  22   - identifier: resource
  23     argument: yes
  24     title: File
  25     type: string
  26     description: >
  27       The name of a file in which to store the XML.
  28       If the value does not contain a period (to start an extension), then
  29       the value is interpreted as the name of a propery in which to store the
  30       XML. This makes it easy for an application to use the consumer to
  31       serialize a service network and retrieve the XML in-memory.
  32     readonly: no
  33     required: no
  34     mutable: no
  35     default: stdout
  36     widget: fileopen
  37
  38   - identifier: all
  39     title: Process all frames
  40     type: integer
  41     description: >
  42       Without this option, the XML consumer does not process any frames
  43       and simply serializes the service network. However, some filters (.e.g,
  44       videostab) require two passes where the first pass performs some
  45       analysis and stores the result in a property. Therefore, set this
  46       property to 1 (true) to cause the consumer to process all frames
  47       before serializing to XML.
  48     minimum: 0
  49     maximum: 1
  50     default: 0
  51
  52   - identifier: title
  53     title: Title
  54     type: string
  55     description: >
  56       You can give the composition a friendly name that some applications may use.
  57
  58   - identifier: root
  59     title: Base path
  60     type: string
  61     description: >
  62       If a file name in the XML is relative, but not relative to the current
  63       XML file's directory, then you can set the directory to which it is
  64       relative here.
  65
  66   - identifier: no_meta
  67     title: Exclude meta properties
  68     type: integer
  69     description: >
  70       Set this to disable the output of properties with the prefix "meta."
  71     minimum: 0
  72     maximum: 1
  73     default: 0
  74     widget: checkbox
  75
  76   - identifier: time_format
  77     title: Time format
  78     type: string
  79     description: Output time-based values as timecode or clock formats.
  80     values:
  81       - frames
  82       - smpte # or SMPTE
  83       - timecode # same as smpte
  84       - clock # or CLOCK
  85     default: frames
  86     widget: dropdown
  87
  88   - identifier: store
  89     title: Include property prefix
  90     type: string
  91     description: >
  92       To save additional properties that MLT does not know about, supply an
  93       application-specific property name prefix that you are using.