IMediaStreamFilter::GetMediaStream method (amstream.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.]

Note This interface is deprecated. New applications should not use it.

The GetMediaStream method retrieves a media stream, specified by purpose ID.

Syntax

HRESULT GetMediaStream(
  [in]  REFMSPID     idPurpose,
  [out] IMediaStream **ppMediaStream
);

Parameters

[in] idPurpose

Reference to an MSPID value that specifies which stream to retrieve.

[out] ppMediaStream

Address of a variable that receives an IMediaStream interface pointer.

Return value

Returns an HRESULT value. Possible values include the following.

Return code	Description
E_POINTER	NULL pointer argument.
MS_E_NOSTREAM	No matching stream was found.
S_OK	Success.

Remarks

If the method succeeds, the caller must release the IMediaStream interface.

Requirements

Requirement	Value
Target Platform	Windows
Header	amstream.h