WaveformAnalyzer.GetAnalysisInfo method |
|
Remarks
Obtains relevant information about the latest waveform analysis.
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 class section.
Syntax
[Visual Basic] Public Function GetAnalysisInfo ( ByRef nTotalPeaksDetected As Int32, ByRef fPeakDurationInMs as Single, ByRef nMaxPeakLeft As Int32, ByRef nMaxPeakRight As Int32 ) as enumErrorCodes |
[C#] public enumErrorCodes GetAnalysisInfo ( ref Int32 nTotalPeaksDetected, ref float fPeakDurationInMs, ref Int32 nMaxPeakLeft, ref Int32 nMaxPeakRight ); |
[C++] public: enumErrorCodes GetAnalysisInfo ( Int32 __gc *nTotalPeaksDetected, float __gc *fPeakDurationInMs, Int32 __gc *nMaxPeakLeft, Int32 __gc *nMaxPeakRight ); |
Parameter |
Description |
|
|
nTotalPeaksDetected |
Reference that, after returning from the method call, will contain the amount of peaks detected during the sound's analysis. |
fPeakDurationInMs |
Reference that, after returning from the method call, will contain the duration in milliseconds of each detected peak. |
nMaxPeakLeft |
Reference that, after returning from the method call, will contain the level of the highest peak detected on the left channel; the peak value can be in the range from 0 to 32767. |
nMaxPeakRight |
Reference that, after returning from the method call, will contain the level of the highest peak detected on the right channel; the peak value can be in the range from 0 to 32767. |
Return value
Value |
Meaning |
|
|
Negative value |
An error occurred (see the LastError property for further error details) |
enumErrorCodes.ERR_NOERROR (0) |
The method call was successful |