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: an RGBA colour specification of the text (i.e. 0xrrggbbaa)
  57     readonly: no
  58     mutable: yes
  59     widget: color
  60
  61   - identifier: bgcolour
  62     title: Background color
  63     type: string
  64     description: an RGBA colour of the background rectangle (i.e. 0xrrggbbaa)
  65     readonly: no
  66     mutable: yes
  67     widget: color
  68
  69   - identifier: align
  70     title: Paragraph alignment
  71     type: string
  72     description: >
  73       left, centre, right (also, numbers 0, 1 and 2 can be used respectively)
  74     readonly: no
  75     mutable: yes
  76     widget: combo
  77
  78   - identifier: pad
  79     title: Padding
  80     type: integer
  81     description: >
  82       The number of pixels to pad the background rectangle beyond edges of text.
  83     readonly: no
  84     default: 0
  85     mutable: yes
  86     widget: spinner
  87
  88   - identifier: text
  89     title: Text
  90     type: string
  91     description: |
  92       A non-markup string in UTF-8 encoding
  93       (can contain markup chars un-encoded)
  94     readonly: no
  95     mutable: yes
  96     widget: textbox
  97
  98   - identifier: font
  99     title: Font
 100     type: string
 101     description: >
 102       The default typeface to use when not using markup.
 103       FreeType2 renders at 72 dpi.
 104     default: Sans 48
 105     readonly: no
 106     mutable: yes
 107     widget: combo
 108
 109   - identifier: weight
 110     title: Font weight
 111     type: integer
 112     description: The weight of the font.
 113     default: 400
 114     readonly: no
 115     mutable: yes
 116     widget: spinner
 117
 118   - identifier: encoding
 119     title: Encoding
 120     type: string
 121     description: >
 122       The text encoding type of the input if not UTF-8.
 123       See 'iconv --list' for a list of possible inputs.
 124     default: UTF-8
 125     readonly: no
 126     mutable: yes
 127     widget: combo
 128
 129   - identifier: real_width
 130     title: Real width
 131     type: integer
 132     description: The original, unscaled width of the rendered title.
 133     readonly: yes
 134
 135   - identifier: real_height
 136     title: Real height
 137     type: integer
 138     description: The original, unscaled height of the rendered title.
 139     readonly: yes
 140
 141   - identifier: width
 142     title: Width
 143     type: integer
 144     description: The last requested scaled image width.
 145     readonly: yes
 146
 147   - identifier: height
 148     title: Height
 149     type: integer
 150     description: The last requested scaled image height.
 151     readonly: yes