IMVImageCapture

The IMVImageCapture interface is used to control the file storing properties of the MV Image Grabber and MV Image Renderer filters. Read the filter descriptions of the MV Image Renderer and MV Image Grabber  to see how the filters are used.

Header file: iMVImageCapture.h
Interface definition language file: iMVImageCapture.idl
Interface ID: IID_IMVImageCapture

HRESULT get_NameCreationMethod( [out, retval] int *piMethod );

Retrieves the output file name creation method as MV_NAMECREATION. If the name creation method is MV_NAMECRATION_FIXED, the method put_FixedFileName() is used to set the filename. If the name creation method is MV_NAMECREATION_TEMPLATE, the method put_OutputFileTemplate() is used to set a template that is used by the filter to create the filename. Read the filter descriptions of the MV Image Renderer and MV Image Grabber  to see how templates are used.

Parameter:

HRESULT put_NameCreationMethod( [in ] int iMethod );

Sets the output file name creation method as MV_NAMECREATION. If the name creation method is MV_NAMECRATION_FIXED, the method put_FixedFileName() is used to set the filename. If the name creation method is MV_NAMECREATION_TEMPLATE, the method put_OutputFileTemplate() is used to set a template that is used by the filter to create the filename. Read the filter descriptions of the MV Image Renderer and MV Image Grabber to see how templates are used.

Parameter:

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

Retrieves the current fixed file name used by the filter as a COM string. The fixed filename is used to create the output filenames when no template is set (see put_NameCreationMethod()). An image number is appended to the filename, and is autmatically incremented (e.g. MyFileName000001). To reset the image counter, use ResetImageCounter().

Parameter:

HRESULT put_FixedFileName( [in ] BSTR bstrFileName );

Sets the current fixed file name. The fixed filename is used to create the output filenames when no template is set (see put_NameCreationMethod()). An image number is appended to the filename, and is autmatically incremented (e.g. MyFileName000001). To reset the image counter, use ResetImageCounter().

Parameter:

HRESULT get_OutputPath( [out, retval] BSTR *pbstrPath );

Retrieves the output location path as a COM string.

Parameter:

HRESULT put_OutputPath( [in ] BSTR bstrPath );

Sets the output location path as a COM string.

Parameter:

HRESULT get_OutputFileTemplate( [out, retval] BSTR *pbstrPath );

Retrieves the path to the name creation template file as a COM string.

Parameter:

HRESULT put_OutputFileTemplate( [in ] BSTR bstrPath );

Sets the path to the name creation template as COM string.

Parameter:

HRESULT get_FileFormat( [out, retval] int *piFormat );

Returns the currently used output file format as MV_FILEFORMAT_TYPE.

Parameter:

HRESULT put_FileFormat( [in ] int iFormat );

Sets the output file format type as MV_FILEFORMAT_TYPE.

Parameter:

HRESULT ResetImageCounter();

Resets the image counter to zero.

Filter specific structures and enumerators

typedef enum _MV_FILEFORMAT_TYPE
{
    MV_FILEFORMAT_BITMAP=0,
    MV_FILEFORMAT_JPEG,
    MV_FILEFORMAT_TIFF,
    MV_FILEFORMAT_PNG,
    MV_FILEFORMAT_TARGA
} MV_FILEFORMAT_TYPE;

typedef enum _MV_NAMECREATION
{
    MV_NAMECRATION_FIXED=0,
    MV_NAMECREATION_TEMPLATE
} MV_NAMECREATION;

Remarks

The filter supports two ways to handle image files.