Methods > Editors > LoadSoundFromZip method

Remarks

Loads a specific entry (sound file) from the specified ZIP file for editing purposes. The sound file can be a stream or a MOD music file.

You can manage how loaded sound will be added to the existing editing session through a previous call to the SetLoadingMode method.

You can limit the range of sound data that will be loaded from the given sound file with a previous call to the SetLoadingRange method.

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

Formats wrapped inside a RIFF container (for example GSM 6.10, ADPCM, CCITT, etc. ) are supported if the specific ACM (Audio Compression Manager) codec is installed inside the system.

Multi-channel WAV, AIFF, OGG Vorbis, OPUS and WMA formats are supported natively when the MultiChannelLoadingModeSet method has been invoked with the nMode parameter set to MULTICHAN_DOWNMIX_NONE while in other cases will be converted to stereo during the loading procedure.

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

RAW formats are not supported directly but could be loaded in two steps by decompressing the entry into a memory buffer first, through the ZIP.EntryExtractToMemory method, and then by loading the memory buffer contents through the LoadSoundFromRawMemory method.

In case you should need loading a specific single channel of the zipped audio file, use the LoadSoundChannelFromZip method.

A successful call to this method will fire the SoundLoadingStarted event followed by a number of SoundLoadingPerc events and finally by the SoundLoadingDone event.

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

Syntax

[Visual Basic]

Public Function LoadSoundFromZip (

strZipPathname as String,

strPassword as String,

strEntryName as String,

bFailOnLowMemory as Boolean

) as enumErrorCodes

[C#]

public enumErrorCodes LoadSoundFromZip (

string strZipPathname,

string strPassword,

string strEntryName,

bool bFailOnLowMemory

);

[C++]

public: enumErrorCodes LoadSoundFromZip (

string strZipPathname,

string strPassword,

string strEntryName,

bool bFailOnLowMemory

);

Parameter

Description

strZipPathname

String containing the absolute pathname of the ZIP file to load.

strPassword

String containing the optional password for accessing the requested entry; leave it empty if not needed.

strEntryName

String representing the name of the entry to extract and load.

bFailOnLowMemory

Flag that determines if, for security purposes, loading of the given entry should fail in case there should be no enough memory for storing the unzipped entry.

Supported values are the following:

Value	Meaning
false	In case memory shouldn't be enough to contain the unzipped entry, the same would be stored inside a temporary file. The temporary file would be automatically deleted when closing the sound file through the CloseSound method or after loading a new sound file into the given player.
true	In case memory shouldn't be enough to contain the unzipped entry, the method's call would fail.

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.

(**) Only sound stream supported (no video): requires Microsoft Windows Media Format modules already installed on the target PC

(***) Only sound stream supported (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).