Classes > EncodeACM class > Methods > EncodeFormats.ACM.GetCodecFormatDesc method

Remarks

Returns the friendly description of the given format for a certain ACM codec.

The number of available formats for the given ACM codec can be obtained using the EncodeFormats.ACM.GetCodecFormatsCount method.

For further details about the Windows Audio Compression Manager refer to the EncodeACM class section.

For a tutorial about the use of the Windows Audio Compression Manager refer to the How to use the Windows Audio Compression Manager section.

For further information about available encoding formats see the EncodeFormatsMan class.

Syntax

[Visual Basic]

Public Function GetCodecFormatDesc (

nCodecIndex as Int16,

nCodecFormatIndex as Int16

) as String

[C#]

public string GetCodecFormatDesc (

Int16 nCodecIndex,

Int16 nCodecFormatIndex

);

[C++]

public: string GetCodecFormatDesc (

Int16 nCodecIndex,

Int16 nCodecFormatIndex

);

Parameter	Description

nCodecIndex	Number representing the zero-based index of the ACM codec
nCodecFormatIndex	Number representing the zero-based index of the format for the given ACM codec

Return value

Value	Meaning

Empty string	An error occurred. Check the LastError property value in order to see the last error.
Valid string	The string containing the friendly description of the format