IltmmMultiStreamTarget::WaitForSample

#include "ltmm.h"

C Syntax

HRESULT IltmmMultiStreamTarget_WaitForSample(pMultiStreamTarget, lTimeout, Stream);

C++ Syntax

HRESULT WaitForSample(lTimeout, Stream);

 

IltmmMultiStreamTarget *pMultiStreamTarget;

/* pointer to an interface */

long lTimeOut;

/* time interval */

long * Stream;

/* pointer to a variable */

Wait for a sample from any source to get ready.

Parameter

Description

pMultiStreamTarget

Pointer to an IltmmMultiStreamTarget interface.

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.

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

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.

See Also

Elements:

IltmmMultiStreamTarget::get_StreamCount, IltmmMultiStreamTarget::put_StreamCount, IltmmMultiStreamTarget::SetAcceptedMediaType, IltmmMultiStreamTarget::GetAcceptedMediaType, IltmmMultiStreamTarget::GetConnectedMediaType, IltmmMultiStreamTarget::GetSample

Topics:

Multimedia Function Group

Example

For a C example, refer to Concatenate two AVI files using IltmmMultiStreamSource and IltmmMultiStreamTarget Example for C.

For a C example, refer to Replace Audio using IltmmMultiStreamSource and IltmmMultiStreamTarget Example for C.

For a C++ example, refer to Concatenate two AVI files using IltmmMultiStreamSource and IltmmMultiStreamTarget Example for C++.

For a C++ example, refer to Replace Audio using IltmmMultiStreamSource and IltmmMultiStreamTarget Example for C++.