IVMRMixerControl::GetZOrder method (strmif.h)

[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 GetZOrder method retrieves this video stream's position in the Z order.

Syntax

HRESULT GetZOrder(
  [in]  DWORD dwStreamID,
  [out] DWORD *pZ
);

Parameters

[in] dwStreamID

Specifies the input stream.

[out] pZ

Pointer to a DWORD that receives the current position in the Z-order.

Return value

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

Return code Description
E_POINTER
pZOrder is invalid.
VFW_E_NOT_CONNECTED
The pin is not connected.

Remarks

The default Z-order is the order in which the pins were created.

Requirements

Requirement Value
Minimum supported client Windows XP with SP1 [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header strmif.h (include Dshow.h)
Library Strmiids.lib

See also

Error and Success Codes

IVMRMixerControl Interface

IVMRMixerControl::SetZOrder

Using the Video Mixing Renderer