X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=src%2Fmodules%2Fxml%2Fconsumer_xml.yml;h=b75a90e39bdfccf2252c3f2a53f0c80aa9a278dc;hb=236717e4ecc23e458e191b6c9a2ba70915b80937;hp=efe10c21fe48a4c030920709845398b27cb9751c;hpb=81e8683ca5f4653223d3b3099a4b6f10b4217138;p=mlt

diff --git a/src/modules/xml/consumer_xml.yml b/src/modules/xml/consumer_xml.yml
index efe10c21..b75a90e3 100644
--- a/src/modules/xml/consumer_xml.yml
+++ b/src/modules/xml/consumer_xml.yml
@@ -13,16 +13,33 @@ tags:
 description: >
   Serialise the service network to XML.
   See docs/mlt-xml.txt for more information.
+
+notes: >
+  If you set a data property beginning with (and longer than) "xml_retain" on
+  the service connected to this consumer where the data is a mlt_service
+  pointer, then the pointed at service will also be serialized before the
+  connected service. This can be useful, for example, to save a playlist as
+  a media bin along with a multitrack. You can serialize more than one of these
+  additional services by setting more than property, each with a unique key
+  beginning with "xml_retain".
+
 bugs:
    - Untested arbitrary nesting of multitracks and playlists.
    - >
      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
@@ -66,3 +83,22 @@ parameters:
     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
+
+  - identifier: 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.