COM Objects > TracksBoard object > Methods > TracksBoard.ExportToFile method

Remarks

Mixes and exports the current content of the TracksBoard into a destination file using the sound encoding format defined inside the EncodeFormats.FormatToUse property.

An exporting session can be stopped at any time through a call to the ExportSoundCancel method.

A successful call to this method will fire the SoundExportStarted event followed by a number of SoundExportPerc events and finally by the SoundExportDone event.

For further details see the How to export edited sounds tutorial.

For details about the use of the TracksBoard refer to the How to use the TracksBoard to visually compose songs tutorial.

For further details about methods of the TracksBoard refer to the TracksBoard object section.

Syntax

[Visual Basic]

control.TracksBoard.ExportToFile (

nFrequency as Long,

nChannels as Long,

strPathname as String

) as enumErrorCodes

[C++]

short control.TracksBoard.ExportToFile (

long nFrequency,

long nChannels,

LPCTSTR strPathname

);

Parameter

Description

nFrequency

Frequency used to resample the sound to export (44100, 22050, etc.). This parameter is ignored when:

•	the EncodeFormats.FormatToUse property is set to ENCODING_FORMAT_WMA and the EncodeFormats.WMA.EncodeMode property is set to WMA_ENCODE_PROFILE

•	the EncodeFormats.FormatToUse property is set to ENCODING_FORMAT_ACM

nChannels

Number of channels used to resample the sound to export: accepted values are 1 for Mono and 2 for Stereo.

This parameter is ignored when:

•	the EncodeFormats.FormatToUse property is set to ENCODING_FORMAT_WMA and the EncodeFormats.WMA.EncodeMode property is set to WMA_ENCODE_PROFILE

•	the EncodeFormats.FormatToUse property is set to ENCODING_FORMAT_ACM

strPathname

String containing the absolute pathname of the destination file. If this pathname should contain invalid characters, they would be automatically changed into an underscore '_' character.

Return value

Value	Meaning

Negative value	An error occurred, check the LastError property value in order to see the error code meaning
enumErrorCodes.ERR_NOERROR (0)	The method call was successful.