IVMRMixerControl::GetOutputRect 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 GetOutputRect method retrieves the position of this stream's video rectangle within the composition rectangle.

Syntax

HRESULT GetOutputRect(
  [in]  DWORD          dwStreamID,
  [out] NORMALIZEDRECT *pRect
);

Parameters

[in] dwStreamID

Specifies the input stream.

[out] pRect

Pointer to a NORMALIZEDRECT structure that receives the destination rectangle in composition space.

Return value

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

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

Remarks

Because this rectangle exists in compositional space, there is no such thing as an "invalid" rectangle. For example, if left is greater than right, it means the video is mirrored in the x direction. An empty rectangle turns off this stream.

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::SetOutputRect

Using the Video Mixing Renderer