IMultiMediaStream::GetEndOfStreamEventHandle method (mmstream.h)

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

Note  This interface is deprecated. New applications should not use it.

 

The GetEndOfStreamEventHandle method retrieves an event that is signaled when the multimedia stream completes playback.

Syntax

HRESULT GetEndOfStreamEventHandle(
  [out] HANDLE *phEOS
);

Parameters

[out] phEOS

Pointer to a variable that receives a handle to the event. The event is signaled when all of the streams in the multimedia stream object complete playback.

Return value

Returns an HRESULT value. Possible values include the following.

Return code	Description
E_POINTER	NULL pointer argument.
MS_E_BUSY	The multimedia stream is not stopped.
S_OK	Success.

Requirements

Requirement	Value
Target Platform	Windows
Header	mmstream.h

See also

IMultiMediaStream Interface