IVMRFilterConfig9::SetImageCompositor 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 SetImageCompositor method installs an application-provided image compositor object.
Syntax
HRESULT SetImageCompositor(
[in] IVMRImageCompositor9 *lpVMRImgCompositor
);
Parameters
[in] lpVMRImgCompositor
Pointer to the image compositor object provided by the application.
Return value
The method returns an HRESULT. Possible values include those in the following table.
| Return code | Description |
|---|---|
|
Cannot change the compositor when the VMR filter's pins are connected. |
|
NULL pointer. |
|
The method succeeded. |
|
The VMR is not in mixing mode. |
Remarks
Use this method to replace the VMR's default compositor with a custom compositor provided by the application. The image compositor is a sub-component of the mixer. The mixer must be loaded, through a call to IVMRFilterConfig9::SetNumberOfStreams,
before the compositor can be specified. The VMR manages all reference counting on the IVMRImageCompositor9 interface.
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 |