IWMCodecProps::GetFormatProp Method

  • 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

  • pmt [in]
    Pointer to the output media type.

  • 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 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, and are described in the Properties section.

  • 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 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

Minimum supported client

 Windows XP

Minimum supported server

 Windows Server 2003

Header

 Wmcodecdsp.h

See Also

MFPKEY_VBRENABLED

MFPKEY_VBRQUALITY

IWMCodecProps Interface

 

 

Send comments about this topic to Microsoft

Build date: 4/7/2010