Methods > Recorders > StartFromZipFile method

Remarks

Starts a new recording session from an input sound file stored inside the given ZIP file.

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.

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.

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

Syntax

[Visual Basic]

Public Function StartFromZipFile (

strOutputPath as string,

strZipPathname as string,

strPassword as string,

strEntryName as string

) as enumErrorCodes

[C#]

public enumErrorCodes StartFromZipFile (

string strOutputPath,

string strZipPathname,

string strPassword,

string strEntryName

);

[C++]

public: enumErrorCodes StartFromZipFile (

string strOutputPath,

string strZipPathname,

string strPassword,

string strEntryName

);

Parameter	Description

strOutputPath	String representing the absolute pathname of the destination file that will contain 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).