IltmmSampleSource::DeliverEndOfStream

#include "ltmm.h"

C Syntax

HRESULT IltmmSampleSource_DeliverEndOfStream(pSampleSource, TimeOut)

C++ Syntax

HRESULT DeliverEndOfStream(TimeOut)

IltmmSampleSource *pSampleSource;

pointer to an interface

long TimeOut;

time allowed for notification

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

Parameter

Description

pSampleSource

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

TimeOut

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

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

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.

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

Help Version 20.0.2019.3.12
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Multimedia C API Help