Edit

IOverlayNotify::OnColorKeyChange 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 OnColorKeyChange method provides notification that the window's color key has changed.

Syntax

HRESULT OnColorKeyChange(
  [in] const COLORKEY *pColorKey
);

Parameters

[in] pColorKey

Pointer to the new chroma key.

Return value

Returns S_OK if successful. If the method fails, it returns an HRESULT error code.

Requirements

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

See also

Error and Success Codes

IOverlayNotify Interface