Classes > Waveform class > Methods > Waveform.PeaksLoad method

Remarks

Loads the analyzed sound's peaks from a file of type PKW generated by a previous call to the Waveform.PeaksSave method: this avoids the need to perform a new time consuming full analysis of the sound's waveform for a sound file whose contents have not been changed.

In case the peaks file should be available inside a memory buffer, it could be loaded through the Waveform.PeaksLoadFromMemory method.

This method will cause the CallbackForPlayersEvents delegate to be invoked with the nEvent parameter set to EV_WAVE_ANALYSIS_START and EV_WAVE_ANALYSIS_DONE as seen when calling the Waveform.AnalyzeFullSound method.

For further details about using the embedded Waveform refer to the Waveform class section.

For further details about generating a waveform bitmap of the loaded sound, before starting its playback, refer to the How to obtain the sound's waveform tutorial.

Syntax

[Visual Basic]

Public Function PeaksLoad (

nPlayerIndex as Int16,

strPathname as String

) as enumErrorCodes

[C#]

public enumErrorCodes PeaksLoad (

Int16 nPlayerIndex,

string strPathname

);

[C++]

public: enumErrorCodes PeaksLoad (

Int16 nPlayerIndex,

string strPathname

);

Parameter	Description

nPlayerIndex	Number representing the zero-based index of the player that will use the Waveform
strPathname	Absolute pathname of the source file, usually with .PKW extension. If this pathname should be left empty, the control would automatically search the file inside the same path of the analyzed sound file changing the extension of the file name in .PKW. If for example the loaded sound file should be named MySong.mp3, the corresponding searched PKW file would be MySong.pkw

Return value

Value	Meaning

Negative value	An error occurred (see the LastError property for further error details)
enumErrorCodes.NOERROR (0)	The method call was successful.