IOverlay::GetColorKey method (strmif.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.]

The GetColorKey method retrieves the current color key used for chroma keying.

Syntax

HRESULT GetColorKey(
  [out] COLORKEY *pColorKey
);

Parameters

[out] pColorKey

Pointer to a variable that receives the current color key for chroma keying.

Return value

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

Remarks

If you change the color key by using the IOverlay::SetColorKey method, all the advise links receive an IOverlayNotify::OnColorKeyChange callback method with the new color.

If no color key is currently being used, this method returns VFW_E_NO_COLOR_KEY_SET.

Requirements

See also

Error and Success Codes

IOverlay Interface