IMediaStream::GetInformation method (mmstream.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.]

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

Retrieves the stream's purpose ID and media type.

Syntax

HRESULT GetInformation(
  [out] MSPID       *pPurposeId,
  [out] STREAM_TYPE *pType
);

Parameters

[out] pPurposeId

Pointer to an MSPID value that will contain the stream's purpose ID (see Multimedia Streaming Data Types). If this parameter is NULL on entry, the method won't retrieve the purpose ID.

[out] pType

Pointer to a STREAM_TYPE enumerated data type value that will contain the stream's media type. If this parameter is NULL on entry, the method won't retrieve the media type.

Return value

Returns S_OK if successful or E_POINTER if one of the parameters is invalid.

Remarks

The value retrieved in the pPurposeId parameter will usually be either MSPID_PrimaryVideo, which identifies the primary video stream, or MSPID_PrimaryAudio, which identifies the primary audio stream; however, you can define other values if necessary.

Requirements

Requirement	Value
Target Platform	Windows
Header	mmstream.h

Share via