IVMRMixerControl9::GetBackgroundClr method (vmr9.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 GetBackgroundClr method gets the current background color on the output rectangle.
Syntax
HRESULT GetBackgroundClr(
[in] COLORREF *lpClrBkg
);
Parameters
[in] lpClrBkg
Pointer to a variable that receives the background color.
Return value
The method returns an HRESULT. Possible values include those in the following table.
| Return code | Description |
|---|---|
|
The method succeeded. |
Remarks
Include DShow.h and D3d9.h before Vmr9.h.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP with SP2 [desktop apps only] |
| Minimum supported server | Windows Server 2003 R2 [desktop apps only] |
| Target Platform | Windows |
| Header | vmr9.h |
| Library | Strmiids.lib |