git.sesse.net Git - mlt/blob - src/modules/gtk2/filter_dynamictext.yml

   1 schema_version: 0.1
   2 type: filter
   3 identifier: dynamictext
   4 title: Dynamic text
   5 version: 1
   6 copyright: Ushodaya Enterprises Limited
   7 creator: Brian Matherly
   8 license: LGPLv2.1
   9 language: en
  10 tags:
  11   - Video
  12 description: Overlay dynamic text onto the video
  13 notes: >
  14   The dynamic text filter will search for keywords in the text to be overlayed
  15   and will replace those keywords on a frame-by-frame basis.
  16
  17 parameters:
  18   - identifier: argument
  19     title: Dynamic text
  20     type: string
  21     description: |
  22       The text to overlay. May include keywords enclosed in "#".
  23       Keywords include:
  24         * #timecode# - timecode of the frame (based on framerate and position)
  25         * #frame#    - frame number of the frame
  26         * #filedate# - modification date of the file
  27       Keywords may also be any frame property (e.g. #meta.media.0.codec.frame_rate#)
  28       The # may be escaped with "\".
  29     required: yes
  30     readonly: no
  31     default: > #trick to escape "#" character
  32       #timecode#
  33     widget: text
  34   - identifier: geometry
  35     title: Geometry
  36     type: geometry
  37     description: A set of X/Y coordinates by which to adjust the text.
  38     default: 0%/0%:100%x100%:100
  39   - identifier: family
  40     title: Font family
  41     type: string
  42     description: >
  43       The typeface of the font.
  44     default: Sans
  45     readonly: no
  46     mutable: yes
  47     widget: combo
  48   - identifier: size
  49     title: Font size
  50     type: integer
  51     description: >
  52       The size in pixels of the font.
  53     default: 48
  54     readonly: no
  55     mutable: yes
  56     widget: spinner
  57   - identifier: weight
  58     title: Font weight
  59     type: integer
  60     description: The weight of the font.
  61     minimum: 100
  62     maximum: 1000
  63     default: 400
  64     readonly: no
  65     mutable: yes
  66     widget: spinner
  67   - identifier: fgcolour
  68     title: Foreground color
  69     type: string
  70     description: >
  71       A color value is a hexadecimal representation of RGB plus alpha channel
  72       as 0xrrggbbaa. Colors can also be the words: white, black, red, green,
  73       or blue. You can also use a HTML-style color values #rrggbb or #aarrggbb.
  74     default: 0x000000ff
  75     readonly: no
  76     mutable: yes
  77     widget: color
  78   - identifier: bgcolour
  79     title: Background color
  80     type: string
  81     description: >
  82       A color value is a hexadecimal representation of RGB plus alpha channel
  83       as 0xrrggbbaa. Colors can also be the words: white, black, red, green,
  84       or blue. You can also use a HTML-style color values #rrggbb or #aarrggbb.
  85     default: 0x00000020
  86     readonly: no
  87     mutable: yes
  88     widget: color
  89   - identifier: olcolour
  90     title: Outline color
  91     type: string
  92     description: >
  93       A color value is a hexadecimal representation of RGB plus alpha channel
  94       as 0xrrggbbaa. Colors can also be the words: white, black, red, green,
  95       or blue. You can also use a HTML-style color values #rrggbb or #aarrggbb.
  96     readonly: no
  97     mutable: yes
  98     widget: color
  99   - identifier: outline
 100     title: Outline Width
 101     type: string
 102     description: >
 103       The width of the outline in pixels.
 104     readonly: no
 105     default: 0
 106     minimum: 0
 107     maximum: 3
 108     mutable: yes
 109     widget: spinner
 110   - identifier: pad
 111     title: Padding
 112     type: integer
 113     description: >
 114       The number of pixels to pad the background rectangle beyond edges of text.
 115     readonly: no
 116     default: 0
 117     mutable: yes
 118     widget: spinner
 119   - identifier: halign
 120     title: Horizontal alignment
 121     description: >
 122       Set the horizontal alignment within the geometry rectangle.
 123     type: string
 124     default: left
 125     values:
 126       - left
 127       - centre
 128       - right
 129     mutable: yes
 130     widget: combo
 131   - identifier: valign
 132     title: Vertical alignment
 133     description: >
 134       Set the vertical alignment within the geometry rectangle.
 135     type: string
 136     default: top
 137     values:
 138       - top
 139       - middle
 140       - bottom
 141     mutable: yes
 142     widget: combo