CBasePin.GetMediaTypeVersion 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 GetMediaTypeVersion method retrieves a version number for the set of preferred media types.

Syntax

virtual LONG GetMediaTypeVersion();

Parameters

This method has no parameters.

Return value

Returns the CBasePin::m_TypeVersion member variable.

Remarks

The CBasePin constructor initializes the version number to 1. In the base class, this number never changes. If the pin dynamically changes its list of preferred media types, it should increment the version number whenever the list changes. To increment the version number, call the CBasePin::IncrementTypeVersion method.

The media type enumerator, which is implemented by the CEnumMediaTypes class, uses the version number to keep itself synchronized with the pin.

Requirements

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

See also

CBasePin Class