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: font
  40     title: Font
  41     type: string
  42     description: The typeface to use
  43     default: Sans 48
  44     readonly: no
  45     mutable: yes
  46     widget: font
  47   - identifier: weight
  48     title: Font weight
  49     type: integer
  50     description: The weight of the font.
  51     minimum: 100
  52     maximum: 900
  53     default: 400
  54     readonly: no
  55     mutable: yes
  56     widget: spinner
  57   - identifier: fgcolour
  58     title: Foreground color
  59     type: string
  60     description: >
  61       A color value is a hexadecimal representation of RGB plus alpha channel
  62       as 0xrrggbbaa. Colors can also be the words: white, black, red, green,
  63       or blue. You can also use a HTML-style color values #rrggbb or #aarrggbb.
  64     default: 0x000000ff
  65     readonly: no
  66     mutable: yes
  67     widget: color
  68   - identifier: bgcolour
  69     title: Background color
  70     type: string
  71     description: >
  72       A color value is a hexadecimal representation of RGB plus alpha channel
  73       as 0xrrggbbaa. Colors can also be the words: white, black, red, green,
  74       or blue. You can also use a HTML-style color values #rrggbb or #aarrggbb.
  75     default: 0x00000020
  76     readonly: no
  77     mutable: yes
  78     widget: color
  79   - identifier: olcolour
  80     title: Outline color
  81     type: string
  82     description: >
  83       A color value is a hexadecimal representation of RGB plus alpha channel
  84       as 0xrrggbbaa. Colors can also be the words: white, black, red, green,
  85       or blue. You can also use a HTML-style color values #rrggbb or #aarrggbb.
  86     readonly: no
  87     mutable: yes
  88     widget: color
  89   - identifier: outline
  90     title: Outline Width
  91     type: string
  92     description: >
  93       The width of the outline in pixels.
  94     readonly: no
  95     default: 0
  96     minimum: 0
  97     maximum: 3
  98     mutable: yes
  99     widget: spinner
 100   - identifier: pad
 101     title: Padding
 102     type: integer
 103     description: >
 104       The number of pixels to pad the background rectangle beyond edges of text.
 105     readonly: no
 106     default: 0
 107     mutable: yes
 108     widget: spinner
 109   - identifier: halign
 110     title: Horizontal alignment
 111     description: >
 112       Set the horizontal alignment within the geometry rectangle.
 113     type: string
 114     default: left
 115     values:
 116       - left
 117       - centre
 118       - right
 119     mutable: yes
 120     widget: combo
 121   - identifier: valign
 122     title: Vertical alignment
 123     description: >
 124       Set the vertical alignment within the geometry rectangle.
 125     type: string
 126     default: top
 127     values:
 128       - top
 129       - middle
 130       - bottom
 131     mutable: yes
 132     widget: combo