git.sesse.net Git - mlt/blob - src/modules/qt/producer_qtext.yml

   1 schema_version: 0.1
   2 type: producer
   3 identifier: qtext
   4 title: QT Titler
   5 version: 1
   6 copyright: Brian Matherly
   7 creator: Brian Matherly
   8 license: LGPLv2.1
   9 language: en
  10 tags:
  11   - Video
  12 description: >
  13   A title generator that uses the Qt framework to render text.
  14 notes: >
  15   qtext accepts a file name with at ".txt" extension. If the filename begins
  16   with "+" the qtext producer interprets the filename as text. This is a
  17   shortcut to embed titles in melt commands. For MLT XML, it is recommended that
  18   you embed the title text in the "text" property value.
  19
  20   qtext has builtin scaling. It will rescale the originally rendered title to
  21   whatever the consumer requests. Therefore, it will lose its aspect ratio if
  22   so requested, and it is up to the consumer to request a proper width and
  23   height that maintains the image aspect.
  24
  25 parameters:
  26   - identifier: argument
  27     title: File
  28     type: string
  29     description: |
  30       A text file containing text to be rendered.
  31       The text file contents initialize the value of the "text" parameter.
  32     readonly: no
  33     required: no
  34     mutable: no
  35     widget: fileopen
  36
  37   - identifier: text
  38     title: Text
  39     type: string
  40     description: |
  41       A text string to be rendered.
  42     readonly: no
  43     mutable: yes
  44     widget: textbox
  45
  46   - identifier: fgcolour
  47     title: Foreground color
  48     type: string
  49     description: >
  50       A color value is a hexadecimal representation of RGB plus alpha channel
  51       as 0xrrggbbaa. Colors can also be the words: white, black, red, green,
  52       or blue. You can also use a HTML-style color values #rrggbb or #aarrggbb.
  53     readonly: no
  54     mutable: yes
  55     widget: color
  56
  57   - identifier: bgcolour
  58     title: Background 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     readonly: no
  65     mutable: yes
  66     widget: color
  67
  68   - identifier: olcolour
  69     title: Outline 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     readonly: no
  76     mutable: yes
  77     widget: color
  78
  79   - identifier: outline
  80     title: Outline Width
  81     type: string
  82     description: >
  83       The width of the outline in pixels.
  84     readonly: no
  85     default: 0
  86     minimum: 0
  87     maximum: 3
  88     mutable: yes
  89     widget: spinner
  90
  91   - identifier: align
  92     title: Paragraph alignment
  93     type: string
  94     description: >
  95       left, center, right
  96     readonly: no
  97     default: left
  98     mutable: yes
  99     widget: combo
 100
 101   - identifier: pad
 102     title: Padding
 103     type: integer
 104     description: >
 105       The number of pixels to pad the background rectangle beyond edges of text.
 106     readonly: no
 107     default: 0
 108     mutable: yes
 109     widget: spinner
 110
 111   - identifier: family
 112     title: Font family
 113     type: string
 114     description: >
 115       The font typeface.
 116     default: Sans
 117     readonly: no
 118     mutable: yes
 119     widget: combo
 120
 121   - identifier: size
 122     title: Font size
 123     type: integer
 124     description: >
 125       The size in pixels of the font.
 126     default: 48
 127     readonly: no
 128     mutable: yes
 129     widget: spinner
 130
 131   - identifier: style
 132     title: Font style
 133     type: string
 134     description: >
 135       The style of the font.
 136     values:
 137       - normal
 138       - italic
 139     default: normal
 140     readonly: no
 141     mutable: yes
 142     widget: combo
 143
 144   - identifier: weight
 145     title: Font weight
 146     type: integer
 147     description: The weight of the font.
 148     minimum: 100
 149     maximum: 1000
 150     default: 400
 151     readonly: no
 152     mutable: yes
 153     widget: spinner
 154
 155   - identifier: encoding
 156     title: Encoding
 157     type: string
 158     description: >
 159       The text encoding type of the "text" parameter.
 160     default: UTF-8
 161     readonly: no
 162     mutable: yes
 163     widget: combo
 164
 165   - identifier: force_aspect_ratio
 166     title: Sample aspect ratio
 167     type: float
 168     description: Optionally override a (mis)detected aspect ratio
 169     mutable: yes
 170
 171   - identifier: meta.media.width
 172     title: Real width
 173     type: integer
 174     description: The original, unscaled width of the rendered image.
 175     readonly: yes
 176
 177   - identifier: meta.media.height
 178     title: Real height
 179     type: integer
 180     description: The original, unscaled height of the rendered image.
 181     readonly: yes
 182
 183   - identifier: width
 184     title: Width
 185     type: integer
 186     description: The last requested scaled image width.
 187     readonly: yes
 188
 189   - identifier: height
 190     title: Height
 191     type: integer
 192     description: The last requested scaled image height.
 193     readonly: yes