Share via


IMPEG2PIDMap::UnmapPID method (bdaiface.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.]

The UnmapPID method unmaps one or more PIDs.

Syntax

HRESULT UnmapPID(
  [in] ULONG culPID,
  [in] ULONG *pulPID
);

Parameters

[in] culPID

The number of elements in the pulPID array.

[in] pulPID

Pointer to an array of size culPID, allocated by the caller. Each element in the array contains a PID to be unmapped

Return value

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

Remarks

On output pins for audio and video streams, there will typically be only one PID mapped at any given time. On an output pin such as one delivering the PSI stream to the Transport Information Filter, there may be multiple PIDs mapped to a single pin. Use the IEnumPIDMap methods to determine which PIDs are mapped to the pin, and then fill in the pulPID array with those values.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header bdaiface.h
Library Strmiids.lib

See also

Error and Success Codes

IMPEG2PIDMap Interface