|
PeakDetectionOnFile method |
  
|
|
PeakDetectionOnFile method |
|
Remarks
Gets the highest peak of the sound contained inside the given file
The returned value can be used with the Effects.NormalizationPeakSet method to speed up a later loading of a sound file when normalization has been enabled through the Effects.NormalizationEnable method. The value of the highest peak is immediately available when this method returns to the caller.
See the How to apply special effects to a playing sound section for further details.
Syntax
[Visual Basic] Public Function PeakDetectionOnFile ( strFileName as String, ByRef fPeak as Single ) as enumErrorCodes |
[C#] public enumErrorCodes PeakDetectionOnFile ( string strFileName, ref float fPeak ); |
[C++] public: enumErrorCodes PeakDetectionOnFile ( string strFileName, float __gc *fPeak ); |
Parameter |
Description |
|
|
strPathame |
String containing the absolute pathname of the sound file to analyze. |
fPeak |
Reference that, on return from the method call, will contain a floating point value representing the highest peak value. The value can be in the range from 0.0 to 1.0 |
Return value
Value |
Meaning |
|
|
enumErrorCodes.NOERROR (0) |
The song file has been loaded successfully. |
Negative value |
An error occurred: see the LastError property for further error details or for a list of the possible error values. |
