git.sesse.net Git - mlt/blob - src/modules/xml/producer_xml.yml

   1 schema_version: 0.1
   2 type: producer
   3 identifier: xml
   4 title: XML File
   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   Construct a service network from an XML description. See docs/mlt-xml.txt.
  15 parameters:
  16   - identifier: argument
  17     title: URL
  18     type: string
  19     description: |
  20       An XML text file containing MLT XML
  21       Since MLT XML files can be parameterised, the URL syntax is:
  22       {file-name}[?{param-name}{'='|':'}{param-value}[&{param-name}{'='|':'}{param-value}...]]
  23       A colon is allowed instead of an equal sign to pacify melt, who tokenises
  24       anything with an equal sign as a property setting. Also, when running
  25       melt from the shell, beware of the '?' and shell filename expansion. You
  26       can surround the URL with single quotations to prevent expansion.
  27       Finally, the loader will fail to match the filename when you use
  28       parameters, so preface the url with 'xml:' to force the loader to load
  29       with the xml service.
  30     readonly: no
  31     required: yes
  32     mutable: no
  33     widget: fileopen
  34
  35   - identifier: resource
  36     title: Resource
  37     type: string
  38     description: File location. See "argument" above.
  39     readonly: yes