IVMRMixerControl9::GetProcAmpControl 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 GetProcAmpControl method retrieves the current image adjustment settings for the VMR-9. Image adjustment includes brightness, contrast, hue, and saturation, and is performed by the graphics device. If the graphics driver does not support hardware image adjustment, this method fails.

Syntax

HRESULT GetProcAmpControl(
  [in]      DWORD              dwStreamID,
  [in, out] VMR9ProcAmpControl *lpClrControl
);

Parameters

[in] dwStreamID

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

[in, out] lpClrControl

Pointer to a VMR9ProcAmpControl structure that receives the image adjustment settings. When the method returns, the dwFlags field indicates which properties are supported by the graphics driver. Set the dwSize member in the structure before calling this method.

Return value

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

Return code Description
E_INVALIDARG
Invalid argument. Possible causes of this error include:
  • The stream number is invalid
  • The value of dwSize in the VMR9ProcAmpControl structure is invalid.
E_POINTER
NULL pointer argument.
S_OK
Success.
VFW_E_NOT_CONNECTED
The pin is not connected.
VFW_E_VMR_NO_PROCAMP_HW
The graphics hardware does not support ProcAmp controls.

Remarks

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

Requirements

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