LEADTOOLS Multimedia API Help
| LEADTOOLS Multimedia API Help > LEADTOOLS Multimedia Features > Multimedia Function References > IltmmCapture Interface > IltmmCapture::SaveStillBitmap |
#include "ltmm.h"
|
C Syntax |
HRESULT IltmmCapture_SaveStillBitmap(pCapture, Filename, Format, Quality, Flags, Timeout) |
|
C++ Syntax |
HRESULT SaveStillBitmap(Filename, Format, Qualty, 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 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.
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:
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. |
Win32, x64
See Also
|
Elements: |
IltmmCapture::GetStillDIB, IltmmCapture::GetStillPicture, IltmmCapture::SaveStillDIB, IltmmCapture::put_StillTap, IltmmCapture::get_StillTap |
|
Topics: |
Example
For a C example, refer to IltmmCapture::SaveStillBitmap Example for C.
For a C++ example, refer to IltmmCapture::SaveStillBitmap Example for C++.
