In This Topic ▼

IltmmMultiStreamTarget::WaitForSample

Summary

Wait for a sample from any source to get ready.

Syntax

#include "ltmm.h"

Language	Syntax
C	HRESULT IltmmMultiStreamTarget_WaitForSample(pMultiStreamTarget, lTimeout, Stream);
C++	HRESULT WaitForSample(lTimeout, Stream);

Parameters

IltmmMultiStreamTarget *pMultiStreamTarget

Pointer to an IltmmMultiStreamTarget interface.

long lTimeout

Time-out interval, in milliseconds. The time the function will wait for a sample to be ready. 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.

long *Stream

Pointer to a variable that will receive the stream number for which the sample is indicated as ready. A stream value of 1 indicates an invalid stream.

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

The function must be called in the running state; calling it in the stopped state or after the end of stream is reached will return a wrong state code.

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.

Example

Language	Example
C	• Concatenate two AVI files using IltmmMultiStreamSource and IltmmMultiStreamTarget
	• Replace Audio using IltmmMultiStreamSource and IltmmMultiStreamTarget
C++	• Concatenate two AVI files using IltmmMultiStreamSource and IltmmMultiStreamTarget
	• Replace Audio using IltmmMultiStreamSource and IltmmMultiStreamTarget