IFilterMapper::RegisterFilterInstance method (strmif.h)

Article
02/22/2024

[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 The IFilterMapper interface is deprecated. Use IFilterMapper2 instead.

Registers an identifiable instance of a filter.

Syntax

HRESULT RegisterFilterInstance(
  [in]  CLSID   clsid,
  [in]  LPCWSTR Name,
  [out] CLSID   *MRId
);

Parameters

[in] clsid

GUID of the filter.

[in] Name

Descriptive name of the instance.

[out] MRId

Pointer to the returned media resource ID. This parameter is a locally unique identifier for this instance of this filter.

Return value

Returns an HRESULT value.

Remarks

This method handles cases such as when two similar sound cards that are driven by the same driver are available, and it is necessary to choose which card will emit the sound. This is not needed if there is only one instance of the filter (such as when there is only one sound card in the computer), or if all instances of the filter are equivalent.

The filter itself must have already been registered.

Requirements

Requirement	Value
Target Platform	Windows
Header	strmif.h (include Dshow.h)