Share via


IMFVideoMixerBitmap::UpdateAlphaBitmapParameters method (evr9.h)

[The component described on this page, Enhanced Video Renderer, is a legacy feature. It has been superseded by the Simple Video Renderer (SVR) exposed through the MediaPlayer and IMFMediaEngine components. To play video content you should send data into one of these components and allow them to instantiate the new video renderer. These components have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer or the lower level IMFMediaEngine APIs to play video media in Windows instead of the EVR, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

Updates the current alpha-blending settings, including the source and destination rectangles, the color key, and other information. You can update some or all of the blending parameters.

Syntax

HRESULT UpdateAlphaBitmapParameters(
  [in] const MFVideoAlphaBitmapParams *pBmpParms
);

Parameters

[in] pBmpParms

Pointer to an MFVideoAlphaBitmapParams structure that contains the blending parameters.

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.
E_INVALIDARG
The blending parameters defined in the pBmpParms structure are not valid.
MF_E_NOT_INITIALIZED
No bitmap is currently set. You must call IMFVideoMixerBitmap::SetAlphaBitmap to set a bitmap.

Remarks

The video must be playing for the changes to take effect.

Requirements

Requirement Value
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

IMFVideoMixerBitmap