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/URL
  34     type: string
  35     description: The file to overlay.
  36     required: no
  37     readonly: no
  38     default: unset
  39     widget: fileopen
  40
  41   - identifier: distort
  42     title: Allow distorted scaling
  43     type: integer
  44     default: 0
  45     minimum: 0
  46     maximum: 1
  47     widget: checkbox
  48
  49   - identifier: producer.*
  50     title: Producer
  51     description: |
  52       Properties may be set on the encapsulated producer.
  53       e.g.: producer.align=centre
  54       See "pango" and "pixbuf" producers for details.
  55     readonly: no
  56
  57   - identifier: composite.*
  58     title: Composite
  59     description: |
  60       Properties may be set on the encapsulated composite.
  61       e.g.: composite.valign=c
  62       See "composite" transition for details.
  63     readonly: no
  64
  65   - identifier: reverse
  66     title: Reverse
  67     type: integer
  68     description: Overlay the video to which the filter is applied atop the supplied file.
  69     minimum: 0
  70     maximum: 1
  71     mutable: yes
  72     widget: checkbox
  73
  74   - identifier: deinterlace
  75     description: Force the supplied file to be be deinterlaced if it is interlaced.
  76     type: integer
  77     description:
  78     minimum: 0
  79     maximum: 1
  80     mutable: yes
  81     widget: checkbox