CBaseFilter.GetPinVersion method

[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 GetPinVersion method retrieves a version number for the set of pins on this filter.

Syntax

virtual long GetPinVersion();

Parameters

This method has no parameters.

Return value

Returns the CBaseFilter::m_PinVersion member variable.

Remarks

The CBaseFilter constructor initializes the pin version to 1. In the base class, this number never changes. If the filter dynamically creates or destroys pins, it should increment the pin version whenever the pins change. To increment the version number, call the CBaseFilter::IncrementPinVersion method.

The pin enumerator object, which is implemented by the CEnumPins class, uses the pin version to keep itself synchronized with the filter.

Requirements

Requirement Value
Header
Amfilter.h (include Streams.h)
Library
Strmbase.lib (retail builds);
Strmbasd.lib (debug builds)

See also

CBaseFilter Class