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.
During the execution of the exporting session the CallbackPercentage delegate is invoked, with the nOperation parameter set to OPERATION_SOUND_EXPORT, in order to notify about the percentage of advancement of the exporting session.
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]
Public Function ExportToFile (
nFrequency as Int32,
nChannels as Int32,
strPathname as string
) as enumErrorCodes
|
|
[C#]
public enumErrorCodes ExportToFile (
Int32 nFrequency,
Int32 nChannels,
string strPathname
);
|
|
[C++]
public: enumErrorCodes ExportToFile (
Int32 nFrequency,
Int32 nChannels,
string 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.
|
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.
|
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 last error.
|
enumErrorCodes.ERR_NOERROR (0)
|
The method call was successful.
|
|
