IMFVideoProcessor::SetBackgroundColor method

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

ClrBkg [in]

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 codeDescription
S_OK

The method succeeded.

 

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Evr9.h

Library

Strmiids.lib

See also

IMFVideoProcessor
Enhanced Video Renderer

 

 

Show: