IltmmCapture::GetStillPicture

#include "ltmm.h"

C Syntax

HRESULT IltmmCapture_GetStillPicture(pCapture, TimeOut, ppPicture)

C++ Syntax

HRESULT GetStillPicture(TimeOut, ppPicture)

IltmmCapture *pCapture;

pointer to an interface

long TimeOut;

time out period

IPictureDisp **ppPicture;

picture object's interface

Retrieves a picture object during a ltmmCapture_Mode_Still capture.

Parameter

Description

pCapture

Pointer to an IltmmCapture interface.

TimeOut

Value containing the maximum time, in milliseconds, to wait for the image.

ppPicture

Pointer to a variable that receives the picture object's interface pointer.

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

If the method succeeds, the caller must free the returned picture by calling the interface Release method.

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.

If TimeOut is INFINITE, the function's time-out interval never elapses.

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.3.12
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Multimedia C API Help