Share via


IMediaStream::GetInformation (Compact 2013)

3/26/2014

This method retrieves the stream's purpose ID and media type.

Syntax

HRESULT GetInformation(
  MSPID* pPurposeId,
  STREAM_TYPE* pType
);

Parameters

  • pPurposeId
    [out] Pointer to an MSPID value that will contain the stream's purpose ID.

    If this parameter is NULL on entry, the method will not retrieve the purpose ID.

  • pType
    [out] 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 will not 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 one of the following:

  • MSPID_PrimaryVideo, which identifies the primary video stream
  • MSPID_PrimaryAudio, which identifies the primary audio stream

You can define other values if necessary.

Requirements

Header

dshow.h

Library

Strmiids.lib

See Also

Reference

IMediaStream Interface