IVMRWindowlessControl::SetBorderColor 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.]

The SetBorderColor method sets the border color to be used by the VMR.

Syntax

HRESULT SetBorderColor(
  [in] COLORREF Clr
);

Parameters

[in] Clr

Specifies the border color.

Return value

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

The border color is color used to fill any area of the destination rectangle that does not contain video. It is typically used in two instances: (1) when the video straddles two monitors and (2) when the VMR is trying to maintain the aspect ratio of the movie by letter boxing the video to fit within the specified destination rectangle. See the IVMRWindowlessControl::SetAspectRatioMode method.

Requirements

See also

Error and Success Codes

IVMRWindowlessControl Interface

IVMRWindowlessControl::GetBorderColor

Using the Video Mixing Renderer