Methods > Recorders > StartSplitFromZipFile method

Remarks

Starts a new recording session from an input stereo sound file, stored inside the given ZIP file, and splits incoming sound in left and right channels.

Accepted stream formats are: MP1, MP2, MP3, MP4 (***), AIFF, AAC, M4A, AC3, FLAC, WavPack, ALAC, WAV, OGG Vorbis, OPUS, WMA (*), ASF (**), WMV (**), AIFF, AU, W64, PAF, SVX, NIST, VOC, IRCAM, PVF and CAF.

In this case the recording session wouldn't be kept inside the RecordedSound object so the only accepted recording mode, set through the SetRecordingMode method, is REC_MODE_NEW.

Source sound files cannot be in mono and multichannel WAV, AIFF, OGG Vorbis, OPUS and WMA formats are not supported and will be resampled and converted to stereo during the loading procedure.

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

During the recording sessions the container application is notified through the CallbackForRecordersEvents delegate which is invoked with the nEvent parameter set to EV_REC_START at the beginning and to EV_REC_STOP at the end. The current percentage of advancement is notified through the EV_REC_PERC event.

If the EncodeFormats.ForRecording 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.ForRecording 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.ForRecording 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.ForRecording 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.ForRecording 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.ForRecording property is set to ENCODING_FORMAT_AAC because this format doesn't support creating mono sounds.

For details about using ZIP management refer to the How to manage ZIP files tutorial.

Syntax

[Visual Basic]

Public Function StartSplitFromZipFile (

strOutputPathLeft as string,

strOutputPathRight as string,

strZipPathname as string,

strPassword as string,

strEntryName as string

) as enumErrorCodes

[C#]

public enumErrorCodes StartSplitFromZipFile (

string strOutputPathLeft,

string strOutputPathRight,

string strZipPathname,

string strPassword,

string strEntryName

);

[C++]

public: enumErrorCodes StartSplitFromZipFile (

string strOutputPathLeft,

string strOutputPathRight,

string strZipPathname,

string strPassword,

string strEntryName

);

Parameter	Description

strOutputPathLeft	String representing the absolute pathname of the destination file that will contain the left channel of recorded data. If this pathname should contain invalid characters, they would be automatically changed into an underscore '_' character.
strOutputPathRight	String representing the absolute pathname of the destination file that will contain the right channel of recorded data. If this pathname should contain invalid characters, they would be automatically changed into an underscore '_' character.
strZipPathname	String representing the absolute pathname of the ZIP file.
strEntryName	String representing the name of the entry to extract and load.
strPassword	String containing the optional password for accessing the requested entry; leave it empty if not needed.

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.

(**) Performs only sound tracks (no video): requires Microsoft Windows Media Format modules already installed on the target PC

(***) Performs only sound frames (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).