Edit

Share via

IDDrawExclModeVideoCallback::OnUpdateColorKey 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 OnUpdateColorKey method informs the application that the color key has changed so that the application can use the new color key to overlay graphics on the video.

Syntax

HRESULT OnUpdateColorKey(
  [out] const COLORKEY *pKey,
  [out] DWORD          dwColor
);

Parameters

[out] pKey

Pointer to a COLORKEY structure that contains the key type and a palette index.

[out] dwColor

Value indicating the 8-bit palette index of the COLORKEY returned in pKey, if the current display mode is 8-bit palettized. Otherwise, it is a value representing the color key in the pixel format of the current display mode.

Return value

Returns an HRESULT value. Possible values include the following.

Return code Description
S_OK
 Success.
E_INVALIDARG
 One of the parameters is invalid.

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

IDDrawExclModeVideoCallback Interface