IltmfCapture::SaveStillBitmap

Summary

Saves a snapshot from the running stream to a file, as a bitmap.

Syntax

#include "ltmf.h"

Language Syntax
C HRESULT IltmfCapture_SaveStillBitmap(pCapture, filename, format, quality, flags, timeout)
C++ HRESULT SaveStillBitmap(filename, format, quality, flags, timeout)

Parameters

IltmfCapture *pCapture

Pointer to an IltmfCapture interface.

BSTR filename

A character string containing the name of the file in which to save the DIB.

long format

Value that represents the output file format. For a list of possible values, refer to ltmfCapture_StillFormat constants.

long quality

Value that represents the compression quality. This is used only when the Format parameter is ltmfCapture_StillFormat_CMP.

long flags

Not used. Pass 0.

long timeout

The timeout period in milliseconds. The function will fail if it was not able to take a sample in the specified time. Use 1 to wait indefinitely until a sample is snapped.

Returns

Value Meaning
S_OK The function was successful.
<> S_OK An error occurred. Refer to the Error Codes or the HRESULT error codes in the MediaFoundation documentation.

Comments

This function blocks (does not return) until the timeout occurs or the sample is snapped.

The following functions can also be used to obtain still images:

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

For a C++ example, refer to IltmfCapture::SaveStillBitmap Example for C++.

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Media Foundation C API Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.