Edit

IAMOverlayFX::QueryOverlayFXCaps method (strmif.h)

  • Article

[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 QueryOverlayFXCaps method retrieves information about which overlay effects are available to the Overlay Mixer filter.

Syntax

HRESULT QueryOverlayFXCaps(
  [out] DWORD *lpdwOverlayFXCaps
);

Parameters

[out] lpdwOverlayFXCaps

Pointer to a variable that receives a value indicating the overlay effects capabilities of the overlay surface. The value is a logical combination of flags from the AMOVERLAYFX enumeration.

Return value

Returns an HRESULT value that depends on the implementation of the interface. The DirectShow implementation returns one of the following values.

Return code Description
E_FAIL
 Failure.
E_POINTER
 NULL pointer argument.
S_OK
 Success.

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

See also

Error and Success Codes

IAMOverlayFX Interface