Remarks
Loads a specific audio channel of a specific entry (sound file) from the specified ZIP file for editing purposes.
Supported audio formats are the same available for the LoadSoundFromZip method.
During the execution of the loading session the CallbackPercentage delegate is invoked, with the nOperation parameter set to OPERATION_SOUND_LOADING, in order to notify about the percentage of advancement of the loading session.
For further details about using ZIP management refer to the How to manage ZIP files tutorial.
Syntax
[Visual Basic]
Public Function LoadSoundChannelFromZip (
strZipPathname as String,
strPassword as String,
strEntryName as String,
nChannel as Int16,
bFailOnLowMemory as Boolean
) as enumErrorCodes
|
|
[C#]
public enumErrorCodes LoadSoundChannelFromZip (
string strZipPathname,
string strPassword,
string strEntryName,
Int16 nChannel,
bool bFailOnLowMemory
);
|
|
[C++]
public: enumErrorCodes LoadSoundChannelFromZip (
string strZipPathname,
string strPassword,
string strEntryName,
Int16 nChannel,
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.
|
nChannel
|
Number representing the zero-based index of the audio channel to 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.
|
|
