Classes > EncodeCAF class > Methods > EncodeFormats.CAF.GetEncodeModeDesc method

Remarks

Retrieves the friendly description of the requested encoding mode available for the Core Audio File format.

The number of available encoding modes can be obtained using the EncodeFormats.CAF.GetEncodeModesCount method.

For further details about encoding in Core Audio File format refer to the EncodeCAF class section.

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

Syntax

[Visual Basic]

Public Function GetEncodeModeDesc (

nEncodeModeIndex as Int16

) as string

[C#]

public string GetEncodeModeDesc (

Int16 nEncodeModeIndex

);

[C++]

public: string GetEncodeModeDesc (

Int16 nEncodeModeIndex

);

Parameter

Description

nEncodeModeIndex

Number representing the zero-based index of the encoding mode.

Supported encoding modes are described inside the EncodeFormats.CAF.EncodeMode property.

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 requested recording format.