IMSVidCtl::get_ColorKey method (msvidctl.h)

Article
12/05/2018

[The feature associated with this page, Microsoft TV Technologies, is a legacy feature. Microsoft strongly recommends that new code does not use this feature.]

The get_ColorKey method retrieves the color key that the video renderer is using.

Syntax

HRESULT get_ColorKey(
  [out] OLE_COLOR *CurrentValue
);

Parameters

[out] CurrentValue

Receives an OLE_COLOR value.

Return value

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

Remarks

The color key is used when the video renderer draws to an overlay surface.

Examples


OLE_COLOR ocKey;
COLORREF clrKey;
pVideoControl->get_ColorKey(&ocKey);
OleTranslateColor(ocKey, 0, &clrKey);

Requirements

Requirement	Value
Minimum supported client	Windows�XP [desktop apps only]
Minimum supported server	None supported
Target Platform	Windows
Header	msvidctl.h

Share via