IltmmCapture::SaveStillBitmap

#include "ltmm.h"

C Syntax

HRESULT IltmmCapture_SaveStillBitmap(pCapture, filename, format, quality, flags, timeout)

C++ Syntax

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

IltmmCapture *pCapture;

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

pCapture

Pointer to an IltmmCapture interface.

filename

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

format

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

quality

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

The frame is captured from the position indicated by the StillTap property.

When capturing from the still pin, the capture happens when the user presses the hardware button for capturing the still image.

If there is not a hardware button or the user does not press it, the capture occurs after the timeout specified by the TimeOut parameter.

When not capturing from the still pin, the capture occurs after the amount of time specified by the TimeOut parameter.

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:

IltmmCapture::GetStillDIB

IltmmCapture::GetStillPicture

IltmmCapture::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.

Platforms

Win32, x64

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

LEADTOOLS Multimedia C API Help