Retrieves a sample buffer from a stream.


#include "ltmm.h"

Language Syntax
C HRESULT IltmmMultiStreamSource_getSampleBuffer( pMultiStreamSource, Stream, TimeOut, MediaSample)
C++ HRESULT GetSampleBuffer(Stream, TimeOut, MediaSample);


IltmmMultiStreamSource *pMultiStreamSource

Pointer to an IltmmMultiStreamSource interface that references the sample source object that is getting the sample buffer.

long Stream

The stream index (0-based) that indicates the stream for which we get the sample buffer.

long TimeOut

Maximum time to wait for a free sample buffer, in milliseconds. If TimeOut is -1, the function's time-out interval never elapses.

IltmmMediaSampleDisp **MediaSample

Pointer to a variable to be updated with a pointer to an IltmmMediaSampleDisp interface. This interface references the new media sample buffer.


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.


The buffer retrieved by this function comes from a pool of buffers. There should be no assumptions made on the number of available buffers. If you get a buffer, fill it with data, deliver it downstream with IltmmMultiStreamSource::DeliverSample, and release the buffer before getting another. This is because there may be only one buffer available at a time.

If the Function succeeds, the caller must free the interface referenced by the MediaSample parameter by calling the interface's Release Function. Failure to release the buffer could cause further calls to IltmmMultiStreamSource::GetSampleBuffer to fail.

If the function does not retrieve a buffer within the allotted time it will return E_FAIL. If this happens, you may have specified a small timeout and all the available buffers are currently being sent downstream.

Required DLLs and Libraries


Win32, x64.

See Also




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.