Waveform.PeaksSave method

Waveform.PeaksSave method

Remarks

Saves the analyzed sound's peaks into a file of type PKW: storing peaks inside a file, which will be accessible through a call to the Waveform.PeaksLoad method, 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.

For further details about using the embedded Waveform refer to the Waveform object 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]

control.Waveform.PeaksSave (

nPlayer as Integer,

strPathname as String

) as enumErrorCodes

[C++]

short control.Waveform.PeaksSave (

short nPlayer,

LPCTSTR strPathname

);

Parameter	Description

nPlayer	Number representing the zero-based index of the player that will use the Waveform
strPathname	Absolute pathname of the destination file, usually with .PKW extension. If this pathname should be left empty, the control would automatically save peaks into the same path of the loaded and 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 PKW file would be named MySong.pkw

Return value

Value	Meaning

Negative value	An error occurred, check the LastError property value in order to get the error code
enumErrorCodes.ERR_NOERROR (0)	The method call was successful