IltmfConvert::SaveStillBitmap

#include "ltmf.h"

C Syntax

HRESULT IltmfConvert_SaveStillBitmap(pConvert, filename, format, quality, flags, timeout)

C++ Syntax

HRESULT SaveStillBitmap(filename, format, quality, flags, timeout)

IltmfConvert *pConvert;

pointer to an interface

BSTR filename;

file name

long format;

format

long quality;

compression quality

long flags;

flags

long timeout;

timeout

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

Parameter

Description

pConvert

Pointer to an IltmfConvert interface.

filename

A character string that contains the name of the file in which to save the bitmap.

format

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

quality

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

flags

Not used. Pass 0.

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

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 method blocks (does not return) until the timeout occurs or the sample is snapped.

Use the IltmfConvert::SaveStillBitmap function to save a snapshot from the running stream to a file, as a bitmap.

If the passed file name to the Filename parameter is NULL, then the function will return an error.

If the passed file name to the Filename parameter currently exists, then the existing file will be overwritten.

Required DLLs and Libraries

LTMF

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64

See Also

Topics:

Media Foundation Function Group

Example

For a C++ example, refer to IltmfConvert::SaveStillBitmap

Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Media Foundation C API Help
Click or drag to resize