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: argument
  23     title: File
  24     type: string
  25     description: >
  26       The name of a file in which to store the XML.
  27       If the value does not contain a period (to start an extension), then
  28       the value is interpreted as the name of a propery in which to store the
  29       XML. This makes it easy for an application to use the consumer to
  30       serialize a service network and retrieve the XML in-memory.
  31     readonly: no
  32     required: no
  33     mutable: no
  34     default: stdout
  35     widget: fileopen
  36
  37   - identifier: all
  38     title: Process all frames
  39     type: integer
  40     description: >
  41       Without this option, the XML consumer does not process any frames
  42       and simply serializes the service network. However, some filters (.e.g,
  43       videostab) require two passes where the first pass performs some
  44       analysis and stores the result in a property. Therefore, set this
  45       property to 1 (true) to cause the consumer to process all frames
  46       before serializing to XML.
  47     minimum: 0
  48     maximum: 1
  49     default: 0
  50
  51   - identifier: title
  52     title: Title
  53     type: string
  54     description: >
  55       You can give the composition a friendly name that some applications may use.
  56
  57   - identifier: root
  58     title: Base path
  59     type: string
  60     description: >
  61       If a file name in the XML is relative, but not relative to the current
  62       XML file's directory, then you can set the directory to which it is
  63       relative here.
  64
  65   - identifier: no_meta
  66     title: Exclude meta properties
  67     type: integer
  68     description: >
  69       Set this to disable the output of properties with the prefix "meta."
  70     minimum: 0
  71     maximum: 1
  72     default: 0
  73     widget: checkbox
  74
  75   - identifier: time_format
  76     title: Time format
  77     type: string
  78     description: Output time-based values as timecode or clock formats.
  79     values:
  80       - frames
  81       - smpte # or SMPTE
  82       - timecode # same as smpte
  83       - clock # or CLOCK
  84     default: frames
  85     widget: dropdown