IVMRMixerControl9::SetAlpha method (vmr9.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 SetAlpha method sets a constant alpha value that is applied to this video stream.

Syntax

HRESULT SetAlpha(
  [in] DWORD dwStreamID,
  [in] float Alpha
);

Parameters

[in] dwStreamID

Specifies the input stream. This value corresponds to the input pin. For example, the first input pin is stream 0.

[in] Alpha

Specifies the alpha blending value to be applied to all the pixels in this stream.

Return value

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

Return code Description
S_OK
The method succeeded.
VFW_E_NOT_CONNECTED
The pin is not connected.

Remarks

The alpha value specified can range from 0.0 (fully transparent) to 1.0 (full opaque).

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

See also

IVMRMixerControl9 Interface

Using the Video Mixing Renderer