Microsoft DirectX 8.1 (C++)

IVMRFilterConfig::SetImageCompositor

This topic applies to Windows XP Home Edition and Windows XP Professional only.

The SetImageCompositor method installs an application-provided image compositor object.

Syntax

HRESULT SetImageCompositor(
  IVMRImageCompositor*  lpVMRImgCompositor
);

Parameters

lpVMRImgCompositor

[in]  Pointer to the image compositor object provided by the application.

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 mixer must be loaded, through a call to IVMRFilterConfig::SetNumberOfStreams, before the compositor can be specified. The VMR manages all reference counting on the IVMRImageCompositor interface.

See Also