ICodecAPI::IsSupported 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.]

The IsSupported method queries whether a codec supports a given property.

Syntax

HRESULT IsSupported(
  [in] const GUID *Api
);

Parameters

[in] Api

Pointer to a GUID that specifies the property to query. For a list of standard codec properties, see Codec API Properties.

Return value

This method can return one of these values.

Return code	Description
S_FALSE	The codec does not support the property.
S_OK	The codec supports the property.
E_NOTIMPL	The codec does not support the property.

Remarks

Any errors besides those in the previous table indicate an inability to process the call.

Note If the codec does not support the property, the method can return either S_FALSE or E_NOTIMPL. The value E_NOTIMPL is preferred, but earlier documentation listed only S_FALSE, so some codecs might return that value. Applications should explicitly test for the value S_OK.

Requirements

Requirement	Value
Minimum supported client	Windows XP with SP2 [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2003 R2 [desktop apps \| UWP apps]
Target Platform	Windows
Header	strmif.h (include Dshow.h)
Library	Strmiids.lib