Filter: qtext

Plugin Information

title: QText
media types: Video
description: Overlay text onto the video
version: 7
creator:
copyright: Meltytech, LLC
license: LGPLv2.1

Parameters

argument

title: Text
description: The text to overlay.
type: string
readonly: no
required: yes
default: text
widget: text

geometry

title: Geometry
description: A set of X/Y coordinates by which to adjust the text.
type: rect
readonly: no
required: no
animation: yes
default: 0%/0%:100%x100%:100

family

title: Font family
description: The typeface of the font.
type: string
readonly: no
required: no
default: Sans
widget: combo

size

title: Font size
description: The size in pixels of the font.
type: integer
readonly: no
required: no
default: 48
unit: pixels
widget: spinner

style

title: Font style
description: The style of the font, for example, "italic" or "narrow" depending upon family
type: string
readonly: no
required: no
default: normal
widget: combo

weight

title: Font weight
description: The weight of the font.
type: integer
readonly: no
required: no
minimum: 100
maximum: 1000
default: 400
widget: spinner

fgcolour

title: Foreground color
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.
type: color
readonly: no
required: no
animation: yes
default: 255
widget: color

bgcolour

title: Background color
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.
type: color
readonly: no
required: no
animation: yes
default: 32
widget: color

olcolour

title: Outline color
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.
type: color
readonly: no
required: no
animation: yes
widget: color

outline

title: Outline Width
description: The width of the outline in pixels.
type: string
readonly: no
required: no
minimum: 0
maximum: 3
default: 0
unit: pixels
widget: spinner

underline

title: Underline
description: Apply underline decoration to the text.
type: boolean
readonly: no
required: no
default: 0
widget: checkbox

strikethrough

title: Strikethrough
description: Apply strikethrough decoration to the text.
type: boolean
readonly: no
required: no
default: 0
widget: checkbox

pad

title: Padding
description: The number of pixels to pad the background rectangle beyond edges of text.
type: integer
readonly: no
required: no
default: 0
unit: pixels
widget: spinner

halign

title: Horizontal alignment
description: Set the horizontal alignment within the geometry rectangle.
type: string
readonly: no
required: no
default: left
widget: combo
values:

  • l
  • left
  • c
  • center
  • centre
  • r
  • right

valign

title: Vertical alignment
description: Set the vertical alignment within the geometry rectangle.
type: string
readonly: no
required: no
default: top
widget: combo
values:

  • t
  • top
  • m
  • middle
  • b
  • bottom

html

title: HTML String
description: Render rich text from a string containing a subset of HTML 4. The only other properties that can be used with this are geometry and bgcolour. The geometry width and height defines the page or block size while its X and Y coordinates determine its position. This property has a higher priority than argument; argument is ignored if this property is set.
type: string
readonly: no
required: no

resource

title: HTML File
description: Render rich text from a file containing a subset of HTML 4. The only other properties that can be used with this are geometry and bgcolour. The geometry width and height defines the page or block size while its X and Y coordinates determine its position. This property has a higher priority than both argument and html; argument and html are ignored if this property is set.
type: string
readonly: no
required: no

_hide

title: Hide
description: Setting this property will not be serialized (unlike "disable"). When set true (1), the filter does not render. This allows an authoring tool to provide its own rendering while editing and then let the filter render outside the tool UI.
type: boolean
readonly: no
required: no
default: 0

overflow-y

title: Vertical Overflow
description: This option applies only when using html or resource properties. It controls whether the text will be cropped to the geometry property or allowed to overflow. When not set, it is automatic based on whether the geometry height is greater than or equal to the profile height. The default is unset/automatic.
type: boolean
readonly: no
required: no

pixel_ratio

title: Pixel Ratio
description: This option applies only when using html or resource properties. It adds a scaling factor to the rendering. This can be used to help to make MLT's output match a user interface. NOTE: this property is only used on Windows because it is the only platform found thus far that has different rendering behavior relative to device pixel ratio.
type: float
readonly: no
required: no
minimum: 1.0
default: 1.0

opacity

title: Opacity
description: Opacity of all elements - text, outline, and background
type: float
readonly: no
required: no
minimum: 0
maximum: 1.0
default: 1.0
widget: slider

typewriter

title: Typewriter Effect
description: Enable typewriter effect where text appears progressively over time.
type: boolean
readonly: no
required: no
minimum: 0
maximum: 1
default: 0
widget: checkbox

typewriter.step_length

title: Typewriter Step Length
description: Number of frames between each character, word, or line appearance.
type: integer
readonly: no
required: no
minimum: 1
default: 25
widget: spinner

typewriter.step_sigma

title: Typewriter Step Variation
description: Random variation in timing (standard deviation in frames).
type: integer
readonly: no
required: no
minimum: 0
default: 0
widget: spinner

typewriter.random_seed

title: Typewriter Random Seed
description: Seed value for random number generation in timing variations.
type: integer
readonly: no
required: no
minimum: 0
default: 0
widget: spinner

typewriter.macro_type

title: Typewriter Animation Mode
description: Granularity of typewriter animation.
type: integer
readonly: no
required: no
default: 1
widget: combo
values:

  • 1
  • 2
  • 3

typewriter.cursor

title: Typewriter Cursor
description: Show blinking cursor during typewriter animation. 0 = no cursor, 1 = cursor while typing, 2 = cursor always visible.
type: integer
readonly: no
required: no
minimum: 0
maximum: 2
default: 1
widget: combo

title: Cursor Blink Rate
description: Number of frames for cursor blink cycle (on + off).
type: integer
readonly: no
required: no
minimum: 0
default: 25
unit: frames
widget: spinner

typewriter.cursor_char

title: Cursor Character
description: Character to use for the blinking cursor.
type: string
readonly: no
required: no
default:
widget: text

Search

Subscribe

Subscribe to News via RSS.

Recent Posts

About

MLT enables you to author, manage, and run multitrack audio/video compositions. Copyright © 2008-2026 by Meltytech, LLC.

Social Links