IltmmMultiStreamTarget::GetSample

#include "ltmm.h"

C Syntax	HRESULT IltmmMultiStreamTarget_GetSample(pMultiStreamTarget, Stream, lTimeOut, ppMediaSample);
C++ Syntax	HRESULT GetSample(Stream, lTimeOut, ppMediaSample);

IltmmMultiStreamTarget *pMultiStreamTarget;	/* pointer to an interface */
long Stream;	/* stream index */
long lTimeOut;	/* time interval */
IltmmMediaSampleDisp ** ppMediaSample;	/* pointer to a variable */

Retrieves a media sample from a stream.

Parameter	Description
pMultiStreamTarget	Pointer to an IltmmMultiStreamTarget interface.
Stream	The stream number from which to get the sample.
lTimeOut	Time-out interval, in milliseconds. The time the function will wait for a sample. If the time elapses and no sample is ready, the function will return a time-out error code. If lTimeOut is -1, the function's time-out interval never elapses.
ppMediaSample	Pointer to a variable that will receive a pointer to an IltmmMediaSampleDisp interface.

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 returned interface by calling it'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.

See Also

Elements:	IltmmMultiStreamTarget::get_StreamCount, IltmmMultiStreamTarget::put_StreamCount, IltmmMultiStreamTarget::SetAcceptedMediaType, IltmmMultiStreamTarget::GetAcceptedMediaType, IltmmMultiStreamTarget::GetConnectedMediaType, IltmmMultiStreamTarget::WaitForSample
Topics:	Multimedia Function Group

Example