Methods > Audio format conversion

Remarks

Converts the given sound file from its original format using the sound encoding format defined inside the EncodeFormats.FormatToUse property.

A conversion session can be stopped at any time through a call to the ConvertFileCancel method.

Differently from the ExportToFile method, which requires a sound file to be previously loaded inside the editor through a call to the LoadSound method, the ConvertFile method will not perform a loading of the sound file but will simply perform a direct conversion.

During the conversion phase, a few effects, like Normalization and DC Offset removal, may be applied through the ConvertFileDestEffectsSet method and a few options may be set through the ConvertFileDestOptionsSet and through the ConvertFileDestResamplingSet methods.

Accepted input formats are: MP1, MP2, MP3, MP4 (***), AIFF, AAC, M4A, AC3, FLAC, WavPack, ALAC, WAV, OGG Vorbis, OPUS, WMA (*), ASF (**), WMV (**), W64, AU, PAF, SVX, NIST, VOC, IRCAM, PVF, CAF, Speex, Musepack, Monkey's Audio (APE).

Formats wrapped inside a RIFF container (for example GSM 6.10, ADPCM, CCITT, etc. ) are supported if the specific ACM (Audio Compression Manager) codec is installed inside the system.

Multi-channel WAV, AIFF, OGG Vorbis, OPUS and WMA formats are supported natively when the ConvertFileDestResamplingSet method has been invoked with the nChannels parameter set to a number higher than 2 while in other cases will be converted to stereo during the conversion procedure.

Accepted MOD formats are: MOD, MTM, S3M, XM, IT and MO3.

Accepted CD audio tracks format is CDA.

For converting files in RAW format use the ConvertFileRaw method.

For converting a specific range within the sound file you can use the ConvertFileRange method.

A successful call to this method will fire the ConvertSoundFileStarted event followed by a number of ConvertSoundFilePerc events and finally by the ConvertSoundFileDone event.

For converting several sound files in one single shot you can use the "Conversion automation" feature described inside the How to convert format of sound files tutorial.

Syntax

[Visual Basic]

Public Function ConvertFile (

strSourcePathname as String

) as enumErrorCodes

[C#]

public enumErrorCodes ConvertFile (

string strSourcePathname

);

[C++]

public: enumErrorCodes ConvertFile (

string strSourcePathname

);

Parameter	Description

strSourcePathname	String representing the absolute pathname of the input file.

Return value

Value	Meaning

Negative value	An error occurred. Check the LastError property value in order to see the last error.
enumErrorCodes.ERR_NOERROR (0)	The method call was successful.

(*) Requires Microsoft Windows Media Format modules already installed on the target PC: you can verify the presence of these modules through a call to the IsWmaAvailable method.

(**) Only sound stream supported (no video): requires Microsoft Windows Media Format modules already installed on the target PC

(***) Only sound stream supported (no video)

The Windows Media Format modules can be installed using the redistribution setup package (wmfdist.exe) provided by Microsoft. Details about the integration of these modules inside your own setup package can be found on the following link of the official Microsoft web site (note that in the future this link could change due to the Microsoft site maintenance).