Share via


IEncoderAPI::GetDefaultValue Method

Note  The IEncoderAPI interface is deprecated. Use ICodecAPI instead.
The GetDefaultValue method retrieves the default value for a parameter, if one exists.

Syntax

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

Parameters

  • Api [in]
    Pointer to a GUID that specifies the parameter.

  • Value [out]
    Receives the value for the parameter specified in Api. If Api was specified as ENCAPIPARAM_BITRATE_MODE, then Value will be one of the VIDEOENCODER_BITRATE_MODE constants.

Return Value

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

Requirements

Header Declared in Strmif.h; include Dshow.h.
Library Use Strmiids.lib.

See Also

Encoder API
IEncoderAPI Interface

Send comments about this topic to Microsoft

Build date: 12/4/2008