MontiVision DirectShow SDK Documentation

BackgroundColor	Background colour.
Bold	Use bold text.
Direction	Ticker Direction.
Enable	Enable text overlay.
FontSize	Font height.
FontTypeFace	Font typeface.
ForegroundColor	Foreground colour.
IOPinSeparator	The separator used to split up the text received on the I/O Text Input Pin into substrings.
NumOfOverlays	The number of overlays to use (1 to 10).
OverlayMode	Overlay mode.
PositionMode	Position mode, absolute or relative.
RelativePosition	Relative position.
SelectedOverlay	The currently selected overlay (0 to 9).
Shadow	Enable text shadow.
ShadowColor	Shadow colour.
ShadowOffset	Shadow offset.
Speed	Ticker Speed.
StaticLeft	Static Left Text.
StaticRight	Static Right Text.
Text	The Text to overlay.
TickerWidth	Ticker Width.
TransparentBack	Use transparant background.
xMargin	Horizontal margin width.
XPosition	Horizontal position.
yMargin	Vertical margin height.
YPosition	Vertical position.

Header file: IMVTickerOverlay.h
Interface definition language file: IMVTickerOverlay.idl
Typelib: MVTickerOverlay
Interface ID: IID_IMVTickerOverlay

Property IMVTickerOverlay::BackgroundColor

Declaration: Property Get/Put BackgroundColor As Long
Background colour.
C Prototype:
HRESULT put_BackgroundColor(LONG newVal);
HRESULT get_BackgroundColor(LONG *pVal);

Property IMVTickerOverlay::Bold

Declaration: Property Get/Put Bold As Boolean
Use bold text.

C Prototype:

HRESULT put_Bold(VARIANT_BOOL newVal);
HRESULT get_Bold(VARIANT_BOOL *pVal);

Property IMVTickerOverlay::Direction

Declaration: Property Get/Put Direction As Long
Ticker Direction.

Direction
Value
Description

MV_DIRECTION_RIGHTTOLEFT
0
The text moves from right to left.

MV_DIRECTION_LEFTTORIGHT
1
The text moves from left to right.

C Prototype:
HRESULT put_Direction(LONG newVal);
HRESULT get_Direction(LONG *pVal);

Property IMVTickerOverlay::Enable

Declaration: Property Get/Put Enable As Boolean
Enable text overlay.
C Prototype:
HRESULT put_Enable(VARIANT_BOOL newVal);
HRESULT get_Enable(VARIANT_BOOL *pVal);

Property IMVTickerOverlay::FontSize

Declaration: Property Get/Put FontSize As Long
Font height.
C Prototype:
HRESULT put_FontSize(LONG newVal);
HRESULT get_FontSize(LONG *pVal);

Property IMVTickerOverlay::FontTypeFace

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

Property IMVTickerOverlay::ForegroundColor

Declaration: Property Get/Put ForegroundColor As Long
Foreground colour.
C Prototype:
HRESULT put_ForegroundColor(LONG newVal);
HRESULT get_ForegroundColor(LONG *pVal);

Property IMVTickerOverlay::IOPinSeparator

Declaration: Property Get/Put IOPinSeparator As String
The separator used to split up the text received on the I/O Text Input Pin into substrings.
C Prototype:
HRESULT put_IOPinSeparator(BSTR newVal);
HRESULT get_IOPinSeparator(BSTR *pVal);

Property IMVTickerOverlay::NumOfOverlays

Declaration: Property Get/Put NumOfOverlays As Long
The number of overlays to use (1 to 10).
C Prototype:
HRESULT put_NumOfOverlays(LONG newVal);
HRESULT get_NumOfOverlays(LONG *pVal);

Property IMVTickerOverlay::OverlayMode

Declaration: Property Get/Put OverlayMode As Long
Overlay mode.

Mode

Value
Description

MV_TEXT_OVERLAY_MODE_TEXT
0
Use the Text property value as ticker text.

MV_TEXT_OVERLAY_MODE_DATE
1
Use the current date and time as ticker text.

C Prototype:
HRESULT put_OverlayMode(LONG newVal);
HRESULT get_OverlayMode(LONG *pVal);

Property IMVTickerOverlay::PositionMode

Declaration: Property Get/Put PositionMode As Long
Position mode, absolute or relative.

Mode
Value
Description

