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: in
  42     title: In point
  43     type: time
  44     description: Set the start time offset to use within the clip
  45     readonly: no
  46     mutable: no
  47     minimum: 0
  48     default: 0
  49     widget: timecode
  50
  51   - identifier: out
  52     title: Out point
  53     type: time
  54     description: Set the ending time offset to use within the clip
  55     readonly: no
  56     minimum: 0
  57     mutable: no
  58     widget: timecode
  59
  60   - identifier: markup
  61     title: Markup
  62     type: string
  63     description: |
  64       A string containing Pango markup see:
  65       http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html
  66       requires xml-like encoding special chars from:
  67       <, >, &   -to-   &lt;, &gt;, &amp;
  68     readonly: no
  69     mutable: yes
  70     widget: textbox
  71
  72   - identifier: fgcolour
  73     title: Foreground color
  74     type: string
  75     description: an RGBA colour specification of the text (i.e. 0xrrggbbaa)
  76     readonly: no
  77     mutable: yes
  78     widget: color
  79
  80   - identifier: bgcolour
  81     title: Background color
  82     type: string
  83     description: an RGBA colour of the background rectangle (i.e. 0xrrggbbaa)
  84     readonly: no
  85     mutable: yes
  86     widget: color
  87
  88   - identifier: align
  89     title: Paragraph alignment
  90     type: string
  91     description: >
  92       left, centre, right (also, numbers 0, 1 and 2 can be used respectively)
  93     readonly: no
  94     mutable: yes
  95     widget: combobox
  96
  97   - identifier: pad
  98     title: Padding
  99     type: integer
 100     description: >
 101       The number of pixels to pad the background rectangle beyond edges of text.
 102     readonly: no
 103     default: 0
 104     mutable: yes
 105     widget: spinner
 106
 107   - identifier: text
 108     title: Text
 109     type: string
 110     description: |
 111       A non-markup string in UTF-8 encoding
 112       (can contain markup chars un-encoded)
 113     readonly: no
 114     mutable: yes
 115     widget: textbox
 116
 117   - identifier: font
 118     title: Font
 119     type: string
 120     description: The default typeface to use when not using markup.
 121     default: "Sans 48". FreeType2 renders at 72 dpi.
 122     readonly: no
 123     mutable: yes
 124     widget: combobox
 125
 126   - identifier: weight
 127     title: Font weight
 128     type: integer
 129     description: The weight of the font.
 130     default: 400
 131     readonly: no
 132     mutable: yes
 133     widget: spinner
 134
 135   - identifier: encoding
 136     title: Encoding
 137     type: string
 138     description: >
 139       The text encoding type of the input if not UTF-8.
 140       See 'iconv --list' for a list of possible inputs.
 141     default: UTF-8
 142     readonly: no
 143     mutable: yes
 144     widget: combobox
 145
 146   - identifier: resource
 147     title: Resource
 148     type: string
 149     description: The text/markup file or "pango" if no file.
 150     readonly: yes
 151
 152   - identifier: real_width
 153     title: Real width
 154     type: integer
 155     description: The original, unscaled width of the rendered title.
 156     readonly: yes
 157
 158   - identifier: real_height
 159     title: Real height
 160     type: integer
 161     description: The original, unscaled height of the rendered title.
 162     readonly: yes
 163
 164   - identifier: width
 165     title: Width
 166     type: integer
 167     description: The last requested scaled image width.
 168     readonly: yes
 169
 170   - identifier: height
 171     title: Height
 172     type: integer
 173     description: The last requested scaled image height.
 174     readonly: yes