IltmfPlay::SaveStillBitmap

Summary

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

Syntax

#include "ltmf.h"

Parameters

IltmfPlay *pPlay

Pointer to an IltmfPlay interface.

BSTR filename

Character string containing the name of the file in which to save the bitmap.

long format

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

long quality

Value that represents the compression quality. This is used only when the Format parameter is ltmfPlay_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

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:

• IltmfPlay::GetStillHDIB
• IltmfPlay::GetStillPicture
• IltmfPlay::SaveStillDIB

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

Functions

• IltmfPlay::GetStillHDIB
• IltmfPlay::GetStillPicture
• IltmfPlay::SaveStillDIB

Topics

• Media Foundation Function Group

Example

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