IVMRMixerControl::GetBackgroundClr method (strmif.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.]
Gets the current background color on the output rectangle.
Syntax
HRESULT GetBackgroundClr(
[in] COLORREF *lpClrBkg
);
Parameters
[in] lpClrBkg
Address of a variable that receives the background color.
Return value
If the method succeeds, it returns S_OK. If it fails, it returns an error code.
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 |