IVMRFilterConfig::SetImageCompositor

  • Article
 
Microsoft DirectShow 9.0

IVMRFilterConfig::SetImageCompositor

The SetImageCompositor method installs an application-provided image compositor.

Syntax

  HRESULT SetImageCompositor(

  
  IVMRImageCompositor*
  
  lpVMRImgCompositor

  );

Parameters

lpVMRImgCompositor

[in]  Pointer to the image compositor's IVMRImageCompositor interface.

Return Values

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Error Code Description
VFW_E_WRONG_STATE 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

Header: Declared in Strmif.h; include Dshow.h.

Library: Use Strmiids.lib.

See Also