git.sesse.net Git - mlt/blob - src/modules/core/filter_data_show.yml

   1 schema_version: 0.1
   2 type: filter
   3 identifier: data_show
   4 title: Template
   5 version: 1
   6 copyright: Ushodaya Enterprises Limited
   7 creator: Charles Yates
   8 license: LGPLv2.1
   9 language: en
  10 tags:
  11   - Video
  12 description: Show data based on properties of the producer.
  13 notes: |
  14   The data show filter uses data provided by the data feed filter.
  15   The producer properties must supply: >
  16     * The keyword text to be inserted in the form of:
  17     meta.attr.[keyword].markup=[text to insert]
  18
  19     * The name of the properties to be used from the feed file in the form of:
  20     meta.attr.[name]=1
  21
  22     * The text to be displayed in the form of:
  23     meta.attr.[name].markup=[some text #keyword#]
  24     (Keyword text is enclosed between #s.)
  25
  26   e.g.
  27   melt file.dv meta.attr.sometext.markup="this is some text" meta.attr.titles=1 meta.attr.titles.markup=#sometext# -filter data_show dynamic=1
  28   >
  29   Two special keywords exist
  30   * #timecode# shows the frame position as a timecode.
  31   * #frame# shows the frame position as an integer.
  32   e.g.
  33   melt file.dv meta.attr.timecode=1 meta.attr.timecode.markup=#timecode# -attach data_feed:attr_check -attach data_show:custom_file.properties dynamic=1
  34   (where the file "custom_file" contains a filter definition by the name of "timecode")
  35 parameters:
  36   - identifier: argument
  37     title: Feed Properties File
  38     type: string
  39     required: no
  40     readonly: no
  41     default: data_fx.properties
  42     widget: fileopen
  43
  44   - identifier: dynamic
  45     title: Dynamic
  46     type: integer
  47     default: 0
  48     minimum: 0
  49     maximum: 1
  50     widget: checkbox