IVMRFilterConfig::SetImageCompositor method

The SetImageCompositor method installs an application-provided image compositor.

Syntax


HRESULT SetImageCompositor(
  [in]  IVMRImageCompositor *lpVMRImgCompositor
);

Parameters

lpVMRImgCompositor [in]

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 codeDescription
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

Minimum supported client

Windows XP with SP1 [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Strmif.h (include Dshow.h)

Library

Strmiids.lib

See also

Error and Success Codes
Using the Video Mixing Renderer
IVMRFilterConfig Interface

 

 

Community Additions

ADD
Show:
© 2015 Microsoft