IAMWstDecoder::GetBackgroundColor method (iwstdec.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.]
Downstream filters use the GetBackgroundColor method to retrieve the current physical color used in color keying the background for overlay mixing.
Syntax
HRESULT GetBackgroundColor(
[out] DWORD *pdwPhysColor
);
Parameters
[out] pdwPhysColor
Receives the physical color as an RGB value.
Return value
When the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Target Platform | Windows |
| Header | iwstdec.h |
| Library | Strmiids.lib |