ICodecAPI::IsSupported method (icodecapi.h)

Article
07/27/2022

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 10 Build 20348
Minimum supported server	Windows 10 Build 20348
Header	icodecapi.h