MV_POSITION_RELATIVE
0
The ticker text position is relative to the video image. Use the RelativePosition property to set the position.

MV_POSITION_ABSOLUTE
1
The ticker text has an absolute position within the video stream. Use the XPosition and YPosition properties to set the absolute position.

C Prototype:
HRESULT put_PositionMode(LONG newVal);
HRESULT get_PositionMode(LONG *pVal);

Property IMVTickerOverlay::RelativePosition

Declaration: Property Get/Put RelativePosition As Long
Relative position.

Position
Value
Description

MV_POSITION_TOP
4
The position of tthe ticker is on the top of the video images.

MV_POSITION_BOTTOM
5
The position of tthe ticker is on the bottom of the video images.

C Prototype:
HRESULT put_RelativePosition(LONG newVal);
HRESULT get_RelativePosition(LONG *pVal);

Property IMVTickerOverlay::SelectedOverlay

Declaration: Property Get/Put SelectedOverlay As Long
The currently selected overlay (0 to 9).
C Prototype:
HRESULT put_SelectedOverlay(LONG newVal);
HRESULT get_SelectedOverlay(LONG *pVal);

Property IMVTickerOverlay::Shadow

Declaration: Property Get/Put Shadow As Boolean
Enable text shadow.
C Prototype:
HRESULT put_Shadow(VARIANT_BOOL newVal);
HRESULT get_Shadow(VARIANT_BOOL *pVal);

Property IMVTickerOverlay::ShadowColor

Declaration: Property Get/Put ShadowColor As Long
Shadow colour.
C Prototype:
HRESULT put_ShadowColor(LONG newVal);
HRESULT get_ShadowColor(LONG *pVal);

Property IMVTickerOverlay::ShadowOffset

Declaration: Property Get/Put ShadowOffset As Long
Shadow offset.
C Prototype:
HRESULT put_ShadowOffset(LONG newVal);
HRESULT get_ShadowOffset(LONG *pVal);

Property IMVTickerOverlay::Speed

Declaration: Property Get/Put Speed As Long
Ticker Speed in Pixel/sec..
C Prototype:
HRESULT put_Speed(LONG newVal);
HRESULT get_Speed(LONG *pVal);

Property IMVTickerOverlay::StaticLeft

Declaration: Property Get/Put StaticLeft As String
Static text displayed left of the ticker text.
C Prototype:
HRESULT put_StaticLeft(BSTR newVal);
HRESULT get_StaticLeft(BSTR *pVal);

Property IMVTickerOverlay::StaticRight

Declaration: Property Get/Put StaticRight As String
Static text displayed right of the ticker text.
C Prototype:
HRESULT put_StaticRight(BSTR newVal);
HRESULT get_StaticRight(BSTR *pVal);

Property IMVTickerOverlay::Text

Declaration: Property Get/Put Text As String
The Text to overlay.
C Prototype:
HRESULT put_Text(BSTR newVal);
HRESULT get_Text(BSTR *pVal);

Property IMVTickerOverlay::TickerWidth

Declaration: Property Get/Put TickerWidth As Long
Width of the ticker text and the static texts.
C Prototype:
HRESULT put_TickerWidth(LONG newVal);
HRESULT get_TickerWidth(LONG *pVal);

Property IMVTickerOverlay::TransparentBack

Declaration: Property Get/Put TransparentBack As Boolean
Use transparant background.
C Prototype:
HRESULT put_TransparentBack(VARIANT_BOOL newVal);
HRESULT get_TransparentBack(VARIANT_BOOL *pVal);

Property IMVTickerOverlay::xMargin

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

Property IMVTickerOverlay::XPosition

Declaration: Property Get/Put XPosition As Long
Horizontal position.
C Prototype:
HRESULT put_XPosition(LONG newVal);
HRESULT get_XPosition(LONG *pVal);

Property IMVTickerOverlay::yMargin

Declaration: Property Get/Put yMargin As Long
Vertical margin height.
C Prototype:
HRESULT put_yMargin(LONG newVal);
HRESULT get_yMargin(LONG *pVal);

Property IMVTickerOverlay::YPosition

Declaration: Property Get/Put YPosition As Long
Vertical position.
C Prototype:
HRESULT put_YPosition(LONG newVal);
HRESULT get_YPosition(LONG *pVal);