IMixerPinConfig2::GetOverlaySurfaceColorControls method (mpconfig.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 GetOverlaySurfaceColorControls method retrieves the color control settings associated with the specified overlay surface.

Syntax

HRESULT GetOverlaySurfaceColorControls(
  [out] LPDDCOLORCONTROL pColorControl
);

Parameters

[out] pColorControl

Address of a pointer to the DDCOLORCONTROL structure containing the color values currently applied to the specified surface.

Return value

Returns an HRESULT value. If the allocator on the pin is not using an overlay surface, the method returns E_FAIL.

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 mpconfig.h
Library Strmiids.lib

See also

Error and Success Codes

IMixerPinConfig2 Interface