IMVBitmapOverlay 

The IMVBitmapOverlay interface contains methods and properties to configure the MV Bitmap Overlay filter.

Methods:

AspectRatio Aspect ratio.
BitmapPath Overlay bitmap path.
Enabled Enable bitmap overlay.
InputAlpha Alpha value for video.
Mode Mode: alpha blending or transparency.
OriginalHeight Overlay bitmap original height.
OriginalWidth Overlay bitmap original width.
PositionMode Position mode, absolute or relative.
RelativePosition Relative position.
ResizeEnabled Enable resizing.
ResizeHeight Overlay bitmap resized height.
ResizeWidth Overlay bitmap resized width.
TransparentColour Transparent colour.
XPosition Horizontal position.
YPosition Vertical position.

Header file: IMVBitmapOverlay.h
Interface definition language file: IMVBitmapOverlay.idl
Typelib: MVBitmapOverlay
Interface ID: IID_IMVBitmapOverlay


Property IMVBitmapOverlay::AspectRatio

Declaration: Property Get/Put AspectRatio As Boolean

Aspect ratio.

C Prototype:

HRESULT put_AspectRatio(VARIANT_BOOL newVal);
HRESULT get_AspectRatio(VARIANT_BOOL *pVal);


Property IMVBitmapOverlay::BitmapPath

Declaration: Property Get/Put BitmapPath As String

Overlay bitmap path.

C Prototype:HRESULT put_BitmapPath(BSTR newVal);
HRESULT get_BitmapPath(BSTR *pVal);

Property IMVBitmapOverlay::Enabled

Declaration: Property Get/Put Enabled As Boolean

Enable bitmap overlay.

C Prototype:

HRESULT put_Enabled(VARIANT_BOOL newVal);
HRESULT get_Enabled(VARIANT_BOOL *pVal);


Property IMVBitmapOverlay::InputAlpha

Declaration: Property Get/Put InputAlpha As Long

Alpha value for video. Range from 0 (full overlay) to 255 (no overlay).

C Prototype:

HRESULT put_InputAlpha(LONG newVal);
HRESULT get_InputAlpha(LONG *pVal);

Property IMVBitmapOverlay::Mode

Declaration: Property Get/Put Mode As Long

Mode: alpha blending, transparency or both of them.

Mode

Value

Description
MV_GDI_OVERLAY_TRANSPARENT

0

The all pixel from the bitmap with TransparentColour property color are transparent. They shows the underlying video stream.
MV_GDI_OVERLAY_CONSTANTALPHA

1

The video stream and the overlay bitmap was added with an alpa value.
MV_GDI_OVERLAY_TRANSPARENT_AND_CONSTANTALPHA

2

Both overlay modes was applied to the video stream, first MV_GDI_OVERLAY_TRANSPARENT and then MV_GDI_OVERLAY_CONSTANTALPHA.
MV_GDI_OVERLAY_USE_ALPHA_CHANNEL

3

Use the alpha channel from the overlay image if available or use an alpha channel bitmap from the IMVBitmapOverlay2::AlphaBitmapPath property.
C Prototype:

HRESULT put_Mode(LONG newVal);
HRESULT get_Mode(LONG *pVal);


Property IMVBitmapOverlay::OriginalHeight

Declaration: Property Get OriginalHeight As Long

Overlay bitmap original height.

C Prototype:

HRESULT put_OriginalHeight(LONG newVal);
HRESULT get_OriginalHeight(LONG *pVal);


Property IMVBitmapOverlay::OriginalWidth

Declaration: Property Get OriginalWidth As Long

Overlay bitmap original width.

C Prototype:

HRESULT put_OriginalWidth(LONG newVal);
HRESULT get_OriginalWidth(LONG *pVal);


Property IMVBitmapOverlay::PositionMode

Declaration: Property Get/Put PositionMode As Long

Position mode, absolute or relative.

C Prototype:

HRESULT put_PositionMode(LONG newVal);
HRESULT get_PositionMode(LONG *pVal);


Property IMVBitmapOverlay::RelativePosition

Declaration: Property Get/Put RelativePosition As Long

Relative position.

C Prototype:

HRESULT put_RelativePosition(LONG newVal);
HRESULT get_RelativePosition(LONG *pVal);


Property IMVBitmapOverlay::ResizeEnabled

Declaration: Property Get/Put ResizeEnabled As Boolean

Enable resizing.

C Prototype:

HRESULT put_ResizeEnabled(VARIANT_BOOL newVal);
HRESULT get_ResizeEnabled(VARIANT_BOOL *pVal);


Property IMVBitmapOverlay::ResizeHeight

Declaration: Property Get/Put ResizeHeight As Long

Overlay bitmap resized height.

C Prototype:

HRESULT put_ResizeHeight(LONG newVal);
HRESULT get_ResizeHeight(LONG *pVal);


Property IMVBitmapOverlay::ResizeWidth

Declaration: Property Get/Put ResizeWidth As Long

Overlay bitmap resized width.

C Prototype:

HRESULT put_ResizeWidth(LONG newVal);
HRESULT get_ResizeWidth(LONG *pVal);


Property IMVBitmapOverlay::TransparentColour

Declaration: Property Get/Put TransparentColour As Long

Transparent colour.

C Prototype:

HRESULT put_TransparentColour(LONG newVal);
HRESULT get_TransparentColour(LONG *pVal);


Property IMVBitmapOverlay::XPosition

Declaration: Property Get/Put XPosition As Long

Horizontal position.

C Prototype:

HRESULT put_XPosition(LONG newVal);
HRESULT get_XPosition(LONG *pVal);


Property IMVBitmapOverlay::YPosition

Declaration: Property Get/Put YPosition As Long

Vertical position.

C Prototype:

HRESULT put_YPosition(LONG newVal);
HRESULT get_YPosition(LONG *pVal);