IMFPMediaPlayer::SetBorderColor method (mfplay.h)

Article
02/22/2024

Important Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.

Sets the color for the video border. The border color is used to letterbox the video.

Syntax

HRESULT SetBorderColor(
  [in] COLORREF Clr
);

Parameters

[in] Clr

Specifies the border color as a COLORREF value. Use the RGB macro to create this value. The default value is black.

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.
MF_E_INVALIDREQUEST	The current media item does not contain video.
MF_E_SHUTDOWN	The object's Shutdown method was called.

Remarks

This method fails if no media item is currently set, or if the current media item does not contain video.

To set the border color before playback starts, call this method inside your event handler for the MFP_EVENT_TYPE_MEDIAITEM_SET event. For more information, see IMFPMediaPlayerCallback::OnMediaPlayerEvent.

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Target Platform	Windows
Header	mfplay.h