Share via

IWMCodecProps::GetCodecProp

  • Article
banner art

Retrieves a codec property specific to an output format.

Syntax

HRESULT GetCodecProp(DWORDdwFormat,LPCWSTRpszName,WMT_PROP_DATATYPE*pType,BYTE*pValue,DWORD*pdwSize);

Parameters

dwFormat

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

pszName

[in]  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 Description
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

pType

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

pValue

[out]  Address of the byte buffer that receives the property value.

pdwSize

[in, out]  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 Values

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

Client: Requires Windows Vista or Windows XP.

Header: Include wmcodecdsp.h.

See Also