Add xml_retain property support to xml module.

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

diff --git a/src/modules/xml/producer_xml.yml b/src/modules/xml/producer_xml.yml
index ab824d00fb06475be6e1e7700dd8da29d885383b..0df379acb19904263923eb47b9ab1a73065c1589 100644 (file)
--- a/src/modules/xml/producer_xml.yml
+++ b/src/modules/xml/producer_xml.yml
@@ -10,3 +10,24 @@ language: en
 tags:
   - Audio
   - Video
+description: |
+  Construct a service network from an XML description. See docs/mlt-xml.txt.
+
+notes: >
+  If there is a service with a property "xml_retain=1" that is not the
+  producer, and if it also has an "id" property; then the extra service
+  is put into a properties list keyed on the id property. Then, that
+  properties list is placed as a property on the returned service with
+  the name "xml_retain". This lets an application retrieve additional
+  deserialized services that are not the lastmost producer or anywhere in
+  its graph.
+
+parameters:
+  - identifier: argument
+    title: File
+    type: string
+    description: An XML text file containing MLT XML.
+    readonly: no
+    required: yes
+    mutable: no
+    widget: fileopen