LEAD Video Text Overlay Transform Attributes

The following attributes are supported by the LEAD Video Text Overlay Transform through the IMFAttributes interface.

Data type

Attribute CLSID

Description

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_TEXTOVERLAY

Sets or gets the text to be overlaid over the video stream . The string can be wrapped by setting the WordWrap property to VARIANT_TRUE. The transform accepts the new line sequence \n and translates it to a new line.

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_FONTSIZE

Sets or gets the font size. Possible values range from 1 to 2000. For any value below the lower limit the default value of 10 will be used. For any value beyond the upper limit, the maximum value of 2000 will be used.

UINT32 (long)

LMF_TOVERLAY_FONTCOLOR

Sets or gets the font foreground color.

UINT32 (long)

LMF_TOVERLAY_BKFONTCOLOR

Sets or gets the font background color.

UINT32 (BOOL)

LMF_TOVERLAY_BOLD

Enables or disables the bold font style.

UINT32 (BOOL)

LMF_TOVERLAY_ITALIC

Enables or disables the italic font style.

UINT32 (BOOL)

LMF_TOVERLAY_UNDERLINE

Enables or disables the underline font style.

UINT32 (BOOL)

LMF_TOVERLAY_STRIKEOUT

Enables or disables the strike out font effect.

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 (BOOL)

LMF_TOVERLAY_ENABLEXYPOSITIONS

Enables or disables text positioning. If this is set to VARIANT_TRUE, then the TextAlignment property will have no effect.

UINT32 (long)

LMF_TOVERLAY_XPOS

Sets or gets the text X position.

UINT32 (long)

LMF_TOVERLAY_YPOS

Sets or gets the text Y 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.

BSTR

LMF_TOVERLAY_TEXTFILENAME

Sets or gets the LEADTOOLS XML file name that contains the overlay text with special tags.

See the Text Overlay XML File Format for more information on valid tags and how to use them.

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 (BOOL)

LMF_TOVERLAY_ENABLEOUTLINE

Enables or disables the text outline option.

UINT32 (long)

LMF_TOVERLAY_OUTLINEWIDTH

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

UINT32 (long)

LMF_TOVERLAY_OUTLINECOLOR

Sets or gets the outline pen color. This is a COLORREF value. You can use the RGB macro to form a COLORREF value from an RGB triple.

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 (BOOL)

LMF_TOVERLAY_OUTLINETRANSPARENT

Enables or disables the text outline transparency option. If this is set to VARIANT_TRUE, the area inside the text outline becomes transparent.

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 (BrushStyleConstants)

LMF_TOVERLAY_BRUSHSTYLE

Sets or gets the outline text brush style. The brush is applied to the text body. Possible values are:

BRUSHS_NULL,
BRUSHS_SOLID,
BRUSHS_HORIZONTAL,
BRUSHS_VERTICAL,
BRUSHS_FDIAGONAL,
BRUSHS_BDIAGONAL,
BRUSHS_CROSS, or
BRUSHS_DIAGCROSS.

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_TEXTREPEATING

Enables or disables the text repeating option. It will cause the text sequence to repeat infinitely. This is valid and has effect only if the EnableTextFromFile property is true.

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 (BOOL)

LMF_TOVERLAY_ENABLEOPACITY

Enables or disables the opacity option.

UINT32 (long)

LMF_TOVERLAY_OPACITY

Sets or gets the desired opacity percentage.

UINT32 (BOOL)

LMF_TOVERLAY_VIEWBACKGROUND

Enables or disables viewing the text background.

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_VIEWRIGHT

Sets or gets the right 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 the video stream width.

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 (long)

LMF_TOVERLAY_VIEWBOTTOM

Sets or gets the bottom (lower) 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 the video stream height.

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 (RotationCenterConstants)

LMF_TOVERLAY_ROTATIONCENTER

Determines the text rotation center. Possible values are:

ROTATIONCENTER_LEFT_TOP

ROTATIONCENTER_RIGHT_TOP

ROTATIONCENTER_CENTER

ROTATIONCENTER_AUTO

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 (BOOL)

LMF_TOVERLAY_IGNOREHTMLTAGS

Ignores the HTML tags from the subtitle file.

UINT32 (long)

 

LMF_TOVERLAY_CODEPAGE

 

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

 

For more information on how to use the Transform Attributes, refer to Using Media Foundation Transform Attributes.

Help Version 19.0.2017.10.18
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Transforms C API Help