Methods > Editors > ExportAndSplitStereoChannelsToFile method

Remarks

Requests to export the given sound portion splitting the sound in two output files containing the left and right channels respectively. The sound encoding format is defined inside the EncodeFormats.FormatToUse property.

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

In case you should need to export single channels (or channels pairs from multi-channel sound files) use the ExportChannelsToFile method.

If the EncodeFormats.FormatToUse property is set to ENCODING_FORMAT_WMA, the only supported encoding mode for the EncodeFormats.WMA.EncodeMode property is WMA_ENCODE_CBR_STD_16 and the WMA.CBR property must be set to a value that can support both stereo and mono, so the only compatible combinations are the following:

•	for sounds at 16000 Hz CBR must be set to 16000 (16 kbps)

•	for sounds at 22050 Hz CBR must be set to 20000 (20 kbps)

•	for sounds at 44100 Hz CBR must be set to 32000 (32 kbps) or 48000 (48 kbps)

If the EncodeFormats.FormatToUse property is set to ENCODING_FORMAT_WAV, the splitting will only work if the EncodeFormats.WAV.EncodeMode property is set to a format supporting both mono and stereo formats meaning that, for example, it will not work for mono-only formats like WAV_ENCODE_GSM_610 or WAV_ENCODE_G721_ADPCM_32.

If the EncodeFormats.FormatToUse property is set to ENCODING_FORMAT_AIFF, the splitting will only work if the EncodeFormats.AIFF.EncodeMode property is set to a format supporting both mono and stereo formats meaning that, for example, it will not work for mono-only formats like AIFF_ENCODE_GSM_610.

If the EncodeFormats.FormatToUse property is set to ENCODING_FORMAT_AU, the splitting will only work if the EncodeFormats.AU.EncodeMode property is set to a format supporting both mono and stereo formats meaning that, for example, it will not work for mono-only formats like AU_ENCODE_G721_ADPCM_32 or AU_ENCODE_G723_ADPCM_24 or AU_ENCODE_G723_ADPCM_40.

If the EncodeFormats.FormatToUse property is set to ENCODING_FORMAT_ACM, the splitting will only work if the selected codec supports both mono and stereo formats meaning that, for example, it will not work for mono-only codecs like GSM 6.10 or G721 ADPCM.

The split doesn't work if the EncodeFormats.FormatToUse property is set to ENCODING_FORMAT_AAC because this format doesn't support creating mono sounds.

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 about callback delegates see the How to synchronize the container application with the API tutorial.

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

Syntax

[Visual Basic]

Public Function ExportAndSplitStereoChannelsToFile (

nStartPosition as Int32,

nEndPosition as Int32,

strOutputPathLeft as string,

strOutputPathRight as string

) as enumErrorCodes

[C#]

public enumErrorCodes ExportAndSplitStereoChannelsToFile (

Int32 nStartPosition,

Int32 nEndPosition,

string strOutputPathLeft,

string strOutputPathRight

);

[C++]

public: enumErrorCodes ExportAndSplitStereoChannelsToFile (

Int32 nStartPosition,

Int32 nEndPosition,

string strOutputPathLeft,

string strOutputPathRight

);

Parameter	Description

nStartPosition	Start position, expressed in milliseconds, of the sound range to export
nEndPosition	End position, expressed in milliseconds, of the sound range to export. If set to -1 the end position will be set to the end of the sound.
strOutputPathLeft	String containing the absolute pathname of the destination file for the left channel. If this pathname should contain invalid characters, they would be automatically changed into an underscore '_' character.
strOutputPathRight	String containing the absolute pathname of the destination file for the right channel. 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.