Document the store property of xml consumer.

[mlt] / src / modules / xml / consumer_xml.yml

diff --git a/src/modules/xml/consumer_xml.yml b/src/modules/xml/consumer_xml.yml
index 894eff9979d62a95ce108e9be562b68aaf705d31..85eab0bf55bc91d5a69a97f7271e5d7d2b955fcd 100644 (file)
--- a/src/modules/xml/consumer_xml.yml
+++ b/src/modules/xml/consumer_xml.yml
@@ -19,15 +19,22 @@ bugs:
      Property "id" is generated as service type followed by number if no
      property named "id" exists, but it fails to guarantee uniqueness.
 parameters:
-  - identifier: argument
+  - identifier: resource
+    argument: yes
     title: File
     type: string
-    description: The name of a file in which to store the XML.
+    description: >
+      The name of a file in which to store the XML.
+      If the value does not contain a period (to start an extension), then
+      the value is interpreted as the name of a propery in which to store the
+      XML. This makes it easy for an application to use the consumer to
+      serialize a service network and retrieve the XML in-memory.
     readonly: no
     required: no
     mutable: no
     default: stdout
     widget: fileopen
+
   - identifier: all
     title: Process all frames
     type: integer
@@ -41,3 +48,46 @@ parameters:
     minimum: 0
     maximum: 1
     default: 0
+
+  - identifier: title
+    title: Title
+    type: string
+    description: >
+      You can give the composition a friendly name that some applications may use.
+
+  - identifier: root
+    title: Base path
+    type: string
+    description: >
+      If a file name in the XML is relative, but not relative to the current
+      XML file's directory, then you can set the directory to which it is
+      relative here.
+
+  - identifier: no_meta
+    title: Exclude meta properties
+    type: integer
+    description: >
+      Set this to disable the output of properties with the prefix "meta."
+    minimum: 0
+    maximum: 1
+    default: 0
+    widget: checkbox
+
+  - identifier: time_format
+    title: Time format
+    type: string
+    description: Output time-based values as timecode or clock formats.
+    values:
+      - frames
+      - smpte # or SMPTE
+      - timecode # same as smpte
+      - clock # or CLOCK
+    default: frames
+    widget: dropdown
+
+  - identififer: store
+    title: Include property prefix
+    type: string
+    description: >
+      To save additional properties that MLT does not know about, supply an
+      application-specific property name prefix that you are using.