Edit

Share via

IWMCodecProps::GetFormatProp method (wmcodecdsp.h)

  • Article

Retrieves a format property for an output media type. Use this method to get information about enumerated audio formats.

Syntax

HRESULT GetFormatProp(
  [in]      DMO_MEDIA_TYPE    *pmt,
  [in]      LPCWSTR           pszName,
  [out]     WMT_PROP_DATATYPE *pType,
  [out]     BYTE              *pValue,
  [in, out] DWORD             *pdwSize
);

Parameters

[in] pmt

Pointer to the output media type.

[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_wszSpeechFormatCaps
 Retrieves the speech modes available for the format (used only by the Windows Media Audio 9 Voice codec). Value contains flags identical to the values used to specify the mode for MFPKEY_WMAVOICE_ENC_MusicSpeechClassMode.
 

The properties in the following list are also supported. They are used with IPropertyBag for video.

[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

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

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

MFPKEY_VBRENABLED

MFPKEY_VBRQUALITY