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: The name of a file in which to store the XML.
  26     readonly: no
  27     required: no
  28     mutable: no
  29     default: stdout
  30     widget: fileopen
  31
  32   - identifier: all
  33     title: Process all frames
  34     type: integer
  35     description: >
  36       Without this option, the XML consumer does not process any frames
  37       and simply serializes the service network. However, some filters (.e.g,
  38       videostab) require two passes where the first pass performs some
  39       analysis and stores the result in a property. Therefore, set this
  40       property to 1 (true) to cause the consumer to process all frames
  41       before serializing to XML.
  42     minimum: 0
  43     maximum: 1
  44     default: 0
  45
  46   - identifier: title
  47     title: Title
  48     type: string
  49     description: >
  50       You can give the composition a friendly name that some applications may use.
  51
  52   - identifier: root
  53     title: Base path
  54     type: string
  55     description:
  56       If a file name in the XML is relative, but not relative to the current
  57       XML file's directory, then you can set the directory to which it is
  58       relative here.