Edit

ICodecAPI::GetDefaultValue method (strmif.h)

  • Article

[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 GetDefaultValue method gets the default value of a codec property.

Syntax

HRESULT GetDefaultValue(
  [in]  const GUID *Api,
  [out] VARIANT    *Value
);

Parameters

[in] Api

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

[out] Value

Pointer to a VARIANT that receives the default value. The caller must free the VARIANT by calling VariantClear.

Return value

This method can return one of these values.

Return code Description
S_OK
 The method succeeded.
VFW_E_CODECAPI_NO_DEFAULT
 The specified property does not have a default value.

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

See also

Codec API Reference

Encoder API

ICodecAPI