In This Topic ▼

IltmmSampleSource::DeliverEndOfStream

Summary

Informs the objects "downstream" of the sample source object that the source has reached the end of the data stream.

Syntax

#include "ltmm.h"

Language	Syntax
C	HRESULT IltmmSampleSource_DeliverEndOfStream(pSampleSource, TimeOut)
C++	HRESULT DeliverEndOfStream(TimeOut)

Parameters

IltmmSampleSource *pSampleSource

Pointer to an IltmmSampleSource interface that references the sample source object.

long TimeOut

Maximum time to allow for end of stream notification, in milliseconds.

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

In some cases (for example when writing AVI files), stopping the object without calling this function might indicate a stop caused by an error. Such a stop can have unpredictable results (the AVI might not get indexed properly). It is recommended you call this function before stopping the object.

Most time-out situations are the result of an error condition. The error returned for a timeout condition is E_ABORT. If you receive an E_ABORT error code and your timeout was set sufficiently high, then a problem has occurred downstream. In this case you should call the main object's "Stop" function and report an error.