libmlt-data 0.9.2-2 / usr / share / mlt / gtk2 / producer_pango.yml

schema_version: 0.1
type: producer
identifier: pango
title: Pango
version: 2
copyright: Ushodaya Enterprises Limited
creator: Dan Dennedy
license: LGPLv2.1
language: en
tags:
  - Video
description: >
  A title generator that uses the Pango international text layout and Freetype2 
  font renderer.
notes: >
  Supplying a filename with extension ".txt" causes the loader producer to load 
  with pango. If the filename begins with "+" the pango producer interprets the 
  filename as pango text. This is a shortcut to embed titles in melt commands. 
  For MLT XML, it is recommended that you embed the title text in the property 
  value.
  
  Pango has builtin scaling. It will rescale the originally rendered title to
  whatever the consumer requests. Therefore, it will lose its aspect ratio if 
  so requested, and it is up to the consumer to request a proper width and 
  height that maintains the image aspect.

parameters:
  - identifier: argument
    title: File
    type: string
    description: |
      A text file containing Pango markup, see:
      http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html
      requires xml-like encoding special chars from:
      <, >, &   -to-   &lt;, &gt;, &amp;
    readonly: no
    required: yes
    mutable: no
    widget: fileopen
    
  - identifier: markup
    title: Markup
    type: string
    description: |
      A string containing Pango markup see:
      http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html
      requires xml-like encoding special chars from:
      <, >, &   -to-   &lt;, &gt;, &amp;
    readonly: no
    mutable: yes
    widget: textbox
    
  - identifier: fgcolour
    title: Foreground color
    type: string
    description: >
      A color value is a hexadecimal representation of RGB plus alpha channel 
      as 0xrrggbbaa. Colors can also be the words: white, black, red, green,
      or blue. You can also use a HTML-style color values #rrggbb or #aarrggbb.
    readonly: no
    mutable: yes
    widget: color
    
  - identifier: bgcolour
    title: Background color
    type: string
    description: >
      A color value is a hexadecimal representation of RGB plus alpha channel 
      as 0xrrggbbaa. Colors can also be the words: white, black, red, green,
      or blue. You can also use a HTML-style color values #rrggbb or #aarrggbb.
    readonly: no
    mutable: yes
    widget: color
    
  - identifier: olcolour
    title: Outline color
    type: string
    description: >
      A color value is a hexadecimal representation of RGB plus alpha channel 
      as 0xrrggbbaa. Colors can also be the words: white, black, red, green,
      or blue. You can also use a HTML-style color values #rrggbb or #aarrggbb.
    readonly: no
    mutable: yes
    widget: color
    
  - identifier: outline
    title: Outline Width
    type: string
    description: >
      The width of the outline in pixels.
    readonly: no
    default: 0
    minimum: 0
    maximum: 3
    mutable: yes
    widget: spinner
    
  - identifier: align
    title: Paragraph alignment
    type: string
    description: >
      left, centre, right (also, numbers 0, 1 and 2 can be used respectively)
    readonly: no
    default: left
    mutable: yes
    widget: combo

  - identifier: pad
    title: Padding
    type: integer
    description: >
      The number of pixels to pad the background rectangle beyond edges of text.
    readonly: no
    default: 0
    mutable: yes
    widget: spinner
    
  - identifier: text
    title: Text
    type: string
    description: |
      A non-markup string in UTF-8 encoding 
      (can contain markup chars un-encoded)
    readonly: no
    mutable: yes
    widget: textbox

  - identifier: font
    title: Font
    type: string
    description: >
      The default typeface to use when not using markup. 
      FreeType2 renders at 72 dpi.
      This property is deprecated. Use family, size and style instead.
    readonly: no
    mutable: yes
    widget: combo
    
  - identifier: family
    title: Font family
    type: string
    description: >
      The default typeface to use when not using markup. 
    default: Sans
    readonly: no
    mutable: yes
    widget: combo
    
  - identifier: size
    title: Font size
    type: integer
    description: >
      The size in pixels of the font to use when not using markup. 
    default: 48
    readonly: no
    mutable: yes
    widget: spinner
    
  - identifier: style
    title: Font style
    type: string
    description: >
      The style of the font to use when not using markup.
    values:
      - normal
      - italic
    default: normal
    readonly: no
    mutable: yes
    widget: combo
    
  - identifier: weight
    title: Font weight
    type: integer
    description: The weight of the font.
    minimum: 100
    maximum: 1000
    default: 400
    readonly: no
    mutable: yes
    widget: spinner
    
  - identifier: encoding
    title: Encoding
    type: string
    description: >
      The text encoding type of the input if not UTF-8.
      See 'iconv --list' for a list of possible inputs.
    default: UTF-8
    readonly: no
    mutable: yes
    widget: combo

  - identifier: real_width
    title: Real width
    type: integer
    description: The original, unscaled width of the rendered title.
    readonly: yes
    
  - identifier: real_height
    title: Real height
    type: integer
    description: The original, unscaled height of the rendered title.
    readonly: yes

  - identifier: width
    title: Width
    type: integer
    description: The last requested scaled image width.
    readonly: yes
    
  - identifier: height
    title: Height
    type: integer
    description: The last requested scaled image height.
    readonly: yes
    
  - identifier: force_aspect_ratio
    title: Sample aspect ratio
    type: float
    description: Optionally override a (mis)detected aspect ratio
    mutable: yes