Copyright © 2008-2018 MultiMedia Soft

EncodeFormats.OGG.GetEncodeModeDesc method

Previous pageReturn to chapter overviewNext page

Remarks

 

Retrieves the friendly description of the requested encoding mode available for the OGG 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 EncodeOGG 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.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.