IMFPMediaItem::GetStreamAttribute method (mfplay.h)

Article
02/22/2024

Important Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.

Queries the media item for a stream attribute.

Syntax

HRESULT GetStreamAttribute(
  [in]  DWORD       dwStreamIndex,
  [in]  REFGUID     guidMFAttribute,
  [out] PROPVARIANT *pvValue
);

Parameters

[in] dwStreamIndex

Zero-based index of the stream. To get the number of streams, call IMFPMediaItem::GetNumberOfStreams.

[in] guidMFAttribute

GUID that identifies the attribute value to query. Possible values are listed in the following topics:

[out] pvValue

Pointer to a PROPVARIANT that receives the value. The method fills the PROPVARIANT with a copy of the stored value. Call PropVariantClear to free the memory allocated by this method.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

Stream attributes describe an individual stream (audio, video, or other) within the presentation. To get an attribute that applies to the entire presentation, call IMFPMediaItem::GetPresentationAttribute.

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Target Platform	Windows
Header	mfplay.h