IAMOverlayFX::SetOverlayFX method (strmif.h)

Article
07/27/2023

[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 SetOverlayFX method applies the specified effects to the overlay surface.

Syntax

HRESULT SetOverlayFX(
  [in] DWORD dwOverlayFX
);

Parameters

[in] dwOverlayFX

Value specifying which effects to apply. The value must be a logical combination of flags from the AMOVERLAYFX enumeration, or the method returns E_INVALIDARG.

Return value

Returns an HRESULT value that depends on the implementation of the interface. The DirectShow implementation may return one of the following values, or others not listed.

Return code	Description
E_FAIL	Failure.
E_INVALIDARG	Invalid argument.
S_OK	Success.

Remarks

The application must call this method while the filter graph is running. The effects are applied immediately.

Requirements

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