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

   1 schema_version: 0.1
   2 type: producer
   3 identifier: pango
   4 title: Pango
   5 version: 1
   6 copyright: Ushodaya Enterprises Limited
   7 creator: Dan Dennedy
   8 license: LGPLv2.1
   9 language: en
  10 tags:
  11   - Video
  12 description: >
  13   A title generator that uses the Pango international text layout and Freetype2
  14   font renderer.
  15 notes: >
  16   Supplying a filename with extension ".txt" causes the loader producer to load
  17   with pango. If the filename begins with "+" the pango producer interprets the
  18   filename as pango text. This is a shortcut to embed titles in melt commands.
  19   For MLT XML, it is recommended that you embed the title text in the property
  20   value.
  21
  22   Pango has builtin scaling. It will rescale the originally rendered title to
  23   whatever the consumer requests. Therefore, it will lose its aspect ratio if
  24   so requested, and it is up to the consumer to request a proper width and
  25   height that maintains the image aspect.
  26
  27 parameters:
  28   - identifier: argument
  29     title: File
  30     type: string
  31     description: |
  32       A text file containing Pango markup, see:
  33       http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html
  34       requires xml-like encoding special chars from:
  35       <, >, &   -to-   &lt;, &gt;, &amp;
  36     readonly: no
  37     required: yes
  38     mutable: no
  39     widget: fileopen
  40
  41   - identifier: markup
  42     title: Markup
  43     type: string
  44     description: |
  45       A string containing Pango markup see:
  46       http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html
  47       requires xml-like encoding special chars from:
  48       <, >, &   -to-   &lt;, &gt;, &amp;
  49     readonly: no
  50     mutable: yes
  51     widget: textbox
  52
  53   - identifier: fgcolour
  54     title: Foreground color
  55     type: string
  56     description: >
  57       A color value is a hexadecimal representation of RGB plus alpha channel
  58       as 0xrrggbbaa. Colors can also be the words: white, black, red, green,
  59       or blue. You can also use a HTML-style color values #rrggbb or #aarrggbb.
  60     readonly: no
  61     mutable: yes
  62     widget: color
  63
  64   - identifier: bgcolour
  65     title: Background color
  66     type: string
  67     description: >
  68       A color value is a hexadecimal representation of RGB plus alpha channel
  69       as 0xrrggbbaa. Colors can also be the words: white, black, red, green,
  70       or blue. You can also use a HTML-style color values #rrggbb or #aarrggbb.
  71     readonly: no
  72     mutable: yes
  73     widget: color
  74
  75   - identifier: align
  76     title: Paragraph alignment
  77     type: string
  78     description: >
  79       left, centre, right (also, numbers 0, 1 and 2 can be used respectively)
  80     readonly: no
  81     mutable: yes
  82     widget: combo
  83
  84   - identifier: pad
  85     title: Padding
  86     type: integer
  87     description: >
  88       The number of pixels to pad the background rectangle beyond edges of text.
  89     readonly: no
  90     default: 0
  91     mutable: yes
  92     widget: spinner
  93
  94   - identifier: text
  95     title: Text
  96     type: string
  97     description: |
  98       A non-markup string in UTF-8 encoding
  99       (can contain markup chars un-encoded)
 100     readonly: no
 101     mutable: yes
 102     widget: textbox
 103
 104   - identifier: font
 105     title: Font
 106     type: string
 107     description: >
 108       The default typeface to use when not using markup.
 109       FreeType2 renders at 72 dpi.
 110     default: Sans 48
 111     readonly: no
 112     mutable: yes
 113     widget: combo
 114
 115   - identifier: weight
 116     title: Font weight
 117     type: integer
 118     description: The weight of the font.
 119     default: 400
 120     readonly: no
 121     mutable: yes
 122     widget: spinner
 123
 124   - identifier: encoding
 125     title: Encoding
 126     type: string
 127     description: >
 128       The text encoding type of the input if not UTF-8.
 129       See 'iconv --list' for a list of possible inputs.
 130     default: UTF-8
 131     readonly: no
 132     mutable: yes
 133     widget: combo
 134
 135   - identifier: real_width
 136     title: Real width
 137     type: integer
 138     description: The original, unscaled width of the rendered title.
 139     readonly: yes
 140
 141   - identifier: real_height
 142     title: Real height
 143     type: integer
 144     description: The original, unscaled height of the rendered title.
 145     readonly: yes
 146
 147   - identifier: width
 148     title: Width
 149     type: integer
 150     description: The last requested scaled image width.
 151     readonly: yes
 152
 153   - identifier: height
 154     title: Height
 155     type: integer
 156     description: The last requested scaled image height.
 157     readonly: yes