IMPEG2StreamIdMap::UnmapStreamId method (strmif.h)

Article
07/27/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.]

The UnmapStreamId method unmaps the Stream ID mapping created in a previous call to MapStreamId.

Syntax

HRESULT UnmapStreamId(
  [in] ULONG culStreamId,
  [in] ULONG *pulStreamId
);

Parameters

[in] culStreamId

The number of elements in the pulStreamID array.

[in] pulStreamId

Array of Stream IDs mapped for this pin.

Return value

Returns S_OK if successful. If the method fails, it returns an HRESULT error code.

Remarks

There is typically only one stream ID mapped to a given pin, therefore pulStreamID will typically contain a single element.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	strmif.h (include Dshow.h)
Library	Strmiids.lib