IMFVideoMixerControl::SetStreamZOrder method

Sets the z-order of a video stream.

Syntax


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

Parameters

dwStreamID [in]

Identifier of the stream. For the EVR media sink, the stream identifier is defined when the IMFMediaSink::AddStreamSink method is called. For the DirectShow EVR filter, the stream identifier corresponds to the pin index. The reference stream is always stream 0.

dwZ [in]

Z-order value. The z-order of the reference stream must be zero. The maximum z-order value is the number of streams minus one.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return codeDescription
S_OK

The method succeeded.

E_INVALIDARG

The value of dwZ is larger than the maximum z-order value.

MF_E_INVALIDREQUEST

Invalid z-order for this stream. For the reference stream, dwZ must be zero. For all other streams, dwZ must be greater than zero.

MF_E_INVALIDSTREAMNUMBER

Invalid stream identifier.

 

Remarks

The EVR draws the video streams in the order of their z-order values, starting with zero. The reference stream must be first in the z-order, and the remaining streams can be in any order.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Evr.h

Library

Strmiids.lib

See also

IMFVideoMixerControl
Enhanced Video Renderer

 

 

Community Additions

ADD
Show:
© 2014 Microsoft