MontiVision DirectShow SDK Documentation

The IMVImageFileSource interface is used to control the filter's image processing algorithm. Read the filter description to see how the filter is used. Read the remarks for implementation details.

GetBitmap	Returns the currently used bitmap as MV_BITMAP.
PutBitmap	Sets the bitmap as MV_BITMAP.
get_ImageFile	Returns the path to the currently used bitmap as string.
put_ImageFile	Sets the bitmap as string.
get_StreamImage	Returns information about the working mode.
put_StreamImage	Sets the working mode.
get_FrameRate	Returns the current frame rate.
put_FrameRate	Sets the frame rate.

Header file: iMVImageFileSource.h
Interface definition language file: iMVImageFileSource.idl
Typelib: MVImageFileSource
Interface ID: CLSID_MVImageFileSource

HRESULT GetBitmap( [in ] int cMax, [out, size_is(cMax)] byte *pbyBitmap );

Receives the current bitmap as MV_BITMAP.

Parameter:

	cMax	The size of the MV_BITMAP structure.
	pbyBitmap	A pointer to the bitmap structure as MV_BITMAP *.

HRESULT PutBitmap( [in ] int cMax, [in , size_is(cMax)] byte *pbyBitmap );

Sets the current bitmap as MV_BITMAP.

Parameter:

	cMax	The size of the MV_BITMAP structure.
	pbyBitmap	A pointer to the bitmap structure as MV_BITMAP *.

HRESULT get_ImageFile( [out, retval] BSTR *pbstrFileName );

Returns the path to the current image as a string. The following formats are supported by this filter: Bitmap (*.bmp), JPEG (*.jpg), TIFF (*.tif), TTF (*.ttf), ICON (*.ico), JFIF (*.jif), PCD (*.pcd), PCX (*.pcx), PNG (*.png), PBM (*.pbm), PGM (*.pgm), PPM (*.ppm), RAS (*.ras), TARGA (*.tga)

Parameter:

pbstrFileName

A pointer to a COM string that receives the path to the image file.

HRESULT put_ImageFile( [in ] BSTR bstrFileName );

Sets the image location as a string. The following formats are supported by this filter: Bitmap (*.bmp), JPEG (*.jpg), TIFF (*.tif), TTF (*.ttf), ICON (*.ico), JFIF (*.jif), PCD (*.pcd), PCX (*.pcx), PNG (*.png), PBM (*.pbm), PGM (*.pgm), PPM (*.ppm), RAS (*.ras), TARGA (*.tga)

Parameter:

bstrFileName

A string that contains the path to the image file.

HRESULT get_StreamImage( [out, retval] int *piStreamImage );

Returns information about the working mode. If the returned value is TRUE (1), the filter is streaming. This means that the image is sent periodically depending on the specified frame rate. If it is FALSE (0), the image is sent only once.

Parameter:

piStreamImage

Pointer to an integer that receives the working mode as .

HRESULT put_StreamImage ( [in ] int iStreamImage );

Sets the working mode. If the value is TRUE (1), the filter is streaming. This means that the image is sent periodically depending on the specified frame rate. If it is FALSE (0), the image is sent only once.

Parameter:

iStreamImage

Working mode as.

HRESULT get_FrameRate( [out, retval] double *pdFrameRate );

Returns the current frame rate.

Parameter:

pdFrameRate

Pointer to a double variable that receives the frame rate.

HRESULT put_FrameRate ( [in ] double dFrameRate );

Sets the desired frame rate. The frame rate has to be greater than zero and smaller than 100.

Parameter:

dFrameRate

The frame rate as double.

Remarks

The filter supports two ways to handle image files.

Set the image direct using PutBitmap. Therefore the MV_BITMAP structure has to be fully initialized. This method only supports bitmaps.
Set the image indirectly as a file, using put_ImageFile( Filename ). The following formats are supported by this filter: Bitmap (*.bmp), JPEG (*.jpg), TIFF (*.tif), TTF (*.ttf), ICON (*.ico), JFIF (*.jif), PCD (*.pcd), PCX (*.pcx), PNG (*.png), PBM (*.pbm), PGM (*.pgm), PPM (*.ppm), RAS (*.ras), TARGA (*.tga)