Copyright © 2011-2016 MultiMedia Soft

EncodeFormats.OGG.CustomString property

Previous pageReturn to chapter overviewNext page

Type

[Visual Basic]

Public Property CustomString As string


 

[C#]

public string CustomString {get; set;}


 

[C++]

public: __property string get_CustomString();

public: __property void set_CustomString(string);


 

 

Remarks

String containing custom OGG Vorbis options to send to the OggEnc encoder.

 

For advanced users, this string allows applying all of the possible OGG Vorbis encoding options available with OggEnc. See Appendix B - OggEnc command line for the complete set of available options.

 

This property is used only if the EncodeFormats.FormatToUse property is set to ENCODING_FORMAT_OGG and the EncodeFormats.OGG.EncodeMode property is set to OGG_ENCODE_CUSTOM.

 

IMPORTANT NOTE: As you may know, the OggEnc command line is as follows:

Usage: oggenc [options] input.wav [...]

 

Contents of the CustomString property are related to the [options] field only so you must omit entering the word oggenc and omit to specify the input.wav file and [...] settings also. You should also omit the -r option which is already applied internally.

 

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.