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

   1 schema_version: 0.1
   2 type: filter
   3 identifier: watermark
   4 title: Overlay
   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: Overlay text or images onto the video
  13 notes: |
  14   The watermark filter combines a frame producer and a composite transition to
  15   overlay the specified text or image onto the video.
  16
  17   Supplying a filename with extension ".txt" causes the loader to load a pango
  18   producer. Supplying a file name with an extension supported by gtk-pixbuf
  19   causes the loader to load a pixbuf producer. See the pango and pixbuf
  20   producers for details.
  21
  22   Note: If the filename begins with "+" the pango producer interprets the
  23   filename as pango text.
  24
  25   Text Example:
  26   melt colour:red -filter watermark:"+First Line~Second Line.txt" composite.progressive=1 producer.align=centre composite.valign=c composite.halign=c
  27
  28   Image Example:
  29   melt clip.dv -filter watermark:logo.png
  30
  31 parameters:
  32   - identifier: argument
  33     title: File or Text
  34     type: string
  35     description: A pango or pixbuf producer file name.
  36     required: no
  37     readonly: no
  38     default: unset
  39     widget: fileopen
  40
  41   - identifier: resource
  42     title: File or Text
  43     type: string
  44     description: see argument
  45     required: no
  46     readonly: no
  47     default: unset
  48     widget: fileopen or text
  49
  50   - identifier: distort
  51     title: Allow distorted scaling
  52     type: integer
  53     default: 0
  54     minimum: 0
  55     maximum: 1
  56     widget: checkbox
  57
  58   - identifier: producer
  59     title: Pango or Pixbuf producer
  60     type: producer
  61     description: |
  62       A pango or pixbuf producer (as appropriate for the file name).
  63       Properties may be set on the producer to control its behavior.
  64       e.g.: producer.align=centre
  65       See "pango" and "pixbuf" producers for details.
  66     readonly: no
  67
  68   - identifier: composite
  69     title: Composite Transition
  70     type: transition
  71     description: |
  72       The transition that combines the images from the pango or pixbuf producer
  73       with the images from the track.
  74       Properties may be set on the composite to control its behavior.
  75       e.g.: composite.valign=c
  76       See "composite" transition for details.
  77     readonly: no