IVMRFilterConfig::SetImageCompositor method (strmif.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.
Syntax
HRESULT SetImageCompositor(
[in] IVMRImageCompositor *lpVMRImgCompositor
);
Parameters
[in] lpVMRImgCompositor
Pointer to the image compositor's IVMRImageCompositor interface.
Return value
If the method succeeds, it returns S_OK. If it fails, it returns an error code.
| Return code | Description |
|---|---|
|
The mixer is not currently loaded. |
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 compositor is automatically loaded when the VMR is in windowless or windowed mode. When the VMR is in renderless mode, the compositor must be loaded by calling IVMRFilterConfig::SetNumberOfStreams. The VMR manages all reference counting on the IVMRImageCompositor interface.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP with SP1 [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Target Platform | Windows |
| Header | strmif.h (include Dshow.h) |
| Library | Strmiids.lib |