IltmmSampleTarget::GetSample

Summary

Retrieves a delivered media sample.

Syntax

#include "ltmm.h"

Language Syntax
C HRESULT IltmmSampleTarget_getSample(IltmmSampleTarget* pSampleTarget, long lTimeout, IltmmMediaSampleDisp** ppMediaSample)
C++ HRESULT GetSample(long lTimeout, IltmmMediaSampleDisp** ppMediaSample)

Parameters

IltmmSampleTarget *pSampleTarget

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

long lTimeout

Maximum time to wait for a sample, in milliseconds.

IltmmMediaSampleDisp **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

Value Meaning
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

Platforms

Win32, x64.

See Also

Functions

Topics

Example

Language Example
C Splitting an AVI File into Multiple Bitmaps Using ltmmSampleTarget
C++ Splitting an AVI File into Multiple Bitmaps Using ltmmSampleTarget
Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Multimedia C API Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.