Share via


IMFVideoProcessor::SetVideoProcessorMode 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.]

Sets the preferred video processor mode. The EVR will attempt to use this mode when playback starts.

Syntax

HRESULT SetVideoProcessorMode(
  [in] LPGUID lpMode
);

Parameters

[in] lpMode

Pointer to a GUID that identifies the video processor mode. To get a list of available modes, call IMFVideoProcessor::GetAvailableVideoProcessorModes.

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.
D3DERR_INVALIDCALL
The requested mode is not valid.
MF_E_INVALIDREQUEST
The mixer has already allocated Direct3D resources and cannot change modes.
MF_E_TRANSFORM_TYPE_NOT_SET
The media type for the reference stream is not set.

Remarks

Before calling this method, set the media type for the reference stream as follows:

  • DirectShow EVR filter: Connect pin 0.
  • EVR media sink: Set the media type for stream 0.
  • Mixer (standalone): Set the media type for input stream 0 and set the media type for the output stream.
Which modes are available might depend on the reference stream's media type.

Call this method before video playback begins.

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

IMFVideoProcessor