Collapse All Expand All

IltmmCapture::SaveStillDIB

#include "ltmm.h"

C Syntax	HRESULT IltmmCapture_SaveStillDIB(pCapture, filename, timeout)
C++ Syntax	HRESULT SaveStillDIB(filename, timeout)

 

IltmmCapture *pCapture;	/* pointer to an interface */
BSTR filename;	/* string */
long timeout;	/* time */

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

Parameter	Description
pCapture	Pointer to an IltmmCapture interface.
filename	A character string containing the name of the file in which to save the DIB.
time	The timeout period in milliseconds. The method will fail if it was not able to take a DIB in the specified time. Use 1 to wait indefinitely until a DIB 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 DIB is snapped.

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 doesn't 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.

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

See Also

Elements:	IltmmCapture::GetStillDIB, IltmmCapture::GetStillPicture, ltmmCapture::put_StillTap, IltmmCapture::get_StillTap
Topics:	Multimedia Function Group

Example

For a C example, refer to IltmmCapture::SaveStillDIB Example for C.

For a C++ example, refer to IltmmCapture::SaveStillDIB Example for C++.