COM Objects > WaveformAnalyzer object > Methods > WaveformAnalyzer.PeaksBufferLengthGet method

Remarks

Given a range in milliseconds, obtains the size in bytes required by the buffer in order to store related waveform peaks. Once the size is known, you may allocate a buffer to pass to the WaveformAnalyzer.PeaksBufferGet method.

Before calling this method it's mandatory performing a previous sound's analysis through a call to the WaveformAnalyzer.AnalyzeFullSound method and waiting its completion through the WaveAnalysisDone event.

For details about the use of the Waveform Analyzer refer to the How to use the Waveform Analyzer section.

For further details about methods of the Waveform Analyzer refer to the WaveformAnalyzer object section.

Syntax

[Visual Basic]

control.WaveformAnalyzer.PeaksBufferLengthGet (

nStartPos as Long,

nEndPos as Long,

nBufferLength as Long

) as enumErrorCodes

[C++]

short control.WaveformAnalyzer.PeaksBufferLengthGet (

long nStartPos,

long nEndPos,

long nBufferLength

);

Parameter	Description

nStartPos	Number representing the start position, expressed in milliseconds, where we want to get waveform's peaks. The value 0 represents the sound's beginning.
nEndPos	Number representing the end position, expressed in milliseconds, where we want to get waveform's peaks. The value -1 represents the sound's end.
nBufferLength	Reference that, on return from the method call, will contain the size in bytes needed for storing requested peaks into a buffer.

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