IVMRImagePresenter::StopPresenting method (strmif.h)

Article
02/22/2024

[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.]

The StopPresenting method is called just after the video stops playing. The allocator-presenter should perform any necessary cleanup in this method.

Syntax

HRESULT StopPresenting(
  [in] DWORD_PTR dwUserID
);

Parameters

[in] dwUserID

An application-defined DWORD_PTR cookie that uniquely identifies this instance of the VMR for use in scenarios when one instance of the allocator-presenter is used with multiple VMR instances.

Return value

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

StopPresenting can be called only when the VMR is in a running state.

Requirements

Requirement	Value
Minimum supported client	Windows XP with SP1 [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	strmif.h (include Dshow.h)
Library	Strmiids.lib