Edit

Share via

IWMCodecProps::GetCodecProp method (wmcodecdsp.h)

  • Article

Retrieves a codec property specific to an output format.

Syntax

HRESULT GetCodecProp(
  [in]      DWORD             dwFormat,
  [in]      LPCWSTR           pszName,
  [out]     WMT_PROP_DATATYPE *pType,
  [out]     BYTE              *pValue,
  [in, out] DWORD             *pdwSize
);

Parameters

[in] dwFormat

The output format to which the property applies. Set this value to the FOURCC value of the desired video format.

[in] pszName

Wide-character, null-terminated string containing the property name. The properties listed in the following table are supported only through the IWMCodecProps interface.

Property name constant Meaning
g_wszWMCPCodecName
 Retrieves the name of the codec that is associated with the format (or FOURCC). This is an alternative to the IWMCodecStrings interface.
g_wszWMCPSupportedVBRModes
 Retrieves the encoding modes supported by the codec. The value returned contains one or more of the following flags:
  • WM_CODEC_ONEPASS_CBR
  • WM_CODEC_ONEPASS_VBR
  • WM_CODEC_TWOPASS_CBR
  • WM_CODEC_TWOPASS_VBR_UNCONSTRAINED
  • WM_CODEC_TWOPASS_VBR_PEAKCONSTRAINED

[out] pType

Address of a variable that receives the data type of the property value.

[out] pValue

Address of the byte buffer that receives the property value.

[in, out] pdwSize

Pointer to the size of the value buffer, in bytes. If pValue is NULL, the method will set this value to the size required.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK
 The method succeeded.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header wmcodecdsp.h

See also

IWMCodecProps Interface