COM Objects > OGG object > Methods > EncodeFormats.OGG.GetEncodeModeDesc method

Remarks

Retrieves the friendly description of the requested encoding mode available for the OGG Vorbis format.

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

For further details about encoding in OGG Vorbis format refer to the OGG object section.

For further information about available encoding formats see the EncodeFormats object.

Syntax

[Visual Basic]

control.EncodeFormats.OGG.GetEncodeModeDesc (

nEncodeModeIndex as integer

) as String

[C++]

LPCTSTR control.EncodeFormats.OGG.GetEncodeModeDesc (

short nEncodeModeIndex

);

Parameter

Description

nEncodeModeIndex

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

Supported encoding modes are described inside the EncodeFormats.OGG.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.