IVMRWindowlessControl::SetColorKey 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 SetColorKey method sets the source color key value that the VMR should use.

Syntax

HRESULT SetColorKey(
  [in] COLORREF Clr
);

Parameters

[in] Clr

Specifies the source color key.

Return value

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

Return code	Description
VFW_E_WRONG_STATE	The VMR is not in windowless mode.

Remarks

Color key control is only meaningful when the VMR is using an overlay surface.

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