IVMRImageCompositor9::CompositeImage method (vmr9.h)

Article
4/26/2023

[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 CompositeImage method composites the current frames available in each input stream.

Syntax

HRESULT CompositeImage(
  [in] IUnknown            *pD3DDevice,
  [in] IDirect3DSurface9   *pddsRenderTarget,
  [in] AM_MEDIA_TYPE       *pmtRenderTarget,
  [in] REFERENCE_TIME      rtStart,
  [in] REFERENCE_TIME      rtEnd,
  [in] D3DCOLOR            dwClrBkGnd,
  [in] VMR9VideoStreamInfo *pVideoStreamInfo,
  [in] UINT                cStreams
);

Parameters

[in] pD3DDevice

Pointer to the IUnknown interface of the Direct3D device object.

[in] pddsRenderTarget

Specifies the Direct3D surface that all drawing should be performed on.

[in] pmtRenderTarget

Pointer to an AM_MEDIA_TYPE structure that contains the media type of the target surface.

[in] rtStart

Specifies the start time.

[in] rtEnd

Specifies the end time.

[in] dwClrBkGnd

Specifies the background color, as a D3DCOLOR type.

[in] pVideoStreamInfo

Pointer to an array of VMR9VideoStreamInfo structures, which describe each video stream.

[in] cStreams

Specifies the number of streams to mix, which is also the size of the pVideoStreamInfo array.

Return value

The method returns an HRESULT. Possible values include those in the following table.

Return code	Description
S_OK	The method succeeded.

Remarks

Include DShow.h and D3d9.h before Vmr9.h.

Requirements

Requirement	Value
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

Share via