LEAD Video Text Overlay Transform Attributes

UINT32 (BOOL)

LMF_TOVERLAY_ENABLETEXTOVERLAY

Enables or disables text overlaying. If set to VARIANT_FALSE, the transform will pass the video samples intact.

BSTR

LMF_TOVERLAY_FONTNAME

Sets or gets the font name. Use one of the installed fonts names. You can use EnumFonts API to enumerate the installed fonts.

UINT32 (long)

LMF_TOVERLAY_FONTCOLOR

Sets or gets the font foreground color.

UINT32 (BOOL)

LMF_TOVERLAY_BOLD

Enables or disables the bold font style.

UINT32 (BOOL)

LMF_TOVERLAY_UNDERLINE

Enables or disables the underline font style.

UINT32 (long)

LMF_TOVERLAY_ROTATIONANGLE

Sets or gets the rotation angle for the overlay text. The values range from 0 to 3600. For a multi-line text, each line is rotated independently.

UINT32 (long)

LMF_TOVERLAY_XPOS

Sets or gets the text X position.

UINT32 (BOOL)

LMF_TOVERLAY_ENABLETEXTFROMFILE

Enables or disables getting the overlay text from a file. To use the OverlayText property, set this property to VARIANT_FALSE. If this property is set to VARIANT_TRUE, then the TextFileName property must contain a valid file name.

UINT32 (TextAlignmentConstants)

LMF_TOVERLAY_TEXTALIGNMENT

Sets or gets the text alignment with respect to the output window. Possible values are one or more (ORed together) of the following:

ALIGN_TOP,
ALIGN_LEFT,
ALIGN_RIGHT,
ALIGN_BOTTOM,
ALIGN_VCENTER, or
ALIGN_HCENTER

UINT32 (long)

LMF_TOVERLAY_OUTLINEWIDTH

Sets or gets the text outline pen width. Valid values range from 1 to 20.

UINT32 (long)

LMF_TOVERLAY_FILLCOLOR

Sets or gets the text outline brush color. The brush is applied to the text body. This is a COLORREF value. You can use the RGB macro to form a COLORREF value from an RGB triple.

UINT32 (PenStyleConstants)

LMF_TOVERLAY_PENSTYLE

Sets or gets the outline text pen style. Possible values are:

PENS_SOLID,
PENS_DASH,
PENS_DOT,
PENS_DASHDOT, or
PENS_DASHDOTDOT.

UINT32 (ScrollDirectionConstants)

LMF_TOVERLAY_SCROLLDIRECTION

Sets or gets the text scrolling direction. This is valid and has effect only if the EnableTextFromFile property is set to VARIANT_TRUE and the XML file contains the scrolling option. Possible values are:

SCROLL_LEFT_RIGHT,
SCROLL_RIGHT_LEFT,
SCROLL_TOP_BOTTOM, or
SCROLL_BOTTOM_TOP.

UINT32 (BOOL)

LMF_TOVERLAY_WORDWRAP

Enables or disables the word wrap option. This is valid and has effect only if the EnableTextFromFile property is true.

UINT32 (long)

LMF_TOVERLAY_OPACITY

Sets or gets the desired opacity percentage.

UINT32 (long)

LMF_TOVERLAY_VIEWLEFT

Sets or gets the left coordinate, in pixels, of the view rectangle. This value is with respect to the video stream dimensions. The overlay text will be displayed within this view rectangle. The default value is zero.

UINT32 (long)

LMF_TOVERLAY_VIEWTOP

Sets or gets the top (upper) coordinate, in pixels, of the view rectangle. This value is with respect to the video stream dimensions. The overlay text will be displayed within this view rectangle. The default value is zero.

UINT32 (BOOL)

LMF_TOVERLAY_AUTOREPOSTOVIEWRECT

Enables or disables auto repositioning of the overlay text to the view rectangle. If set to VARIANT_TRUE, the transform will use the current values of XPos and YPos with respect to the view rectangle instead of the whole video stream rectangle.

UINT32 (BOOL)

LMF_TOVERLAY_TEXTALWAYSVISIBLE

Enables or disables the option that handle the text visibility when the text rotated outside the view area.. This is valid only if the EnableXYPosition is disabled.

UINT32 (long)

LMF_TOVERLAY_CODEPAGE

Numeric value for the code page setting that determines the text encoding in .SRT subtitle files.