schema_version: 0.1
type: consumer
identifier: xml
title: XML
version: 1
copyright: Ushodaya Enterprises Limited
creator: Dan Dennedy
license: LGPLv2.1
language: en
tags:
  - Audio
  - Video
description: >
  Serialise the service network to XML.
  See docs/mlt-xml.txt for more information.
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
    title: File
    type: string
    description: The name of a file in which to store the XML.
    readonly: no
    required: no
    mutable: no
    default: stdout
    widget: fileopen

  - identifier: all
    title: Process all frames
    type: integer
    description: >
      Without this option, the XML consumer does not process any frames
      and simply serializes the service network. However, some filters (.e.g,
      videostab) require two passes where the first pass performs some
      analysis and stores the result in a property. Therefore, set this
      property to 1 (true) to cause the consumer to process all frames
      before serializing to XML.
    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.