IMFVideoProcessor::SetBackgroundColor method (evr9.h)

Sets the background color for the composition rectangle. The background color is used for letterboxing the video image.

Syntax

HRESULT SetBackgroundColor(
  [in] COLORREF ClrBkg
);

Parameters

[in] ClrBkg

Background color, specified as a COLORREF value. Use the RGB macro to create this value.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK
The method succeeded.

Requirements

   
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header evr9.h
Library Strmiids.lib

See also

Enhanced Video Renderer

IMFVideoProcessor