IltmmPlay::SaveStillBitmap

#include "ltmm.h"

C Syntax

HRESULT IltmmPlay_SaveStillBitmap(pPlay, Filename, Format, Quality, Flags, Timeout)

C++ Syntax

HRESULT SaveStillBitmap(Filename, Format, Qualty, Flags, Timeout)

 

IltmmPlay *pPlay;

/* 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

pPlay

Pointer to an IltmmPlay interface.

Filename

Character string containing 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 ltmmPlay_StillFormat Constants.

Quality

Value that represents the compression quality. This is used only when the Format parameter is ltmmPlay_StillFormat_CMP. For a list of possible values, refer to Compression Quality Factors.

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 DirectShow documentation.

Comments

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

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

IltmmPlay::GetStillDIB

IltmmPlay::GetStillPicture

IltmmPlay::SaveStillDIB

Required DLLs and Libraries

LTMM

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

See Also

Elements:

IltmmPlay::GetStillDIB, IltmmPlay::GetStillPicture, IltmmPlay::SaveStillDIB

Topics:

Multimedia Function Group

Example

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

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