IVMRWindowlessControl9::SetBorderColor method (vmr9.h)

Article
4/26/2023

[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 SetBorderColor method sets the border color to be used by the VMR.

Syntax

HRESULT SetBorderColor(
  [in] COLORREF Clr
);

Parameters

[in] Clr

Specifies the color as a COLORREF value.

Return value

The method returns an HRESULT. Possible values include those in the following table.

Return code	Description
S_OK	The method succeeded.

Remarks

The border color is used to fill any area of the destination rectangle that does not contain video. It is typically used in two situations:

When the video straddles two monitors
When the VMR is trying to maintain the aspect ratio of the movies by letter-boxing the video to fit within the specified destination rectangle. See SetAspectRatioMode.

Include DShow.h and D3d9.h before Vmr9.h.

Requirements


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