MontiVision DirectShow SDK Documentation

BackgroundColor	Specifies the background colour for the drawn text..
Bold	Specifies whether the text is drawn bold.
Enable	Enables or disables the text overlay.
FontSize	Font height.
FontTypeFace	Font typeface.
ForegroundColor	Text colour.
OverlayMode	The filters overlay mode.
PositionMode	The filters position mode, absolute or relative.
RelativePosition	Relative text position.
Shadow	Enables or disables shadow for the drawn text.
ShadowColor	Shadow colour.
ShadowOffset	Offset used to draw the text shadow.
Text	Specifies the text to draw.
TransparentBack	Specifies whether a transparent background is used for drawing.
xMargin	Horizontal margin width.
XPosition	Horizontal text position.
yMargin	Vertical margin height.
YPosition	Vertical text position.

Header file: IMVTextOverlay.h
Interface definition language file: IMVTextOverlay.idl
Typelib: MVTextOverlay
Interface ID: IID_IMVTextOverlay

Property IMVTextOverlay::BackgroundColor

Declaration: Property Get/Put BackgroundColor As Long
Specifies the background colour for the drawn text..
Prototype:
HRESULT put_BackgroundColor(OLE_COLOR Color);
HRESULT get_BackgroundColor(OLE_COLOR* Color);

Property IMVTextOverlay::Bold

Declaration: Property Get/Put Bold As Boolean
Specifies whether the text is drawn bold.
Prototype:
HRESULT put_Bold(BOOL Enable);
HRESULT get_Bold(BOOL* Enable);

Property IMVTextOverlay::Enable

Declaration: Property Get/Put Enable As Boolean
Enables or disables the text overlay.
Prototype:
HRESULT put_Enable(BOOL Enable);
HRESULT get_Enable(BOOL* Enable);

Property IMVTextOverlay::FontSize

Declaration: Property Get/Put FontSize As Long
Font height.
Prototype:
HRESULT put_FontSize(int Size);
HRESULT get_FontSize(int* Size);

Property IMVTextOverlay::FontTypeFace

Declaration: Property Get/Put FontTypeFace As String
Font typeface.
Prototype:
HRESULT put_FontTypeFace(BSTR Type);
HRESULT get_FontTypeFace(BSTR* Type);

Property IMVTextOverlay::ForegroundColor

Declaration: Property Get/Put ForegroundColor As Long
Text colour.
Prototype:
HRESULT put_ForegroundColor(OLE_COLOR Color);
HRESULT get_ForegroundColor(OLE_COLOR* Color);

Property IMVTextOverlay::OverlayMode

Declaration: Property Get/Put OverlayMode As Long
The filters overlay mode as MV_TEXT_OVERLAY_MODE.
typedef enum _MV_TEXT_OVERLAY_MODE 

{ 

    MV_TEXT_OVERLAY_MODE_TEXT, 

    MV_TEXT_OVERLAY_MODE_DATE, 

}MV_TEXT_OVERLAY_MODE; 
Prototype:
HRESULT put_OverlayMode(int Mode);
HRESULT get_OverlayMode(int* Mode);

Property IMVTextOverlay::PositionMode

Declaration: Property Get/Put PositionMode As Long
The filters position mode as MV_POSITION_MODE.
typedef enum _MV_POSITION_MODE 

{ 

    MV_POSITION_RELATIVE, 

    MV_POSITION_ABSOLUTE, 

}MV_POSITION_MODE; 
Prototype:
HRESULT put_PositionMode(int Mode);
HRESULT get_PositionMode(int* Mode);

Property IMVTextOverlay::RelativePosition

Declaration: Property Get/Put RelativePosition As Long
Relative text position as MV_RELATIVE_POSITION.
typedef enum _MV_RELATIVE_POSITION 

{ 

    MV_POSITION_UPPER_LEFT, 

    MV_POSITION_UPPER_RIGHT, 

    MV_POSITION_LOWER_RIGHT, 

    MV_POSITION_LOWER_LEFT 

}MV_RELATIVE_POSITION; 
Prototype:

HRESULT put_RelativePosition(int Position);
HRESULT get_RelativePosition(int* Position);

Property IMVTextOverlay::Shadow

Declaration: Property Get/Put Shadow As Boolean
Enables or disables shadow for the drawn text.
Prototype:
HRESULT put_Shadow(BOOL Enable);
HRESULT get_Shadow(BOOL* Enable);

Property IMVTextOverlay::ShadowColor

Declaration: Property Get/Put ShadowColor As Long
Shadow colour.
Prototype:
HRESULT put_ShadowColor(OLE_COLOR Color);
HRESULT get_ShadowColor(OLE_COLOR* Color);

Property IMVTextOverlay::ShadowOffset

Declaration: Property Get/Put ShadowOffset As Long
Offset used to draw the text shadow.
Prototype:
HRESULT put_ShadowOffset(int Offset);
HRESULT get_ShadowOffset(int* Offset);

Property IMVTextOverlay::Text

Declaration: Property Get/Put Text As String
Specifies the text to draw. The placeholder _DATE_TIME_ was replaced by the current time/date text.

Placeholder Content

_DATE_TIME_ Current date and time

_DATE_ Current date

_TIME_ Current time

Prototype:
HRESULT put_Text(BSTR Text);
HRESULT get_Text(BSTR* Text);

Property IMVTextOverlay::TransparentBack

Declaration: Property Get/Put TransparentBack As Boolean
Specifies whether a transparent background is used for drawing.
Prototype:
HRESULT put_TransparentBack(BOOLEAN Enable);
HRESULT get_TransparentBack(BOOLEAN* Enable);

Property IMVTextOverlay::xMargin

Declaration: Property Get/Put xMargin As Long
Horizontal margin width.
Prototype:
HRESULT put_xMargin(int Width);
HRESULT get_xMargin(LONG* Width);

Property IMVTextOverlay::XPosition

Declaration: Property Get/Put XPosition As Long
Horizontal text position.
Prototype:
HRESULT put_XPosition(int Position);
HRESULT get_XPosition(int* Position);

Property IMVTextOverlay::yMargin

Declaration: Property Get/Put yMargin As Long
Vertical margin height.
Prototype:
HRESULT put_yMargin(int Height);
HRESULT get_yMargin(int* Height);

Property IMVTextOverlay::YPosition

Declaration: Property Get/Put YPosition As Long
Vertical text position.
Prototype:
HRESULT put_YPosition(int Position);
HRESULT get_YPosition(int* Position);