IltmmSampleTarget::GetSample

#include "ltmm.h"

C Syntax

HRESULT IltmmSampleTarget_getSample(IltmmSampleTarget* pSampleTarget, long lTimeout, IltmmMediaSampleDisp** ppMediaSample)

C++ Syntax

HRESULT GetSample(long lTimeout, IltmmMediaSampleDisp** ppMediaSample)

IltmmSampleTarget * pSampleTarget;

pointer to an interface

long lTimeout;

time allowed to wait for sample

IltmmMediaSampleDisp ** ppMediaSample;

pointer to a pointer

Retrieves a delivered media sample.

Parameter

Description

pSampleTarget

Pointer to an IltmmSampleTarget interface that references the sample target object for which to get the media sample.

lTimeout

Maximum time to wait for a sample, in milliseconds.

ppMediaSample

Pointer to a variable that is updated with an IltmmMediaSampleDisp pointer. The IltmmMediaSampleDisp interface referenced by this pointer contains information on the media sample delivered to the sample target.

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 function succeeds, the caller must free the interface referenced by the MediaSample parameter by calling the interface's Release function.

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