ICCompressBegin

The ICCompressBegin macro notifies a video compression driver to prepare to compress data. You can use this macro or explicitly call the ICM_COMPRESS_BEGIN message.

DWORD ICCompressBegin(
 hic,         lpbiInput,   lpbiOutput  );

Parameters

hic

Handle to a compressor.

lpbiInput

Pointer to a BITMAPINFO structure containing the input format.

lpbiOutput

Pointer to a BITMAPINFO structure containing the output format.

Return Values

Returns ICERR_OK if the specified compression is supported or ICERR_BADFORMAT if the input or output format is not supported.

Remarks

The driver should allocate and initialize any tables or memory that it needs for compressing the data formats when it receives the ICM_COMPRESS message.

VCM saves the settings of the most recent ICCompressBegin macro. The ICCompressBegin and ICCompressEnd messages do not nest. If your driver receives ICM_COMPRESS_BEGIN before compression is stopped with ICM_COMPRESS_END, it should restart compression with new parameters.

Requirements

**  Windows NT/2000/XP:** Included in Windows NT 3.1 and later.
**  Windows 95/98/Me:** Included in Windows 95 and later.
**  Header:** Declared in Vfw.h.

See Also

Video Compression Manager, Video Compression Macros, BITMAPINFO, ICCompressEnd, ICM_COMPRESS_BEGIN