IVMRMixerControl9::SetZOrder 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 SetZOrder method sets this video stream's position in the Z-order; larger values are further away.

Syntax

HRESULT SetZOrder(
  [in] DWORD dwStreamID,
  [in] DWORD dwZ
);

Parameters

[in] dwStreamID

Specifies the input stream. This value corresponds to the input pin. For example, the first input pin is stream 0.

[in] dwZ

Double word containing the stream's position within the Z-order.

Return value

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

Return code	Description
S_OK	The method succeeded.
VFW_E_NOT_CONNECTED	The pin is not connected.

Remarks

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

Requirements


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